{ "name": "azure-native", "displayName": "Azure Native", "description": "A native Pulumi package for creating and managing Azure resources.", "keywords": [ "pulumi", "azure", "azure-native", "category/cloud", "kind/native" ], "homepage": "https://pulumi.com", "license": "Apache-2.0", "repository": "https://github.com/pulumi/pulumi-azure-native", "publisher": "Pulumi", "language": { "csharp": { "namespaces": { "aad": "Aad", "aadiam": "AadIam", "addons": "Addons", "adhybridhealthservice": "ADHybridHealthService", "advisor": "Advisor", "agfoodplatform": "AgFoodPlatform", "agricultureplatform": "AgriculturePlatform", "alertsmanagement": "AlertsManagement", "analysisservices": "AnalysisServices", "apicenter": "ApiCenter", "apimanagement": "ApiManagement", "app": "App", "appcomplianceautomation": "AppComplianceAutomation", "appconfiguration": "AppConfiguration", "applicationinsights": "ApplicationInsights", "applink": "AppLink", "appplatform": "AppPlatform", "attestation": "Attestation", "authorization": "Authorization", "automanage": "Automanage", "automation": "Automation", "avs": "AVS", "awsconnector": "AwsConnector", "azure-native": "AzureNative", "azureactivedirectory": "AzureActiveDirectory", "azurearcdata": "AzureArcData", "azuredata": "AzureData", "azuredatatransfer": "AzureDataTransfer", "azurefleet": "AzureFleet", "azurelargeinstance": "AzureLargeInstance", "azureplaywrightservice": "AzurePlaywrightService", "azureresiliencemanagement": "AzureResilienceManagement", "azuresphere": "AzureSphere", "azurestack": "AzureStack", "azurestackhci": "AzureStackHCI", "azureterraform": "AzureTerraform", "baremetalinfrastructure": "BareMetalInfrastructure", "batch": "Batch", "billing": "Billing", "billingbenefits": "BillingBenefits", "billingtrust": "BillingTrust", "blueprint": "Blueprint", "botservice": "BotService", "capacity": "Capacity", "carbon": "Carbon", "cdn": "Cdn", "certificateregistration": "CertificateRegistration", "chaos": "Chaos", "cloudhealth": "CloudHealth", "cloudngfw": "Cloudngfw", "codesigning": "CodeSigning", "cognitiveservices": "CognitiveServices", "commerce": "Commerce", "communication": "Communication", "community": "Community", "compute": "Compute", "computebulkactions": "ComputeBulkActions", "computelimit": "ComputeLimit", "computeschedule": "ComputeSchedule", "confidentialledger": "ConfidentialLedger", "confluent": "Confluent", "connectedcache": "ConnectedCache", "connectedvmwarevsphere": "ConnectedVMwarevSphere", "consumption": "Consumption", "containerinstance": "ContainerInstance", "containerregistry": "ContainerRegistry", "containerservice": "ContainerService", "containerstorage": "ContainerStorage", "contoso": "Contoso", "cosmosdb": "CosmosDB", "costmanagement": "CostManagement", "customerinsights": "CustomerInsights", "customerlockbox": "CustomerLockbox", "customproviders": "CustomProviders", "dashboard": "Dashboard", "databasefleetmanager": "DatabaseFleetManager", "databasewatcher": "DatabaseWatcher", "databox": "DataBox", "databoxedge": "DataBoxEdge", "databricks": "Databricks", "datacatalog": "DataCatalog", "datadog": "Datadog", "datafactory": "DataFactory", "datalakeanalytics": "DataLakeAnalytics", "datalakestore": "DataLakeStore", "datamigration": "DataMigration", "dataprotection": "DataProtection", "datareplication": "DataReplication", "datashare": "DataShare", "dbformariadb": "DBforMariaDB", "dbformysql": "DBforMySQL", "dbforpostgresql": "DBforPostgreSQL", "delegatednetwork": "DelegatedNetwork", "dependencymap": "DependencyMap", "desktopvirtualization": "DesktopVirtualization", "devcenter": "DevCenter", "devhub": "DevHub", "deviceprovisioningservices": "DeviceProvisioningServices", "deviceregistry": "DeviceRegistry", "deviceupdate": "DeviceUpdate", "devops": "DevOps", "devopsinfrastructure": "DevOpsInfrastructure", "devspaces": "DevSpaces", "devtestlab": "DevTestLab", "digitaltwins": "DigitalTwins", "discovery": "Discovery", "dns": "Dns", "dnsresolver": "DnsResolver", "domainregistration": "DomainRegistration", "durabletask": "DurableTask", "dynamics365fraudprotection": "Dynamics365Fraudprotection", "dynamicstelemetry": "DynamicsTelemetry", "easm": "Easm", "edge": "Edge", "edgemarketplace": "EdgeMarketplace", "edgeorder": "EdgeOrder", "edgeorderpartner": "EdgeOrderPartner", "edgezones": "EdgeZones", "education": "Education", "elastic": "Elastic", "elasticsan": "ElasticSan", "engagementfabric": "EngagementFabric", "enterpriseknowledgegraph": "EnterpriseKnowledgeGraph", "eventgrid": "EventGrid", "eventhub": "EventHub", "extendedlocation": "ExtendedLocation", "fabric": "Fabric", "features": "Features", "fileshares": "FileShares", "fluidrelay": "FluidRelay", "frontdoor": "FrontDoor", "graphservices": "GraphServices", "guestconfiguration": "GuestConfiguration", "hanaonazure": "HanaOnAzure", "hardwaresecuritymodules": "HardwareSecurityModules", "hdinsight": "HDInsight", "healthbot": "HealthBot", "healthcareapis": "HealthcareApis", "healthdataaiservices": "HealthDataAIServices", "help": "Help", "horizondb": "HorizonDb", "hybridcloud": "HybridCloud", "hybridcompute": "HybridCompute", "hybridconnectivity": "HybridConnectivity", "hybridcontainerservice": "HybridContainerService", "hybridnetwork": "HybridNetwork", "impact": "Impact", "importexport": "ImportExport", "integrationspaces": "IntegrationSpaces", "intune": "Intune", "iotcentral": "IoTCentral", "iotfirmwaredefense": "IoTFirmwareDefense", "iothub": "IoTHub", "iotoperations": "IoTOperations", "iotoperationsdataprocessor": "IoTOperationsDataProcessor", "iotoperationsmq": "IoTOperationsMQ", "iotoperationsorchestrator": "IoTOperationsOrchestrator", "keyvault": "KeyVault", "kubernetes": "Kubernetes", "kubernetesconfiguration": "KubernetesConfiguration", "kubernetesruntime": "KubernetesRuntime", "kusto": "Kusto", "labservices": "LabServices", "loadtestservice": "LoadTestService", "logic": "Logic", "m365securityandcompliance": "M365SecurityAndCompliance", "machinelearning": "MachineLearning", "machinelearningservices": "MachineLearningServices", "maintenance": "Maintenance", "managedidentity": "ManagedIdentity", "managednetwork": "ManagedNetwork", "managednetworkfabric": "ManagedNetworkFabric", "managedops": "ManagedOps", "managedservices": "ManagedServices", "management": "Management", "managementpartner": "ManagementPartner", "manufacturingplatform": "ManufacturingPlatform", "maps": "Maps", "marketplace": "Marketplace", "marketplacenotifications": "MarketplaceNotifications", "marketplaceordering": "MarketplaceOrdering", "migrate": "Migrate", "mission": "Mission", "mongocluster": "MongoCluster", "monitor": "Monitor", "mysqldiscovery": "MySQLDiscovery", "netapp": "NetApp", "network": "Network", "networkcloud": "NetworkCloud", "networkfunction": "NetworkFunction", "notificationhubs": "NotificationHubs", "offazure": "OffAzure", "offazurespringboot": "OffAzureSpringBoot", "onlineexperimentation": "OnlineExperimentation", "openenergyplatform": "OpenEnergyPlatform", "operationalinsights": "OperationalInsights", "operationsmanagement": "OperationsManagement", "orbital": "Orbital", "peering": "Peering", "policyinsights": "PolicyInsights", "portal": "Portal", "portalservices": "PortalServices", "powerbi": "PowerBI", "powerbidedicated": "PowerBIDedicated", "powerplatform": "PowerPlatform", "privatedns": "PrivateDns", "professionalservice": "ProfessionalService", "programenrollment": "ProgramEnrollment", "programmableconnectivity": "ProgrammableConnectivity", "providerhub": "ProviderHub", "purview": "Purview", "quantum": "Quantum", "quota": "Quota", "recommendationsservice": "RecommendationsService", "recoveryservices": "RecoveryServices", "redhatopenshift": "RedHatOpenShift", "redis": "Redis", "redisenterprise": "RedisEnterprise", "relationships": "Relationships", "relay": "Relay", "resourceconnector": "ResourceConnector", "resourcegraph": "ResourceGraph", "resourcehealth": "ResourceHealth", "resources": "Resources", "saas": "SaaS", "scheduler": "Scheduler", "scom": "Scom", "scvmm": "ScVmm", "search": "Search", "secretsynccontroller": "SecretSyncController", "security": "Security", "securityandcompliance": "SecurityAndCompliance", "securityinsights": "SecurityInsights", "serialconsole": "SerialConsole", "servicebus": "ServiceBus", "servicefabric": "ServiceFabric", "servicefabricmesh": "ServiceFabricMesh", "servicelinker": "ServiceLinker", "servicenetworking": "ServiceNetworking", "signalrservice": "SignalRService", "softwareplan": "SoftwarePlan", "solutions": "Solutions", "sovereign": "Sovereign", "sql": "Sql", "sqlvirtualmachine": "SqlVirtualMachine", "standbypool": "StandbyPool", "storage": "Storage", "storageactions": "StorageActions", "storagecache": "StorageCache", "storagediscovery": "StorageDiscovery", "storagemover": "StorageMover", "storagepool": "StoragePool", "storagesync": "StorageSync", "streamanalytics": "StreamAnalytics", "subscription": "Subscription", "support": "Support", "synapse": "Synapse", "syntex": "Syntex", "testbase": "TestBase", "timeseriesinsights": "TimeSeriesInsights", "trafficmanager": "TrafficManager", "verifiedid": "VerifiedId", "videoindexer": "VideoIndexer", "virtualmachineimages": "VirtualMachineImages", "vmwarecloudsimple": "VMwareCloudSimple", "web": "Web", "webpubsub": "WebPubSub", "weightsandbiases": "WeightsAndBiases", "widget": "Widget", "windowsesu": "WindowsESU", "windowsiot": "WindowsIoT", "workloadmonitor": "WorkloadMonitor", "workloads": "Workloads" }, "packageReferences": { "Pulumi": "3.*", "System.Collections.Immutable": "5.0.0" }, "respectSchemaVersion": true }, "go": { "disableInputTypeRegistrations": true, "generateResourceContainerTypes": false, "importBasePath": "github.com/pulumi/pulumi-azure-native-sdk/v3", "importPathPattern": "github.com/pulumi/pulumi-azure-native-sdk/{module}/v3", "internalModuleName": "utilities", "packageImportAliases": { "github.com/pulumi/pulumi-azure-native-sdk/aad/v3": "aad", "github.com/pulumi/pulumi-azure-native-sdk/aadiam/v3": "aadiam", "github.com/pulumi/pulumi-azure-native-sdk/addons/v3": "addons", "github.com/pulumi/pulumi-azure-native-sdk/adhybridhealthservice/v3": "adhybridhealthservice", "github.com/pulumi/pulumi-azure-native-sdk/advisor/v3": "advisor", "github.com/pulumi/pulumi-azure-native-sdk/agfoodplatform/v3": "agfoodplatform", "github.com/pulumi/pulumi-azure-native-sdk/agricultureplatform/v3": "agricultureplatform", "github.com/pulumi/pulumi-azure-native-sdk/alertsmanagement/v3": "alertsmanagement", "github.com/pulumi/pulumi-azure-native-sdk/analysisservices/v3": "analysisservices", "github.com/pulumi/pulumi-azure-native-sdk/apicenter/v3": "apicenter", "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v3": "apimanagement", "github.com/pulumi/pulumi-azure-native-sdk/app/v3": "app", "github.com/pulumi/pulumi-azure-native-sdk/appcomplianceautomation/v3": "appcomplianceautomation", "github.com/pulumi/pulumi-azure-native-sdk/appconfiguration/v3": "appconfiguration", "github.com/pulumi/pulumi-azure-native-sdk/applicationinsights/v3": "applicationinsights", "github.com/pulumi/pulumi-azure-native-sdk/applink/v3": "applink", "github.com/pulumi/pulumi-azure-native-sdk/appplatform/v3": "appplatform", "github.com/pulumi/pulumi-azure-native-sdk/attestation/v3": "attestation", "github.com/pulumi/pulumi-azure-native-sdk/authorization/v3": "authorization", "github.com/pulumi/pulumi-azure-native-sdk/automanage/v3": "automanage", "github.com/pulumi/pulumi-azure-native-sdk/automation/v3": "automation", "github.com/pulumi/pulumi-azure-native-sdk/avs/v3": "avs", "github.com/pulumi/pulumi-azure-native-sdk/awsconnector/v3": "awsconnector", "github.com/pulumi/pulumi-azure-native-sdk/azureactivedirectory/v3": "azureactivedirectory", "github.com/pulumi/pulumi-azure-native-sdk/azurearcdata/v3": "azurearcdata", "github.com/pulumi/pulumi-azure-native-sdk/azuredata/v3": "azuredata", "github.com/pulumi/pulumi-azure-native-sdk/azuredatatransfer/v3": "azuredatatransfer", "github.com/pulumi/pulumi-azure-native-sdk/azurefleet/v3": "azurefleet", "github.com/pulumi/pulumi-azure-native-sdk/azurelargeinstance/v3": "azurelargeinstance", "github.com/pulumi/pulumi-azure-native-sdk/azureplaywrightservice/v3": "azureplaywrightservice", "github.com/pulumi/pulumi-azure-native-sdk/azureresiliencemanagement/v3": "azureresiliencemanagement", "github.com/pulumi/pulumi-azure-native-sdk/azuresphere/v3": "azuresphere", "github.com/pulumi/pulumi-azure-native-sdk/azurestack/v3": "azurestack", "github.com/pulumi/pulumi-azure-native-sdk/azurestackhci/v3": "azurestackhci", "github.com/pulumi/pulumi-azure-native-sdk/azureterraform/v3": "azureterraform", "github.com/pulumi/pulumi-azure-native-sdk/baremetalinfrastructure/v3": "baremetalinfrastructure", "github.com/pulumi/pulumi-azure-native-sdk/batch/v3": "batch", "github.com/pulumi/pulumi-azure-native-sdk/billing/v3": "billing", "github.com/pulumi/pulumi-azure-native-sdk/billingbenefits/v3": "billingbenefits", "github.com/pulumi/pulumi-azure-native-sdk/billingtrust/v3": "billingtrust", "github.com/pulumi/pulumi-azure-native-sdk/blueprint/v3": "blueprint", "github.com/pulumi/pulumi-azure-native-sdk/botservice/v3": "botservice", "github.com/pulumi/pulumi-azure-native-sdk/capacity/v3": "capacity", "github.com/pulumi/pulumi-azure-native-sdk/carbon/v3": "carbon", "github.com/pulumi/pulumi-azure-native-sdk/cdn/v3": "cdn", "github.com/pulumi/pulumi-azure-native-sdk/certificateregistration/v3": "certificateregistration", "github.com/pulumi/pulumi-azure-native-sdk/chaos/v3": "chaos", "github.com/pulumi/pulumi-azure-native-sdk/cloudhealth/v3": "cloudhealth", "github.com/pulumi/pulumi-azure-native-sdk/cloudngfw/v3": "cloudngfw", "github.com/pulumi/pulumi-azure-native-sdk/codesigning/v3": "codesigning", "github.com/pulumi/pulumi-azure-native-sdk/cognitiveservices/v3": "cognitiveservices", "github.com/pulumi/pulumi-azure-native-sdk/commerce/v3": "commerce", "github.com/pulumi/pulumi-azure-native-sdk/communication/v3": "communication", "github.com/pulumi/pulumi-azure-native-sdk/community/v3": "community", "github.com/pulumi/pulumi-azure-native-sdk/compute/v3": "compute", "github.com/pulumi/pulumi-azure-native-sdk/computebulkactions/v3": "computebulkactions", "github.com/pulumi/pulumi-azure-native-sdk/computelimit/v3": "computelimit", "github.com/pulumi/pulumi-azure-native-sdk/computeschedule/v3": "computeschedule", "github.com/pulumi/pulumi-azure-native-sdk/confidentialledger/v3": "confidentialledger", "github.com/pulumi/pulumi-azure-native-sdk/confluent/v3": "confluent", "github.com/pulumi/pulumi-azure-native-sdk/connectedcache/v3": "connectedcache", "github.com/pulumi/pulumi-azure-native-sdk/connectedvmwarevsphere/v3": "connectedvmwarevsphere", "github.com/pulumi/pulumi-azure-native-sdk/consumption/v3": "consumption", "github.com/pulumi/pulumi-azure-native-sdk/containerinstance/v3": "containerinstance", "github.com/pulumi/pulumi-azure-native-sdk/containerregistry/v3": "containerregistry", "github.com/pulumi/pulumi-azure-native-sdk/containerservice/v3": "containerservice", "github.com/pulumi/pulumi-azure-native-sdk/containerstorage/v3": "containerstorage", "github.com/pulumi/pulumi-azure-native-sdk/contoso/v3": "contoso", "github.com/pulumi/pulumi-azure-native-sdk/cosmosdb/v3": "cosmosdb", "github.com/pulumi/pulumi-azure-native-sdk/costmanagement/v3": "costmanagement", "github.com/pulumi/pulumi-azure-native-sdk/customerinsights/v3": "customerinsights", "github.com/pulumi/pulumi-azure-native-sdk/customerlockbox/v3": "customerlockbox", "github.com/pulumi/pulumi-azure-native-sdk/customproviders/v3": "customproviders", "github.com/pulumi/pulumi-azure-native-sdk/dashboard/v3": "dashboard", "github.com/pulumi/pulumi-azure-native-sdk/databasefleetmanager/v3": "databasefleetmanager", "github.com/pulumi/pulumi-azure-native-sdk/databasewatcher/v3": "databasewatcher", "github.com/pulumi/pulumi-azure-native-sdk/databox/v3": "databox", "github.com/pulumi/pulumi-azure-native-sdk/databoxedge/v3": "databoxedge", "github.com/pulumi/pulumi-azure-native-sdk/databricks/v3": "databricks", "github.com/pulumi/pulumi-azure-native-sdk/datacatalog/v3": "datacatalog", "github.com/pulumi/pulumi-azure-native-sdk/datadog/v3": "datadog", "github.com/pulumi/pulumi-azure-native-sdk/datafactory/v3": "datafactory", "github.com/pulumi/pulumi-azure-native-sdk/datalakeanalytics/v3": "datalakeanalytics", "github.com/pulumi/pulumi-azure-native-sdk/datalakestore/v3": "datalakestore", "github.com/pulumi/pulumi-azure-native-sdk/datamigration/v3": "datamigration", "github.com/pulumi/pulumi-azure-native-sdk/dataprotection/v3": "dataprotection", "github.com/pulumi/pulumi-azure-native-sdk/datareplication/v3": "datareplication", "github.com/pulumi/pulumi-azure-native-sdk/datashare/v3": "datashare", "github.com/pulumi/pulumi-azure-native-sdk/dbformariadb/v3": "dbformariadb", "github.com/pulumi/pulumi-azure-native-sdk/dbformysql/v3": "dbformysql", "github.com/pulumi/pulumi-azure-native-sdk/dbforpostgresql/v3": "dbforpostgresql", "github.com/pulumi/pulumi-azure-native-sdk/delegatednetwork/v3": "delegatednetwork", "github.com/pulumi/pulumi-azure-native-sdk/dependencymap/v3": "dependencymap", "github.com/pulumi/pulumi-azure-native-sdk/desktopvirtualization/v3": "desktopvirtualization", "github.com/pulumi/pulumi-azure-native-sdk/devcenter/v3": "devcenter", "github.com/pulumi/pulumi-azure-native-sdk/devhub/v3": "devhub", "github.com/pulumi/pulumi-azure-native-sdk/deviceprovisioningservices/v3": "deviceprovisioningservices", "github.com/pulumi/pulumi-azure-native-sdk/deviceregistry/v3": "deviceregistry", "github.com/pulumi/pulumi-azure-native-sdk/deviceupdate/v3": "deviceupdate", "github.com/pulumi/pulumi-azure-native-sdk/devops/v3": "devops", "github.com/pulumi/pulumi-azure-native-sdk/devopsinfrastructure/v3": "devopsinfrastructure", "github.com/pulumi/pulumi-azure-native-sdk/devspaces/v3": "devspaces", "github.com/pulumi/pulumi-azure-native-sdk/devtestlab/v3": "devtestlab", "github.com/pulumi/pulumi-azure-native-sdk/digitaltwins/v3": "digitaltwins", "github.com/pulumi/pulumi-azure-native-sdk/discovery/v3": "discovery", "github.com/pulumi/pulumi-azure-native-sdk/dns/v3": "dns", "github.com/pulumi/pulumi-azure-native-sdk/dnsresolver/v3": "dnsresolver", "github.com/pulumi/pulumi-azure-native-sdk/domainregistration/v3": "domainregistration", "github.com/pulumi/pulumi-azure-native-sdk/durabletask/v3": "durabletask", "github.com/pulumi/pulumi-azure-native-sdk/dynamics365fraudprotection/v3": "dynamics365fraudprotection", "github.com/pulumi/pulumi-azure-native-sdk/dynamicstelemetry/v3": "dynamicstelemetry", "github.com/pulumi/pulumi-azure-native-sdk/easm/v3": "easm", "github.com/pulumi/pulumi-azure-native-sdk/edge/v3": "edge", "github.com/pulumi/pulumi-azure-native-sdk/edgemarketplace/v3": "edgemarketplace", "github.com/pulumi/pulumi-azure-native-sdk/edgeorder/v3": "edgeorder", "github.com/pulumi/pulumi-azure-native-sdk/edgeorderpartner/v3": "edgeorderpartner", "github.com/pulumi/pulumi-azure-native-sdk/edgezones/v3": "edgezones", "github.com/pulumi/pulumi-azure-native-sdk/education/v3": "education", "github.com/pulumi/pulumi-azure-native-sdk/elastic/v3": "elastic", "github.com/pulumi/pulumi-azure-native-sdk/elasticsan/v3": "elasticsan", "github.com/pulumi/pulumi-azure-native-sdk/engagementfabric/v3": "engagementfabric", "github.com/pulumi/pulumi-azure-native-sdk/enterpriseknowledgegraph/v3": "enterpriseknowledgegraph", "github.com/pulumi/pulumi-azure-native-sdk/eventgrid/v3": "eventgrid", "github.com/pulumi/pulumi-azure-native-sdk/eventhub/v3": "eventhub", "github.com/pulumi/pulumi-azure-native-sdk/extendedlocation/v3": "extendedlocation", "github.com/pulumi/pulumi-azure-native-sdk/fabric/v3": "fabric", "github.com/pulumi/pulumi-azure-native-sdk/features/v3": "features", "github.com/pulumi/pulumi-azure-native-sdk/fileshares/v3": "fileshares", "github.com/pulumi/pulumi-azure-native-sdk/fluidrelay/v3": "fluidrelay", "github.com/pulumi/pulumi-azure-native-sdk/frontdoor/v3": "frontdoor", "github.com/pulumi/pulumi-azure-native-sdk/graphservices/v3": "graphservices", "github.com/pulumi/pulumi-azure-native-sdk/guestconfiguration/v3": "guestconfiguration", "github.com/pulumi/pulumi-azure-native-sdk/hanaonazure/v3": "hanaonazure", "github.com/pulumi/pulumi-azure-native-sdk/hardwaresecuritymodules/v3": "hardwaresecuritymodules", "github.com/pulumi/pulumi-azure-native-sdk/hdinsight/v3": "hdinsight", "github.com/pulumi/pulumi-azure-native-sdk/healthbot/v3": "healthbot", "github.com/pulumi/pulumi-azure-native-sdk/healthcareapis/v3": "healthcareapis", "github.com/pulumi/pulumi-azure-native-sdk/healthdataaiservices/v3": "healthdataaiservices", "github.com/pulumi/pulumi-azure-native-sdk/help/v3": "help", "github.com/pulumi/pulumi-azure-native-sdk/horizondb/v3": "horizondb", "github.com/pulumi/pulumi-azure-native-sdk/hybridcloud/v3": "hybridcloud", "github.com/pulumi/pulumi-azure-native-sdk/hybridcompute/v3": "hybridcompute", "github.com/pulumi/pulumi-azure-native-sdk/hybridconnectivity/v3": "hybridconnectivity", "github.com/pulumi/pulumi-azure-native-sdk/hybridcontainerservice/v3": "hybridcontainerservice", "github.com/pulumi/pulumi-azure-native-sdk/hybridnetwork/v3": "hybridnetwork", "github.com/pulumi/pulumi-azure-native-sdk/impact/v3": "impact", "github.com/pulumi/pulumi-azure-native-sdk/importexport/v3": "importexport", "github.com/pulumi/pulumi-azure-native-sdk/integrationspaces/v3": "integrationspaces", "github.com/pulumi/pulumi-azure-native-sdk/intune/v3": "intune", "github.com/pulumi/pulumi-azure-native-sdk/iotcentral/v3": "iotcentral", "github.com/pulumi/pulumi-azure-native-sdk/iotfirmwaredefense/v3": "iotfirmwaredefense", "github.com/pulumi/pulumi-azure-native-sdk/iothub/v3": "iothub", "github.com/pulumi/pulumi-azure-native-sdk/iotoperations/v3": "iotoperations", "github.com/pulumi/pulumi-azure-native-sdk/iotoperationsdataprocessor/v3": "iotoperationsdataprocessor", "github.com/pulumi/pulumi-azure-native-sdk/iotoperationsmq/v3": "iotoperationsmq", "github.com/pulumi/pulumi-azure-native-sdk/iotoperationsorchestrator/v3": "iotoperationsorchestrator", "github.com/pulumi/pulumi-azure-native-sdk/keyvault/v3": "keyvault", "github.com/pulumi/pulumi-azure-native-sdk/kubernetes/v3": "kubernetes", "github.com/pulumi/pulumi-azure-native-sdk/kubernetesconfiguration/v3": "kubernetesconfiguration", "github.com/pulumi/pulumi-azure-native-sdk/kubernetesruntime/v3": "kubernetesruntime", "github.com/pulumi/pulumi-azure-native-sdk/kusto/v3": "kusto", "github.com/pulumi/pulumi-azure-native-sdk/labservices/v3": "labservices", "github.com/pulumi/pulumi-azure-native-sdk/loadtestservice/v3": "loadtestservice", "github.com/pulumi/pulumi-azure-native-sdk/logic/v3": "logic", "github.com/pulumi/pulumi-azure-native-sdk/m365securityandcompliance/v3": "m365securityandcompliance", "github.com/pulumi/pulumi-azure-native-sdk/machinelearning/v3": "machinelearning", "github.com/pulumi/pulumi-azure-native-sdk/machinelearningservices/v3": "machinelearningservices", "github.com/pulumi/pulumi-azure-native-sdk/maintenance/v3": "maintenance", "github.com/pulumi/pulumi-azure-native-sdk/managedidentity/v3": "managedidentity", "github.com/pulumi/pulumi-azure-native-sdk/managednetwork/v3": "managednetwork", "github.com/pulumi/pulumi-azure-native-sdk/managednetworkfabric/v3": "managednetworkfabric", "github.com/pulumi/pulumi-azure-native-sdk/managedops/v3": "managedops", "github.com/pulumi/pulumi-azure-native-sdk/managedservices/v3": "managedservices", "github.com/pulumi/pulumi-azure-native-sdk/management/v3": "management", "github.com/pulumi/pulumi-azure-native-sdk/managementpartner/v3": "managementpartner", "github.com/pulumi/pulumi-azure-native-sdk/manufacturingplatform/v3": "manufacturingplatform", "github.com/pulumi/pulumi-azure-native-sdk/maps/v3": "maps", "github.com/pulumi/pulumi-azure-native-sdk/marketplace/v3": "marketplace", "github.com/pulumi/pulumi-azure-native-sdk/marketplacenotifications/v3": "marketplacenotifications", "github.com/pulumi/pulumi-azure-native-sdk/marketplaceordering/v3": "marketplaceordering", "github.com/pulumi/pulumi-azure-native-sdk/migrate/v3": "migrate", "github.com/pulumi/pulumi-azure-native-sdk/mission/v3": "mission", "github.com/pulumi/pulumi-azure-native-sdk/mongocluster/v3": "mongocluster", "github.com/pulumi/pulumi-azure-native-sdk/monitor/v3": "monitor", "github.com/pulumi/pulumi-azure-native-sdk/mysqldiscovery/v3": "mysqldiscovery", "github.com/pulumi/pulumi-azure-native-sdk/netapp/v3": "netapp", "github.com/pulumi/pulumi-azure-native-sdk/network/v3": "network", "github.com/pulumi/pulumi-azure-native-sdk/networkcloud/v3": "networkcloud", "github.com/pulumi/pulumi-azure-native-sdk/networkfunction/v3": "networkfunction", "github.com/pulumi/pulumi-azure-native-sdk/notificationhubs/v3": "notificationhubs", "github.com/pulumi/pulumi-azure-native-sdk/offazure/v3": "offazure", "github.com/pulumi/pulumi-azure-native-sdk/offazurespringboot/v3": "offazurespringboot", "github.com/pulumi/pulumi-azure-native-sdk/onlineexperimentation/v3": "onlineexperimentation", "github.com/pulumi/pulumi-azure-native-sdk/openenergyplatform/v3": "openenergyplatform", "github.com/pulumi/pulumi-azure-native-sdk/operationalinsights/v3": "operationalinsights", "github.com/pulumi/pulumi-azure-native-sdk/operationsmanagement/v3": "operationsmanagement", "github.com/pulumi/pulumi-azure-native-sdk/orbital/v3": "orbital", "github.com/pulumi/pulumi-azure-native-sdk/peering/v3": "peering", "github.com/pulumi/pulumi-azure-native-sdk/policyinsights/v3": "policyinsights", "github.com/pulumi/pulumi-azure-native-sdk/portal/v3": "portal", "github.com/pulumi/pulumi-azure-native-sdk/portalservices/v3": "portalservices", "github.com/pulumi/pulumi-azure-native-sdk/powerbi/v3": "powerbi", "github.com/pulumi/pulumi-azure-native-sdk/powerbidedicated/v3": "powerbidedicated", "github.com/pulumi/pulumi-azure-native-sdk/powerplatform/v3": "powerplatform", "github.com/pulumi/pulumi-azure-native-sdk/privatedns/v3": "privatedns", "github.com/pulumi/pulumi-azure-native-sdk/professionalservice/v3": "professionalservice", "github.com/pulumi/pulumi-azure-native-sdk/programenrollment/v3": "programenrollment", "github.com/pulumi/pulumi-azure-native-sdk/programmableconnectivity/v3": "programmableconnectivity", "github.com/pulumi/pulumi-azure-native-sdk/providerhub/v3": "providerhub", "github.com/pulumi/pulumi-azure-native-sdk/purview/v3": "purview", "github.com/pulumi/pulumi-azure-native-sdk/quantum/v3": "quantum", "github.com/pulumi/pulumi-azure-native-sdk/quota/v3": "quota", "github.com/pulumi/pulumi-azure-native-sdk/recommendationsservice/v3": "recommendationsservice", "github.com/pulumi/pulumi-azure-native-sdk/recoveryservices/v3": "recoveryservices", "github.com/pulumi/pulumi-azure-native-sdk/redhatopenshift/v3": "redhatopenshift", "github.com/pulumi/pulumi-azure-native-sdk/redis/v3": "redis", "github.com/pulumi/pulumi-azure-native-sdk/redisenterprise/v3": "redisenterprise", "github.com/pulumi/pulumi-azure-native-sdk/relationships/v3": "relationships", "github.com/pulumi/pulumi-azure-native-sdk/relay/v3": "relay", "github.com/pulumi/pulumi-azure-native-sdk/resourceconnector/v3": "resourceconnector", "github.com/pulumi/pulumi-azure-native-sdk/resourcegraph/v3": "resourcegraph", "github.com/pulumi/pulumi-azure-native-sdk/resourcehealth/v3": "resourcehealth", "github.com/pulumi/pulumi-azure-native-sdk/resources/v3": "resources", "github.com/pulumi/pulumi-azure-native-sdk/saas/v3": "saas", "github.com/pulumi/pulumi-azure-native-sdk/scheduler/v3": "scheduler", "github.com/pulumi/pulumi-azure-native-sdk/scom/v3": "scom", "github.com/pulumi/pulumi-azure-native-sdk/scvmm/v3": "scvmm", "github.com/pulumi/pulumi-azure-native-sdk/search/v3": "search", "github.com/pulumi/pulumi-azure-native-sdk/secretsynccontroller/v3": "secretsynccontroller", "github.com/pulumi/pulumi-azure-native-sdk/security/v3": "security", "github.com/pulumi/pulumi-azure-native-sdk/securityandcompliance/v3": "securityandcompliance", "github.com/pulumi/pulumi-azure-native-sdk/securityinsights/v3": "securityinsights", "github.com/pulumi/pulumi-azure-native-sdk/serialconsole/v3": "serialconsole", "github.com/pulumi/pulumi-azure-native-sdk/servicebus/v3": "servicebus", "github.com/pulumi/pulumi-azure-native-sdk/servicefabric/v3": "servicefabric", "github.com/pulumi/pulumi-azure-native-sdk/servicefabricmesh/v3": "servicefabricmesh", "github.com/pulumi/pulumi-azure-native-sdk/servicelinker/v3": "servicelinker", "github.com/pulumi/pulumi-azure-native-sdk/servicenetworking/v3": "servicenetworking", "github.com/pulumi/pulumi-azure-native-sdk/signalrservice/v3": "signalrservice", "github.com/pulumi/pulumi-azure-native-sdk/softwareplan/v3": "softwareplan", "github.com/pulumi/pulumi-azure-native-sdk/solutions/v3": "solutions", "github.com/pulumi/pulumi-azure-native-sdk/sovereign/v3": "sovereign", "github.com/pulumi/pulumi-azure-native-sdk/sql/v3": "sql", "github.com/pulumi/pulumi-azure-native-sdk/sqlvirtualmachine/v3": "sqlvirtualmachine", "github.com/pulumi/pulumi-azure-native-sdk/standbypool/v3": "standbypool", "github.com/pulumi/pulumi-azure-native-sdk/storage/v3": "storage", "github.com/pulumi/pulumi-azure-native-sdk/storageactions/v3": "storageactions", "github.com/pulumi/pulumi-azure-native-sdk/storagecache/v3": "storagecache", "github.com/pulumi/pulumi-azure-native-sdk/storagediscovery/v3": "storagediscovery", "github.com/pulumi/pulumi-azure-native-sdk/storagemover/v3": "storagemover", "github.com/pulumi/pulumi-azure-native-sdk/storagepool/v3": "storagepool", "github.com/pulumi/pulumi-azure-native-sdk/storagesync/v3": "storagesync", "github.com/pulumi/pulumi-azure-native-sdk/streamanalytics/v3": "streamanalytics", "github.com/pulumi/pulumi-azure-native-sdk/subscription/v3": "subscription", "github.com/pulumi/pulumi-azure-native-sdk/support/v3": "support", "github.com/pulumi/pulumi-azure-native-sdk/synapse/v3": "synapse", "github.com/pulumi/pulumi-azure-native-sdk/syntex/v3": "syntex", "github.com/pulumi/pulumi-azure-native-sdk/testbase/v3": "testbase", "github.com/pulumi/pulumi-azure-native-sdk/timeseriesinsights/v3": "timeseriesinsights", "github.com/pulumi/pulumi-azure-native-sdk/trafficmanager/v3": "trafficmanager", "github.com/pulumi/pulumi-azure-native-sdk/verifiedid/v3": "verifiedid", "github.com/pulumi/pulumi-azure-native-sdk/videoindexer/v3": "videoindexer", "github.com/pulumi/pulumi-azure-native-sdk/virtualmachineimages/v3": "virtualmachineimages", "github.com/pulumi/pulumi-azure-native-sdk/vmwarecloudsimple/v3": "vmwarecloudsimple", "github.com/pulumi/pulumi-azure-native-sdk/web/v3": "web", "github.com/pulumi/pulumi-azure-native-sdk/webpubsub/v3": "webpubsub", "github.com/pulumi/pulumi-azure-native-sdk/weightsandbiases/v3": "weightsandbiases", "github.com/pulumi/pulumi-azure-native-sdk/widget/v3": "widget", "github.com/pulumi/pulumi-azure-native-sdk/windowsesu/v3": "windowsesu", "github.com/pulumi/pulumi-azure-native-sdk/windowsiot/v3": "windowsiot", "github.com/pulumi/pulumi-azure-native-sdk/workloadmonitor/v3": "workloadmonitor", "github.com/pulumi/pulumi-azure-native-sdk/workloads/v3": "workloads" }, "respectSchemaVersion": true, "rootPackageName": "pulumiazurenativesdk" }, "java": { "packages": { "aad": "aad", "aadiam": "aadiam", "addons": "addons", "adhybridhealthservice": "adhybridhealthservice", "advisor": "advisor", "agfoodplatform": "agfoodplatform", "agricultureplatform": "agricultureplatform", "alertsmanagement": "alertsmanagement", "analysisservices": "analysisservices", "apicenter": "apicenter", "apimanagement": "apimanagement", "app": "app", "appcomplianceautomation": "appcomplianceautomation", "appconfiguration": "appconfiguration", "applicationinsights": "applicationinsights", "applink": "applink", "appplatform": "appplatform", "attestation": "attestation", "authorization": "authorization", "automanage": "automanage", "automation": "automation", "avs": "avs", "awsconnector": "awsconnector", "azure-native": "azurenative", "azureactivedirectory": "azureactivedirectory", "azurearcdata": "azurearcdata", "azuredata": "azuredata", "azuredatatransfer": "azuredatatransfer", "azurefleet": "azurefleet", "azurelargeinstance": "azurelargeinstance", "azureplaywrightservice": "azureplaywrightservice", "azureresiliencemanagement": "azureresiliencemanagement", "azuresphere": "azuresphere", "azurestack": "azurestack", "azurestackhci": "azurestackhci", "azureterraform": "azureterraform", "baremetalinfrastructure": "baremetalinfrastructure", "batch": "batch", "billing": "billing", "billingbenefits": "billingbenefits", "billingtrust": "billingtrust", "blueprint": "blueprint", "botservice": "botservice", "capacity": "capacity", "carbon": "carbon", "cdn": "cdn", "certificateregistration": "certificateregistration", "chaos": "chaos", "cloudhealth": "cloudhealth", "cloudngfw": "cloudngfw", "codesigning": "codesigning", "cognitiveservices": "cognitiveservices", "commerce": "commerce", "communication": "communication", "community": "community", "compute": "compute", "computebulkactions": "computebulkactions", "computelimit": "computelimit", "computeschedule": "computeschedule", "confidentialledger": "confidentialledger", "confluent": "confluent", "connectedcache": "connectedcache", "connectedvmwarevsphere": "connectedvmwarevsphere", "consumption": "consumption", "containerinstance": "containerinstance", "containerregistry": "containerregistry", "containerservice": "containerservice", "containerstorage": "containerstorage", "contoso": "contoso", "cosmosdb": "cosmosdb", "costmanagement": "costmanagement", "customerinsights": "customerinsights", "customerlockbox": "customerlockbox", "customproviders": "customproviders", "dashboard": "dashboard", "databasefleetmanager": "databasefleetmanager", "databasewatcher": "databasewatcher", "databox": "databox", "databoxedge": "databoxedge", "databricks": "databricks", "datacatalog": "datacatalog", "datadog": "datadog", "datafactory": "datafactory", "datalakeanalytics": "datalakeanalytics", "datalakestore": "datalakestore", "datamigration": "datamigration", "dataprotection": "dataprotection", "datareplication": "datareplication", "datashare": "datashare", "dbformariadb": "dbformariadb", "dbformysql": "dbformysql", "dbforpostgresql": "dbforpostgresql", "delegatednetwork": "delegatednetwork", "dependencymap": "dependencymap", "desktopvirtualization": "desktopvirtualization", "devcenter": "devcenter", "devhub": "devhub", "deviceprovisioningservices": "deviceprovisioningservices", "deviceregistry": "deviceregistry", "deviceupdate": "deviceupdate", "devops": "devops", "devopsinfrastructure": "devopsinfrastructure", "devspaces": "devspaces", "devtestlab": "devtestlab", "digitaltwins": "digitaltwins", "discovery": "discovery", "dns": "dns", "dnsresolver": "dnsresolver", "domainregistration": "domainregistration", "durabletask": "durabletask", "dynamics365fraudprotection": "dynamics365fraudprotection", "dynamicstelemetry": "dynamicstelemetry", "easm": "easm", "edge": "edge", "edgemarketplace": "edgemarketplace", "edgeorder": "edgeorder", "edgeorderpartner": "edgeorderpartner", "edgezones": "edgezones", "education": "education", "elastic": "elastic", "elasticsan": "elasticsan", "engagementfabric": "engagementfabric", "enterpriseknowledgegraph": "enterpriseknowledgegraph", "eventgrid": "eventgrid", "eventhub": "eventhub", "extendedlocation": "extendedlocation", "fabric": "fabric", "features": "features", "fileshares": "fileshares", "fluidrelay": "fluidrelay", "frontdoor": "frontdoor", "graphservices": "graphservices", "guestconfiguration": "guestconfiguration", "hanaonazure": "hanaonazure", "hardwaresecuritymodules": "hardwaresecuritymodules", "hdinsight": "hdinsight", "healthbot": "healthbot", "healthcareapis": "healthcareapis", "healthdataaiservices": "healthdataaiservices", "help": "help", "horizondb": "horizondb", "hybridcloud": "hybridcloud", "hybridcompute": "hybridcompute", "hybridconnectivity": "hybridconnectivity", "hybridcontainerservice": "hybridcontainerservice", "hybridnetwork": "hybridnetwork", "impact": "impact", "importexport": "importexport", "integrationspaces": "integrationspaces", "intune": "intune", "iotcentral": "iotcentral", "iotfirmwaredefense": "iotfirmwaredefense", "iothub": "iothub", "iotoperations": "iotoperations", "iotoperationsdataprocessor": "iotoperationsdataprocessor", "iotoperationsmq": "iotoperationsmq", "iotoperationsorchestrator": "iotoperationsorchestrator", "keyvault": "keyvault", "kubernetes": "kubernetes", "kubernetesconfiguration": "kubernetesconfiguration", "kubernetesruntime": "kubernetesruntime", "kusto": "kusto", "labservices": "labservices", "loadtestservice": "loadtestservice", "logic": "logic", "m365securityandcompliance": "m365securityandcompliance", "machinelearning": "machinelearning", "machinelearningservices": "machinelearningservices", "maintenance": "maintenance", "managedidentity": "managedidentity", "managednetwork": "managednetwork", "managednetworkfabric": "managednetworkfabric", "managedops": "managedops", "managedservices": "managedservices", "management": "management", "managementpartner": "managementpartner", "manufacturingplatform": "manufacturingplatform", "maps": "maps", "marketplace": "marketplace", "marketplacenotifications": "marketplacenotifications", "marketplaceordering": "marketplaceordering", "migrate": "migrate", "mission": "mission", "mongocluster": "mongocluster", "monitor": "monitor", "mysqldiscovery": "mysqldiscovery", "netapp": "netapp", "network": "network", "networkcloud": "networkcloud", "networkfunction": "networkfunction", "notificationhubs": "notificationhubs", "offazure": "offazure", "offazurespringboot": "offazurespringboot", "onlineexperimentation": "onlineexperimentation", "openenergyplatform": "openenergyplatform", "operationalinsights": "operationalinsights", "operationsmanagement": "operationsmanagement", "orbital": "orbital", "peering": "peering", "policyinsights": "policyinsights", "portal": "portal", "portalservices": "portalservices", "powerbi": "powerbi", "powerbidedicated": "powerbidedicated", "powerplatform": "powerplatform", "privatedns": "privatedns", "professionalservice": "professionalservice", "programenrollment": "programenrollment", "programmableconnectivity": "programmableconnectivity", "providerhub": "providerhub", "purview": "purview", "quantum": "quantum", "quota": "quota", "recommendationsservice": "recommendationsservice", "recoveryservices": "recoveryservices", "redhatopenshift": "redhatopenshift", "redis": "redis", "redisenterprise": "redisenterprise", "relationships": "relationships", "relay": "relay", "resourceconnector": "resourceconnector", "resourcegraph": "resourcegraph", "resourcehealth": "resourcehealth", "resources": "resources", "saas": "saas", "scheduler": "scheduler", "scom": "scom", "scvmm": "scvmm", "search": "search", "secretsynccontroller": "secretsynccontroller", "security": "security", "securityandcompliance": "securityandcompliance", "securityinsights": "securityinsights", "serialconsole": "serialconsole", "servicebus": "servicebus", "servicefabric": "servicefabric", "servicefabricmesh": "servicefabricmesh", "servicelinker": "servicelinker", "servicenetworking": "servicenetworking", "signalrservice": "signalrservice", "softwareplan": "softwareplan", "solutions": "solutions", "sovereign": "sovereign", "sql": "sql", "sqlvirtualmachine": "sqlvirtualmachine", "standbypool": "standbypool", "storage": "storage", "storageactions": "storageactions", "storagecache": "storagecache", "storagediscovery": "storagediscovery", "storagemover": "storagemover", "storagepool": "storagepool", "storagesync": "storagesync", "streamanalytics": "streamanalytics", "subscription": "subscription", "support": "support", "synapse": "synapse", "syntex": "syntex", "testbase": "testbase", "timeseriesinsights": "timeseriesinsights", "trafficmanager": "trafficmanager", "verifiedid": "verifiedid", "videoindexer": "videoindexer", "virtualmachineimages": "virtualmachineimages", "vmwarecloudsimple": "vmwarecloudsimple", "web": "web", "webpubsub": "webpubsub", "weightsandbiases": "weightsandbiases", "widget": "widget", "windowsesu": "windowsesu", "windowsiot": "windowsiot", "workloadmonitor": "workloadmonitor", "workloads": "workloads" } }, "nodejs": { "readme": "The native Azure provider package offers support for all Azure Resource Manager (ARM)\nresources and their properties. Resources are exposed as types from modules based on Azure Resource\nProviders such as 'compute', 'network', 'storage', and 'web', among many others. Using this package\nallows you to programmatically declare instances of any Azure resource and any supported resource\nversion using infrastructure as code, which Pulumi then uses to drive the ARM API.", "respectSchemaVersion": true }, "python": { "inputTypes": "classes-and-dicts", "moduleNameOverrides": { "aad": "aad", "aadiam": "aadiam", "addons": "addons", "adhybridhealthservice": "adhybridhealthservice", "advisor": "advisor", "agfoodplatform": "agfoodplatform", "agricultureplatform": "agricultureplatform", "alertsmanagement": "alertsmanagement", "analysisservices": "analysisservices", "apicenter": "apicenter", "apimanagement": "apimanagement", "app": "app", "appcomplianceautomation": "appcomplianceautomation", "appconfiguration": "appconfiguration", "applicationinsights": "applicationinsights", "applink": "applink", "appplatform": "appplatform", "attestation": "attestation", "authorization": "authorization", "automanage": "automanage", "automation": "automation", "avs": "avs", "awsconnector": "awsconnector", "azureactivedirectory": "azureactivedirectory", "azurearcdata": "azurearcdata", "azuredata": "azuredata", "azuredatatransfer": "azuredatatransfer", "azurefleet": "azurefleet", "azurelargeinstance": "azurelargeinstance", "azureplaywrightservice": "azureplaywrightservice", "azureresiliencemanagement": "azureresiliencemanagement", "azuresphere": "azuresphere", "azurestack": "azurestack", "azurestackhci": "azurestackhci", "azureterraform": "azureterraform", "baremetalinfrastructure": "baremetalinfrastructure", "batch": "batch", "billing": "billing", "billingbenefits": "billingbenefits", "billingtrust": "billingtrust", "blueprint": "blueprint", "botservice": "botservice", "capacity": "capacity", "carbon": "carbon", "cdn": "cdn", "certificateregistration": "certificateregistration", "chaos": "chaos", "cloudhealth": "cloudhealth", "cloudngfw": "cloudngfw", "codesigning": "codesigning", "cognitiveservices": "cognitiveservices", "commerce": "commerce", "communication": "communication", "community": "community", "compute": "compute", "computebulkactions": "computebulkactions", "computelimit": "computelimit", "computeschedule": "computeschedule", "confidentialledger": "confidentialledger", "confluent": "confluent", "connectedcache": "connectedcache", "connectedvmwarevsphere": "connectedvmwarevsphere", "consumption": "consumption", "containerinstance": "containerinstance", "containerregistry": "containerregistry", "containerservice": "containerservice", "containerstorage": "containerstorage", "contoso": "contoso", "cosmosdb": "cosmosdb", "costmanagement": "costmanagement", "customerinsights": "customerinsights", "customerlockbox": "customerlockbox", "customproviders": "customproviders", "dashboard": "dashboard", "databasefleetmanager": "databasefleetmanager", "databasewatcher": "databasewatcher", "databox": "databox", "databoxedge": "databoxedge", "databricks": "databricks", "datacatalog": "datacatalog", "datadog": "datadog", "datafactory": "datafactory", "datalakeanalytics": "datalakeanalytics", "datalakestore": "datalakestore", "datamigration": "datamigration", "dataprotection": "dataprotection", "datareplication": "datareplication", "datashare": "datashare", "dbformariadb": "dbformariadb", "dbformysql": "dbformysql", "dbforpostgresql": "dbforpostgresql", "delegatednetwork": "delegatednetwork", "dependencymap": "dependencymap", "desktopvirtualization": "desktopvirtualization", "devcenter": "devcenter", "devhub": "devhub", "deviceprovisioningservices": "deviceprovisioningservices", "deviceregistry": "deviceregistry", "deviceupdate": "deviceupdate", "devops": "devops", "devopsinfrastructure": "devopsinfrastructure", "devspaces": "devspaces", "devtestlab": "devtestlab", "digitaltwins": "digitaltwins", "discovery": "discovery", "dns": "dns", "dnsresolver": "dnsresolver", "domainregistration": "domainregistration", "durabletask": "durabletask", "dynamics365fraudprotection": "dynamics365fraudprotection", "dynamicstelemetry": "dynamicstelemetry", "easm": "easm", "edge": "edge", "edgemarketplace": "edgemarketplace", "edgeorder": "edgeorder", "edgeorderpartner": "edgeorderpartner", "edgezones": "edgezones", "education": "education", "elastic": "elastic", "elasticsan": "elasticsan", "engagementfabric": "engagementfabric", "enterpriseknowledgegraph": "enterpriseknowledgegraph", "eventgrid": "eventgrid", "eventhub": "eventhub", "extendedlocation": "extendedlocation", "fabric": "fabric", "features": "features", "fileshares": "fileshares", "fluidrelay": "fluidrelay", "frontdoor": "frontdoor", "graphservices": "graphservices", "guestconfiguration": "guestconfiguration", "hanaonazure": "hanaonazure", "hardwaresecuritymodules": "hardwaresecuritymodules", "hdinsight": "hdinsight", "healthbot": "healthbot", "healthcareapis": "healthcareapis", "healthdataaiservices": "healthdataaiservices", "help": "help", "horizondb": "horizondb", "hybridcloud": "hybridcloud", "hybridcompute": "hybridcompute", "hybridconnectivity": "hybridconnectivity", "hybridcontainerservice": "hybridcontainerservice", "hybridnetwork": "hybridnetwork", "impact": "impact", "importexport": "importexport", "integrationspaces": "integrationspaces", "intune": "intune", "iotcentral": "iotcentral", "iotfirmwaredefense": "iotfirmwaredefense", "iothub": "iothub", "iotoperations": "iotoperations", "iotoperationsdataprocessor": "iotoperationsdataprocessor", "iotoperationsmq": "iotoperationsmq", "iotoperationsorchestrator": "iotoperationsorchestrator", "keyvault": "keyvault", "kubernetes": "kubernetes", "kubernetesconfiguration": "kubernetesconfiguration", "kubernetesruntime": "kubernetesruntime", "kusto": "kusto", "labservices": "labservices", "loadtestservice": "loadtestservice", "logic": "logic", "m365securityandcompliance": "m365securityandcompliance", "machinelearning": "machinelearning", "machinelearningservices": "machinelearningservices", "maintenance": "maintenance", "managedidentity": "managedidentity", "managednetwork": "managednetwork", "managednetworkfabric": "managednetworkfabric", "managedops": "managedops", "managedservices": "managedservices", "management": "management", "managementpartner": "managementpartner", "manufacturingplatform": "manufacturingplatform", "maps": "maps", "marketplace": "marketplace", "marketplacenotifications": "marketplacenotifications", "marketplaceordering": "marketplaceordering", "migrate": "migrate", "mission": "mission", "mongocluster": "mongocluster", "monitor": "monitor", "mysqldiscovery": "mysqldiscovery", "netapp": "netapp", "network": "network", "networkcloud": "networkcloud", "networkfunction": "networkfunction", "notificationhubs": "notificationhubs", "offazure": "offazure", "offazurespringboot": "offazurespringboot", "onlineexperimentation": "onlineexperimentation", "openenergyplatform": "openenergyplatform", "operationalinsights": "operationalinsights", "operationsmanagement": "operationsmanagement", "orbital": "orbital", "peering": "peering", "policyinsights": "policyinsights", "portal": "portal", "portalservices": "portalservices", "powerbi": "powerbi", "powerbidedicated": "powerbidedicated", "powerplatform": "powerplatform", "privatedns": "privatedns", "professionalservice": "professionalservice", "programenrollment": "programenrollment", "programmableconnectivity": "programmableconnectivity", "providerhub": "providerhub", "purview": "purview", "quantum": "quantum", "quota": "quota", "recommendationsservice": "recommendationsservice", "recoveryservices": "recoveryservices", "redhatopenshift": "redhatopenshift", "redis": "redis", "redisenterprise": "redisenterprise", "relationships": "relationships", "relay": "relay", "resourceconnector": "resourceconnector", "resourcegraph": "resourcegraph", "resourcehealth": "resourcehealth", "resources": "resources", "saas": "saas", "scheduler": "scheduler", "scom": "scom", "scvmm": "scvmm", "search": "search", "secretsynccontroller": "secretsynccontroller", "security": "security", "securityandcompliance": "securityandcompliance", "securityinsights": "securityinsights", "serialconsole": "serialconsole", "servicebus": "servicebus", "servicefabric": "servicefabric", "servicefabricmesh": "servicefabricmesh", "servicelinker": "servicelinker", "servicenetworking": "servicenetworking", "signalrservice": "signalrservice", "softwareplan": "softwareplan", "solutions": "solutions", "sovereign": "sovereign", "sql": "sql", "sqlvirtualmachine": "sqlvirtualmachine", "standbypool": "standbypool", "storage": "storage", "storageactions": "storageactions", "storagecache": "storagecache", "storagediscovery": "storagediscovery", "storagemover": "storagemover", "storagepool": "storagepool", "storagesync": "storagesync", "streamanalytics": "streamanalytics", "subscription": "subscription", "support": "support", "synapse": "synapse", "syntex": "syntex", "testbase": "testbase", "timeseriesinsights": "timeseriesinsights", "trafficmanager": "trafficmanager", "verifiedid": "verifiedid", "videoindexer": "videoindexer", "virtualmachineimages": "virtualmachineimages", "vmwarecloudsimple": "vmwarecloudsimple", "web": "web", "webpubsub": "webpubsub", "weightsandbiases": "weightsandbiases", "widget": "widget", "windowsesu": "windowsesu", "windowsiot": "windowsiot", "workloadmonitor": "workloadmonitor", "workloads": "workloads" }, "pyproject": { "enabled": true }, "readme": "The native Azure provider package offers support for all Azure Resource Manager (ARM)\nresources and their properties. Resources are exposed as types from modules based on Azure Resource\nProviders such as 'compute', 'network', 'storage', and 'web', among many others. Using this package\nallows you to programmatically declare instances of any Azure resource and any supported resource\nversion using infrastructure as code, which Pulumi then uses to drive the ARM API.", "respectSchemaVersion": true, "usesIOClasses": true } }, "config": { "variables": { "auxiliaryTenantIds": { "type": "array", "items": { "type": "string" }, "description": "Any additional Tenant IDs which should be used for authentication." }, "clientCertificatePassword": { "type": "string", "description": "The password associated with the Client Certificate. For use when authenticating as a Service Principal using a Client Certificate", "secret": true }, "clientCertificatePath": { "type": "string", "description": "The path to the Client Certificate associated with the Service Principal for use when authenticating as a Service Principal using a Client Certificate." }, "clientId": { "type": "string", "description": "The Client ID which should be used.", "secret": true }, "clientSecret": { "type": "string", "description": "The Client Secret which should be used. For use when authenticating as a Service Principal using a Client Secret.", "secret": true }, "disableInstanceDiscovery": { "type": "boolean", "description": "Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached, such as in private clouds or Azure Stack." }, "disablePulumiPartnerId": { "type": "boolean", "description": "This will disable the Pulumi Partner ID which is used if a custom `partnerId` isn't specified." }, "environment": { "type": "string", "description": "The Cloud Environment which should be used. Possible values are public, usgovernment, and china. Defaults to public. Not used when metadataHost is specified or when ARM_METADATA_HOSTNAME is set." }, "location": { "type": "string", "description": "The location to use. ResourceGroups will consult this property for a default location, if one was not supplied explicitly when defining the resource." }, "metadataHost": { "type": "string", "description": "The Hostname of the Azure Metadata Service." }, "msiEndpoint": { "type": "string", "description": "The path to a custom endpoint for Managed Service Identity - in most circumstances this should be detected automatically." }, "oidcRequestToken": { "type": "string", "description": "Your cloud service or provider's bearer token to exchange for an OIDC ID token." }, "oidcRequestUrl": { "type": "string", "description": "The URL to initiate the OIDC token exchange. " }, "oidcToken": { "type": "string", "description": "The OIDC token to exchange for an Azure token." }, "oidcTokenFilePath": { "type": "string", "description": "The path to a file containing an OIDC token to exchange for an Azure token." }, "partnerId": { "type": "string", "description": "A GUID/UUID that is registered with Microsoft to facilitate partner resource usage attribution." }, "subscriptionId": { "type": "string", "description": "The Subscription ID which should be used." }, "tenantId": { "type": "string", "description": "The Tenant ID which should be used." }, "useDefaultAzureCredential": { "type": "boolean", "description": "Use the default credential chain of the Azure SDK (see https://learn.microsoft.com/en-us/azure/developer/go/sdk/authentication/credential-chains#defaultazurecredential-overview)." }, "useMsi": { "type": "boolean", "description": "Allow Managed Service Identity be used for Authentication." }, "useOidc": { "type": "boolean", "description": "Allow OpenID Connect (OIDC) to be used for Authentication." } } }, "types": { "azure-native:aad:ChannelBinding": { "description": "A flag to determine whether or not ChannelBinding is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:ConfigDiagnostics": { "description": "Configuration Diagnostics", "properties": { "lastExecuted": { "type": "string", "description": "Last domain configuration diagnostics DateTime" }, "validatorResults": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:ConfigDiagnosticsValidatorResult" }, "description": "List of Configuration Diagnostics validator results." } }, "type": "object" }, "azure-native:aad:ConfigDiagnosticsResponse": { "description": "Configuration Diagnostics", "properties": { "lastExecuted": { "type": "string", "description": "Last domain configuration diagnostics DateTime" }, "validatorResults": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:ConfigDiagnosticsValidatorResultResponse" }, "description": "List of Configuration Diagnostics validator results." } }, "type": "object" }, "azure-native:aad:ConfigDiagnosticsValidatorResult": { "description": "Config Diagnostics validator result data", "properties": { "issues": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:ConfigDiagnosticsValidatorResultIssue" }, "description": "List of resource config validation issues." }, "replicaSetSubnetDisplayName": { "type": "string", "description": "Replica set location and subnet name" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:Status" } ], "description": "Status for individual validator after running diagnostics.", "default": "None" }, "validatorId": { "type": "string", "description": "Validator identifier" } }, "type": "object" }, "azure-native:aad:ConfigDiagnosticsValidatorResultIssue": { "description": "Specific issue for a particular config diagnostics validator", "properties": { "descriptionParams": { "type": "array", "items": { "type": "string" }, "description": "List of domain resource property name or values used to compose a rich description." }, "id": { "type": "string", "description": "Validation issue identifier." } }, "type": "object" }, "azure-native:aad:ConfigDiagnosticsValidatorResultIssueResponse": { "description": "Specific issue for a particular config diagnostics validator", "properties": { "descriptionParams": { "type": "array", "items": { "type": "string" }, "description": "List of domain resource property name or values used to compose a rich description." }, "id": { "type": "string", "description": "Validation issue identifier." } }, "type": "object" }, "azure-native:aad:ConfigDiagnosticsValidatorResultResponse": { "description": "Config Diagnostics validator result data", "properties": { "issues": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:ConfigDiagnosticsValidatorResultIssueResponse" }, "description": "List of resource config validation issues." }, "replicaSetSubnetDisplayName": { "type": "string", "description": "Replica set location and subnet name" }, "status": { "type": "string", "description": "Status for individual validator after running diagnostics.", "default": "None" }, "validatorId": { "type": "string", "description": "Validator identifier" } }, "type": "object" }, "azure-native:aad:ContainerAccountResponse": { "description": "Container Account Description", "properties": { "accountName": { "type": "string", "description": "The account name" }, "password": { "type": "string", "description": "The account password" }, "spn": { "type": "string", "description": "The account spn" } }, "type": "object" }, "azure-native:aad:DomainSecuritySettings": { "description": "Domain Security Settings", "properties": { "channelBinding": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:ChannelBinding" } ], "description": "A flag to determine whether or not ChannelBinding is enabled or disabled.", "default": "Disabled" }, "kerberosArmoring": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:KerberosArmoring" } ], "description": "A flag to determine whether or not KerberosArmoring is enabled or disabled.", "default": "Disabled" }, "kerberosRc4Encryption": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:KerberosRc4Encryption" } ], "description": "A flag to determine whether or not KerberosRc4Encryption is enabled or disabled.", "default": "Enabled" }, "ldapSigning": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:LdapSigning" } ], "description": "A flag to determine whether or not LdapSigning is enabled or disabled.", "default": "Disabled" }, "ntlmV1": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:NtlmV1" } ], "description": "A flag to determine whether or not NtlmV1 is enabled or disabled.", "default": "Enabled" }, "syncKerberosPasswords": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:SyncKerberosPasswords" } ], "description": "A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.", "default": "Enabled" }, "syncNtlmPasswords": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:SyncNtlmPasswords" } ], "description": "A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.", "default": "Enabled" }, "syncOnPremPasswords": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:SyncOnPremPasswords" } ], "description": "A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.", "default": "Enabled" }, "tlsV1": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:TlsV1" } ], "description": "A flag to determine whether or not TlsV1 is enabled or disabled.", "default": "Enabled" } }, "type": "object" }, "azure-native:aad:DomainSecuritySettingsResponse": { "description": "Domain Security Settings", "properties": { "channelBinding": { "type": "string", "description": "A flag to determine whether or not ChannelBinding is enabled or disabled.", "default": "Disabled" }, "kerberosArmoring": { "type": "string", "description": "A flag to determine whether or not KerberosArmoring is enabled or disabled.", "default": "Disabled" }, "kerberosRc4Encryption": { "type": "string", "description": "A flag to determine whether or not KerberosRc4Encryption is enabled or disabled.", "default": "Enabled" }, "ldapSigning": { "type": "string", "description": "A flag to determine whether or not LdapSigning is enabled or disabled.", "default": "Disabled" }, "ntlmV1": { "type": "string", "description": "A flag to determine whether or not NtlmV1 is enabled or disabled.", "default": "Enabled" }, "syncKerberosPasswords": { "type": "string", "description": "A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.", "default": "Enabled" }, "syncNtlmPasswords": { "type": "string", "description": "A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.", "default": "Enabled" }, "syncOnPremPasswords": { "type": "string", "description": "A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.", "default": "Enabled" }, "tlsV1": { "type": "string", "description": "A flag to determine whether or not TlsV1 is enabled or disabled.", "default": "Enabled" } }, "type": "object" }, "azure-native:aad:ExternalAccess": { "description": "A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:FilteredSync": { "description": "Enabled or Disabled flag to turn on Group-based filtered sync", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:ForestTrust": { "description": "Forest Trust Setting", "properties": { "friendlyName": { "type": "string", "description": "Friendly Name" }, "remoteDnsIps": { "type": "string", "description": "Remote Dns ips" }, "trustDirection": { "type": "string", "description": "Trust Direction" }, "trustPassword": { "type": "string", "description": "Trust Password" }, "trustedDomainFqdn": { "type": "string", "description": "Trusted Domain FQDN" } }, "type": "object" }, "azure-native:aad:ForestTrustResponse": { "description": "Forest Trust Setting", "properties": { "friendlyName": { "type": "string", "description": "Friendly Name" }, "remoteDnsIps": { "type": "string", "description": "Remote Dns ips" }, "trustDirection": { "type": "string", "description": "Trust Direction" }, "trustPassword": { "type": "string", "description": "Trust Password" }, "trustedDomainFqdn": { "type": "string", "description": "Trusted Domain FQDN" } }, "type": "object" }, "azure-native:aad:HealthAlertResponse": { "description": "Health Alert Description", "properties": { "id": { "type": "string", "description": "Health Alert Id" }, "issue": { "type": "string", "description": "Health Alert Issue" }, "lastDetected": { "type": "string", "description": "Health Alert Last Detected DateTime" }, "name": { "type": "string", "description": "Health Alert Name" }, "raised": { "type": "string", "description": "Health Alert Raised DateTime" }, "resolutionUri": { "type": "string", "description": "Health Alert TSG Link" }, "severity": { "type": "string", "description": "Health Alert Severity" } }, "type": "object", "required": [ "id", "issue", "lastDetected", "name", "raised", "resolutionUri", "severity" ] }, "azure-native:aad:HealthMonitorResponse": { "description": "Health Monitor Description", "properties": { "details": { "type": "string", "description": "Health Monitor Details" }, "id": { "type": "string", "description": "Health Monitor Id" }, "name": { "type": "string", "description": "Health Monitor Name" } }, "type": "object", "required": [ "details", "id", "name" ] }, "azure-native:aad:KerberosArmoring": { "description": "A flag to determine whether or not KerberosArmoring is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:KerberosRc4Encryption": { "description": "A flag to determine whether or not KerberosRc4Encryption is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:LdapSigning": { "description": "A flag to determine whether or not LdapSigning is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:Ldaps": { "description": "A flag to determine whether or not Secure LDAP is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:LdapsSettings": { "description": "Secure LDAP Settings", "properties": { "externalAccess": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:ExternalAccess" } ], "description": "A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.", "default": "Disabled" }, "ldaps": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:Ldaps" } ], "description": "A flag to determine whether or not Secure LDAP is enabled or disabled.", "default": "Disabled" }, "pfxCertificate": { "type": "string", "description": "The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file." }, "pfxCertificatePassword": { "type": "string", "description": "The password to decrypt the provided Secure LDAP certificate pfx file." } }, "type": "object" }, "azure-native:aad:LdapsSettingsResponse": { "description": "Secure LDAP Settings", "properties": { "certificateNotAfter": { "type": "string", "description": "NotAfter DateTime of configure ldaps certificate." }, "certificateThumbprint": { "type": "string", "description": "Thumbprint of configure ldaps certificate." }, "externalAccess": { "type": "string", "description": "A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled.", "default": "Disabled" }, "ldaps": { "type": "string", "description": "A flag to determine whether or not Secure LDAP is enabled or disabled.", "default": "Disabled" }, "pfxCertificate": { "type": "string", "description": "The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file." }, "pfxCertificatePassword": { "type": "string", "description": "The password to decrypt the provided Secure LDAP certificate pfx file." }, "publicCertificate": { "type": "string", "description": "Public certificate used to configure secure ldap." } }, "type": "object", "required": [ "certificateNotAfter", "certificateThumbprint", "publicCertificate" ] }, "azure-native:aad:MigrationProgressResponse": { "description": "Migration Progress", "properties": { "completionPercentage": { "type": "number", "description": "Completion Percentage" }, "progressMessage": { "type": "string", "description": "Progress Message" } }, "type": "object" }, "azure-native:aad:MigrationPropertiesResponse": { "description": "Migration Properties", "properties": { "migrationProgress": { "type": "object", "$ref": "#/types/azure-native:aad:MigrationProgressResponse", "description": "Migration Progress" }, "oldSubnetId": { "type": "string", "description": "Old Subnet Id" }, "oldVnetSiteId": { "type": "string", "description": "Old Vnet Site Id" } }, "type": "object", "required": [ "migrationProgress", "oldSubnetId", "oldVnetSiteId" ] }, "azure-native:aad:NotificationSettings": { "description": "Settings for notification", "properties": { "additionalRecipients": { "type": "array", "items": { "type": "string" }, "description": "The list of additional recipients" }, "notifyDcAdmins": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:NotifyDcAdmins" } ], "description": "Should domain controller admins be notified" }, "notifyGlobalAdmins": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aad:NotifyGlobalAdmins" } ], "description": "Should global admins be notified" } }, "type": "object" }, "azure-native:aad:NotificationSettingsResponse": { "description": "Settings for notification", "properties": { "additionalRecipients": { "type": "array", "items": { "type": "string" }, "description": "The list of additional recipients" }, "notifyDcAdmins": { "type": "string", "description": "Should domain controller admins be notified" }, "notifyGlobalAdmins": { "type": "string", "description": "Should global admins be notified" } }, "type": "object" }, "azure-native:aad:NotifyDcAdmins": { "description": "Should domain controller admins be notified", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:NotifyGlobalAdmins": { "description": "Should global admins be notified", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:NtlmV1": { "description": "A flag to determine whether or not NtlmV1 is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:ReplicaSet": { "description": "Replica Set Definition", "properties": { "location": { "type": "string", "description": "Virtual network location" }, "subnetId": { "type": "string", "description": "The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName." } }, "type": "object" }, "azure-native:aad:ReplicaSetResponse": { "description": "Replica Set Definition", "properties": { "domainControllerIpAddress": { "type": "array", "items": { "type": "string" }, "description": "List of Domain Controller IP Address" }, "externalAccessIpAddress": { "type": "string", "description": "External access ip address." }, "healthAlerts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:HealthAlertResponse" }, "description": "List of Domain Health Alerts" }, "healthLastEvaluated": { "type": "string", "description": "Last domain evaluation run DateTime" }, "healthMonitors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:HealthMonitorResponse" }, "description": "List of Domain Health Monitors" }, "location": { "type": "string", "description": "Virtual network location" }, "replicaSetId": { "type": "string", "description": "ReplicaSet Id" }, "serviceStatus": { "type": "string", "description": "Status of Domain Service instance" }, "subnetId": { "type": "string", "description": "The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName." }, "vnetSiteId": { "type": "string", "description": "Virtual network site id" } }, "type": "object", "required": [ "domainControllerIpAddress", "externalAccessIpAddress", "healthAlerts", "healthLastEvaluated", "healthMonitors", "replicaSetId", "serviceStatus", "vnetSiteId" ] }, "azure-native:aad:ResourceForestSettings": { "description": "Settings for Resource Forest", "properties": { "resourceForest": { "type": "string", "description": "Resource Forest" }, "settings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:ForestTrust" }, "description": "List of settings for Resource Forest" } }, "type": "object" }, "azure-native:aad:ResourceForestSettingsResponse": { "description": "Settings for Resource Forest", "properties": { "resourceForest": { "type": "string", "description": "Resource Forest" }, "settings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:aad:ForestTrustResponse" }, "description": "List of settings for Resource Forest" } }, "type": "object" }, "azure-native:aad:Status": { "description": "Status for individual validator after running diagnostics.", "type": "string", "enum": [ { "value": "None" }, { "value": "Running" }, { "value": "OK" }, { "value": "Failure" }, { "value": "Warning" }, { "value": "Skipped" } ] }, "azure-native:aad:SyncKerberosPasswords": { "description": "A flag to determine whether or not SyncKerberosPasswords is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:SyncNtlmPasswords": { "description": "A flag to determine whether or not SyncNtlmPasswords is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:SyncOnPremPasswords": { "description": "A flag to determine whether or not SyncOnPremPasswords is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aad:SyncScope": { "description": "All or CloudOnly, All users in AAD are synced to AAD DS domain or only users actively syncing in the cloud", "type": "string", "enum": [ { "value": "All" }, { "value": "CloudOnly" } ] }, "azure-native:aad:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:aad:TlsV1": { "description": "A flag to determine whether or not TlsV1 is enabled or disabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:aadiam:Category": { "description": "Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation.", "type": "string", "enum": [ { "value": "AuditLogs" }, { "value": "SignInLogs" } ] }, "azure-native:aadiam:LogSettings": { "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.", "properties": { "category": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:aadiam:Category" } ], "description": "Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation." }, "enabled": { "type": "boolean", "description": "A value indicating whether this log is enabled." }, "retentionPolicy": { "type": "object", "$ref": "#/types/azure-native:aadiam:RetentionPolicy", "description": "The retention policy for this log." } }, "type": "object", "required": [ "enabled" ] }, "azure-native:aadiam:LogSettingsResponse": { "description": "Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log.", "properties": { "category": { "type": "string", "description": "Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation." }, "enabled": { "type": "boolean", "description": "A value indicating whether this log is enabled." }, "retentionPolicy": { "type": "object", "$ref": "#/types/azure-native:aadiam:RetentionPolicyResponse", "description": "The retention policy for this log." } }, "type": "object", "required": [ "enabled" ] }, "azure-native:aadiam:RetentionPolicy": { "description": "Specifies the retention policy for the log.", "properties": { "days": { "type": "integer", "description": "The number of days for the retention in days. A value of 0 will retain the events indefinitely." }, "enabled": { "type": "boolean", "description": "A value indicating whether the retention policy is enabled." } }, "type": "object", "required": [ "days", "enabled" ] }, "azure-native:aadiam:RetentionPolicyResponse": { "description": "Specifies the retention policy for the log.", "properties": { "days": { "type": "integer", "description": "The number of days for the retention in days. A value of 0 will retain the events indefinitely." }, "enabled": { "type": "boolean", "description": "A value indicating whether the retention policy is enabled." } }, "type": "object", "required": [ "days", "enabled" ] }, "azure-native:advisor:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:agfoodplatform:ApiKeyAuthCredentials": { "description": "ApiKeyAuthCredentials class for ApiKey based Auth.", "properties": { "apiKey": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:KeyVaultProperties", "description": "Properties of the key vault." }, "kind": { "type": "string", "description": "Enum for different types of AuthCredentials supported.\nExpected value is 'ApiKeyAuthCredentials'.", "const": "ApiKeyAuthCredentials" } }, "type": "object", "required": [ "apiKey", "kind" ] }, "azure-native:agfoodplatform:ApiKeyAuthCredentialsResponse": { "description": "ApiKeyAuthCredentials class for ApiKey based Auth.", "properties": { "apiKey": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:KeyVaultPropertiesResponse", "description": "Properties of the key vault." }, "kind": { "type": "string", "description": "Enum for different types of AuthCredentials supported.\nExpected value is 'ApiKeyAuthCredentials'.", "const": "ApiKeyAuthCredentials" } }, "type": "object", "required": [ "apiKey", "kind" ] }, "azure-native:agfoodplatform:ApiProperties": { "description": "Api properties.", "properties": { "apiFreshnessTimeInMinutes": { "type": "integer", "description": "Interval in minutes for which the weather data for the api needs to be refreshed." } }, "type": "object" }, "azure-native:agfoodplatform:ApiPropertiesResponse": { "description": "Api properties.", "properties": { "apiFreshnessTimeInMinutes": { "type": "integer", "description": "Interval in minutes for which the weather data for the api needs to be refreshed." } }, "type": "object" }, "azure-native:agfoodplatform:AuthCredentialsKind": { "description": "Enum for different types of AuthCredentials supported.", "type": "string", "enum": [ { "value": "OAuthClientCredentials" }, { "value": "ApiKeyAuthCredentials" } ] }, "azure-native:agfoodplatform:DataConnectorProperties": { "description": "DataConnector Properties.", "properties": { "credentials": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:ApiKeyAuthCredentials" }, { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:OAuthClientCredentials" } ], "discriminator": { "propertyName": "kind", "mapping": { "ApiKeyAuthCredentials": "#/types/azure-native:agfoodplatform:ApiKeyAuthCredentials", "OAuthClientCredentials": "#/types/azure-native:agfoodplatform:OAuthClientCredentials" } }, "description": "AuthCredentials abstract base class for Auth Purpose." } }, "type": "object", "required": [ "credentials" ] }, "azure-native:agfoodplatform:DataConnectorPropertiesResponse": { "description": "DataConnector Properties.", "properties": { "credentials": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:ApiKeyAuthCredentialsResponse" }, { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:OAuthClientCredentialsResponse" } ], "discriminator": { "propertyName": "kind", "mapping": { "ApiKeyAuthCredentials": "#/types/azure-native:agfoodplatform:ApiKeyAuthCredentialsResponse", "OAuthClientCredentials": "#/types/azure-native:agfoodplatform:OAuthClientCredentialsResponse" } }, "description": "AuthCredentials abstract base class for Auth Purpose." } }, "type": "object", "required": [ "credentials" ] }, "azure-native:agfoodplatform:ErrorAdditionalInfoResponse": { "description": "The resource management error additional info.", "properties": { "info": { "$ref": "pulumi.json#/Any", "description": "The additional info." }, "type": { "type": "string", "description": "The additional info type." } }, "type": "object", "required": [ "info", "type" ] }, "azure-native:agfoodplatform:ErrorDetailResponse": { "description": "The error detail.", "properties": { "additionalInfo": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:ErrorAdditionalInfoResponse" }, "description": "The error additional info." }, "code": { "type": "string", "description": "The error code." }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:ErrorDetailResponse" }, "description": "The error details." }, "message": { "type": "string", "description": "The error message." }, "target": { "type": "string", "description": "The error target." } }, "type": "object", "required": [ "additionalInfo", "code", "details", "message", "target" ] }, "azure-native:agfoodplatform:ErrorResponseResponse": { "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).", "properties": { "error": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:ErrorDetailResponse", "description": "The error object." } }, "type": "object" }, "azure-native:agfoodplatform:Identity": { "description": "Identity for the resource.", "properties": { "type": { "$ref": "#/types/azure-native:agfoodplatform:ResourceIdentityType", "description": "The identity type." } }, "type": "object" }, "azure-native:agfoodplatform:IdentityResponse": { "description": "Identity for the resource.", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity. The value must be an UUID." }, "tenantId": { "type": "string", "description": "The tenant ID of resource. The value must be an UUID." }, "type": { "type": "string", "description": "The identity type." } }, "type": "object", "required": [ "principalId", "tenantId" ] }, "azure-native:agfoodplatform:KeyVaultProperties": { "description": "Properties of the key vault.", "properties": { "keyName": { "type": "string", "description": "Name of Key Vault key." }, "keyVaultUri": { "type": "string", "description": "Uri of the key vault." }, "keyVersion": { "type": "string", "description": "Version of Key Vault key." } }, "type": "object", "required": [ "keyName", "keyVaultUri", "keyVersion" ] }, "azure-native:agfoodplatform:KeyVaultPropertiesResponse": { "description": "Properties of the key vault.", "properties": { "keyName": { "type": "string", "description": "Name of Key Vault key." }, "keyVaultUri": { "type": "string", "description": "Uri of the key vault." }, "keyVersion": { "type": "string", "description": "Version of Key Vault key." } }, "type": "object", "required": [ "keyName", "keyVaultUri", "keyVersion" ] }, "azure-native:agfoodplatform:OAuthClientCredentials": { "description": "OAuthClientCredentials for clientId clientSecret auth.", "properties": { "clientId": { "type": "string", "description": "ClientId associated with the provider." }, "clientSecret": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:KeyVaultProperties", "description": "Properties of the key vault." }, "kind": { "type": "string", "description": "Enum for different types of AuthCredentials supported.\nExpected value is 'OAuthClientCredentials'.", "const": "OAuthClientCredentials" } }, "type": "object", "required": [ "clientId", "clientSecret", "kind" ] }, "azure-native:agfoodplatform:OAuthClientCredentialsResponse": { "description": "OAuthClientCredentials for clientId clientSecret auth.", "properties": { "clientId": { "type": "string", "description": "ClientId associated with the provider." }, "clientSecret": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:KeyVaultPropertiesResponse", "description": "Properties of the key vault." }, "kind": { "type": "string", "description": "Enum for different types of AuthCredentials supported.\nExpected value is 'OAuthClientCredentials'.", "const": "OAuthClientCredentials" } }, "type": "object", "required": [ "clientId", "clientSecret", "kind" ] }, "azure-native:agfoodplatform:PrivateEndpointConnectionResponse": { "description": "The private endpoint connection resource.", "properties": { "groupIds": { "type": "array", "items": { "type": "string" }, "description": "The group ids for the private endpoint resource." }, "id": { "type": "string", "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" }, "name": { "type": "string", "description": "The name of the resource" }, "privateEndpoint": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:PrivateEndpointResponse", "description": "The private endpoint resource." }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:PrivateLinkServiceConnectionStateResponse", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "type": "string", "description": "The provisioning state of the private endpoint connection resource." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "groupIds", "id", "name", "privateLinkServiceConnectionState", "provisioningState", "systemData", "type" ] }, "azure-native:agfoodplatform:PrivateEndpointResponse": { "description": "The private endpoint resource.", "properties": { "id": { "type": "string", "description": "The ARM identifier for private endpoint." } }, "type": "object", "required": [ "id" ] }, "azure-native:agfoodplatform:PrivateEndpointServiceConnectionStatus": { "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", "type": "string", "enum": [ { "value": "Pending" }, { "value": "Approved" }, { "value": "Rejected" } ] }, "azure-native:agfoodplatform:PrivateLinkServiceConnectionState": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:agfoodplatform:PrivateEndpointServiceConnectionStatus" } ], "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:agfoodplatform:PrivateLinkServiceConnectionStateResponse": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "type": "string", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:agfoodplatform:PublicNetworkAccess": { "description": "Property to allow or block public traffic for an Azure Data Manager For Agriculture resource.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:agfoodplatform:ResourceIdentityType": { "description": "The identity type.", "type": "string", "enum": [ { "value": "SystemAssigned" } ] }, "azure-native:agfoodplatform:SensorIntegration": { "description": "Sensor integration request model.", "properties": { "enabled": { "type": "string", "description": "Sensor integration enable state." } }, "type": "object" }, "azure-native:agfoodplatform:SensorIntegrationResponse": { "description": "Sensor integration request model.", "properties": { "enabled": { "type": "string", "description": "Sensor integration enable state." }, "provisioningInfo": { "type": "object", "$ref": "#/types/azure-native:agfoodplatform:ErrorResponseResponse", "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)." }, "provisioningState": { "type": "string", "description": "Sensor integration instance provisioning state." } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:agfoodplatform:SolutionProperties": { "description": "Solution resource properties.", "properties": { "marketplacePublisherId": { "type": "string", "description": "SaaS application Marketplace Publisher Id." }, "offerId": { "type": "string", "description": "SaaS application Offer Id." }, "planId": { "type": "string", "description": "SaaS application Plan Id." }, "roleAssignmentId": { "type": "string", "description": "Role Assignment Id." }, "saasSubscriptionId": { "type": "string", "description": "SaaS subscriptionId of the installed SaaS application." }, "saasSubscriptionName": { "type": "string", "description": "SaaS subscription name of the installed SaaS application." }, "termId": { "type": "string", "description": "SaaS application Term Id." } }, "type": "object", "required": [ "marketplacePublisherId", "offerId", "planId", "saasSubscriptionId", "saasSubscriptionName", "termId" ] }, "azure-native:agfoodplatform:SolutionPropertiesResponse": { "description": "Solution resource properties.", "properties": { "marketplacePublisherId": { "type": "string", "description": "SaaS application Marketplace Publisher Id." }, "offerId": { "type": "string", "description": "SaaS application Offer Id." }, "partnerId": { "type": "string", "description": "Partner Id of the Solution." }, "planId": { "type": "string", "description": "SaaS application Plan Id." }, "roleAssignmentId": { "type": "string", "description": "Role Assignment Id." }, "saasSubscriptionId": { "type": "string", "description": "SaaS subscriptionId of the installed SaaS application." }, "saasSubscriptionName": { "type": "string", "description": "SaaS subscription name of the installed SaaS application." }, "termId": { "type": "string", "description": "SaaS application Term Id." } }, "type": "object", "required": [ "marketplacePublisherId", "offerId", "partnerId", "planId", "saasSubscriptionId", "saasSubscriptionName", "termId" ] }, "azure-native:agfoodplatform:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:agricultureplatform:AgriServiceConfigResponse": { "description": "Config of the AgriService resource instance.", "properties": { "appServiceResourceId": { "type": "string", "description": "App service resource Id." }, "cosmosDbResourceId": { "type": "string", "description": "Cosmos Db resource Id." }, "instanceUri": { "type": "string", "description": "Instance URI of the AgriService instance." }, "keyVaultResourceId": { "type": "string", "description": "Key vault resource Id." }, "redisCacheResourceId": { "type": "string", "description": "Redis cache resource Id." }, "storageAccountResourceId": { "type": "string", "description": "Storage account resource Id." }, "version": { "type": "string", "description": "Version of AgriService instance." } }, "type": "object", "required": [ "appServiceResourceId", "cosmosDbResourceId", "instanceUri", "keyVaultResourceId", "redisCacheResourceId", "storageAccountResourceId", "version" ] }, "azure-native:agricultureplatform:AgriServiceResourceProperties": { "description": "Details of the Agriculture AgriDataManager.", "properties": { "dataConnectorCredentials": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:DataConnectorCredentialMap" }, "description": "Data connector credentials of AgriService instance." }, "installedSolutions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:InstalledSolutionMap" }, "description": "AgriService installed solutions." } }, "type": "object" }, "azure-native:agricultureplatform:AgriServiceResourcePropertiesResponse": { "description": "Details of the Agriculture AgriDataManager.", "properties": { "config": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:AgriServiceConfigResponse", "description": "Config of the AgriService instance." }, "dataConnectorCredentials": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:DataConnectorCredentialMapResponse" }, "description": "Data connector credentials of AgriService instance." }, "installedSolutions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:InstalledSolutionMapResponse" }, "description": "AgriService installed solutions." }, "managedOnBehalfOfConfiguration": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:ManagedOnBehalfOfConfigurationResponse", "description": "Managed On Behalf Of Configuration." }, "provisioningState": { "type": "string", "description": "The status of the last operation." } }, "type": "object", "required": [ "managedOnBehalfOfConfiguration", "provisioningState" ] }, "azure-native:agricultureplatform:AuthCredentialsKind": { "description": "Type of credential.", "type": "string", "enum": [ { "name": "OAuthClientCredentials", "description": "OAuth Client Credential type", "value": "OAuthClientCredentials" }, { "name": "ApiKeyAuthCredentials", "description": "API Key Auth Credential type", "value": "ApiKeyAuthCredentials" } ] }, "azure-native:agricultureplatform:DataConnectorCredentialMap": { "description": "Mapping of data connector credentials.", "properties": { "key": { "type": "string", "description": "The key representing the credential." }, "value": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:DataConnectorCredentials", "description": "The data connector credential value." } }, "type": "object", "required": [ "key", "value" ] }, "azure-native:agricultureplatform:DataConnectorCredentialMapResponse": { "description": "Mapping of data connector credentials.", "properties": { "key": { "type": "string", "description": "The key representing the credential." }, "value": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:DataConnectorCredentialsResponse", "description": "The data connector credential value." } }, "type": "object", "required": [ "key", "value" ] }, "azure-native:agricultureplatform:DataConnectorCredentials": { "description": "The properties related to an AgriService data connector.", "properties": { "clientId": { "type": "string", "description": "Client Id associated with the provider, if type of credentials is OAuthClientCredentials." }, "keyName": { "type": "string", "description": "Name of the key vault key." }, "keyVaultUri": { "type": "string", "description": "Uri of the key vault" }, "keyVersion": { "type": "string", "description": "Version of the key vault key." }, "kind": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:agricultureplatform:AuthCredentialsKind" } ], "description": "Type of credential." } }, "type": "object" }, "azure-native:agricultureplatform:DataConnectorCredentialsResponse": { "description": "The properties related to an AgriService data connector.", "properties": { "clientId": { "type": "string", "description": "Client Id associated with the provider, if type of credentials is OAuthClientCredentials." }, "keyName": { "type": "string", "description": "Name of the key vault key." }, "keyVaultUri": { "type": "string", "description": "Uri of the key vault" }, "keyVersion": { "type": "string", "description": "Version of the key vault key." }, "kind": { "type": "string", "description": "Type of credential." } }, "type": "object" }, "azure-native:agricultureplatform:DataManagerForAgricultureSolutionResponse": { "description": "Data Manager for Agriculture solution.", "properties": { "accessAzureDataManagerForAgricultureApplicationId": { "type": "string", "description": "Entra application Id used to access azure data manager for agriculture instance." }, "accessAzureDataManagerForAgricultureApplicationName": { "type": "string", "description": "Entra application name used to access azure data manager for agriculture instance." }, "dataAccessScopes": { "type": "array", "items": { "type": "string" }, "description": "Data access scopes." }, "isValidateInput": { "type": "boolean", "description": "Whether solution inference will validate input." }, "marketPlaceOfferDetails": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:MarketPlaceOfferDetailsResponse", "description": "Marketplace offer details." }, "partnerId": { "type": "string", "description": "Partner Id." }, "partnerTenantId": { "type": "string", "description": "Partner tenant Id." }, "saasApplicationId": { "type": "string", "description": "Saas application Id." }, "solutionId": { "type": "string", "description": "Solution Id." } }, "type": "object", "required": [ "accessAzureDataManagerForAgricultureApplicationId", "accessAzureDataManagerForAgricultureApplicationName", "dataAccessScopes", "isValidateInput", "marketPlaceOfferDetails", "partnerId", "partnerTenantId", "saasApplicationId", "solutionId" ] }, "azure-native:agricultureplatform:InstalledSolutionMap": { "description": "Mapping of installed solutions.", "properties": { "key": { "type": "string", "description": "The key representing the installed solution." }, "value": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:Solution", "description": "The installed solution value." } }, "type": "object", "required": [ "key", "value" ] }, "azure-native:agricultureplatform:InstalledSolutionMapResponse": { "description": "Mapping of installed solutions.", "properties": { "key": { "type": "string", "description": "The key representing the installed solution." }, "value": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:SolutionResponse", "description": "The installed solution value." } }, "type": "object", "required": [ "key", "value" ] }, "azure-native:agricultureplatform:ManagedOnBehalfOfConfigurationResponse": { "description": "Configuration of the managed on behalf of resource.", "properties": { "moboBrokerResources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:MoboBrokerResourceResponse" }, "description": "Associated MoboBrokerResources." } }, "type": "object", "required": [ "moboBrokerResources" ] }, "azure-native:agricultureplatform:ManagedServiceIdentity": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:agricultureplatform:ManagedServiceIdentityType" } ], "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "type" ] }, "azure-native:agricultureplatform:ManagedServiceIdentityResponse": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "principalId": { "type": "string", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "type": "string", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:agricultureplatform:UserAssignedIdentityResponse" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:agricultureplatform:ManagedServiceIdentityType": { "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned,UserAssigned" } ] }, "azure-native:agricultureplatform:MarketPlaceOfferDetailsResponse": { "description": "Marketplace offer details of Agri solution.", "properties": { "publisherId": { "type": "string", "description": "Publisher Id." }, "saasOfferId": { "type": "string", "description": "Saas offer Id." } }, "type": "object", "required": [ "publisherId", "saasOfferId" ] }, "azure-native:agricultureplatform:MoboBrokerResourceResponse": { "description": "MoboBroker resource.", "properties": { "id": { "type": "string", "description": "The fully qualified resource ID of the MoboBroker resource.\nExample: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}`" } }, "type": "object", "required": [ "id" ] }, "azure-native:agricultureplatform:Sku": { "description": "The resource model definition representing SKU", "properties": { "capacity": { "type": "integer", "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." }, "family": { "type": "string", "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." }, "name": { "type": "string", "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" }, "size": { "type": "string", "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " }, "tier": { "$ref": "#/types/azure-native:agricultureplatform:SkuTier", "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." } }, "type": "object", "required": [ "name" ] }, "azure-native:agricultureplatform:SkuResponse": { "description": "The resource model definition representing SKU", "properties": { "capacity": { "type": "integer", "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." }, "family": { "type": "string", "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." }, "name": { "type": "string", "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" }, "size": { "type": "string", "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " }, "tier": { "type": "string", "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." } }, "type": "object", "required": [ "name" ] }, "azure-native:agricultureplatform:SkuTier": { "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", "type": "string", "enum": [ { "value": "Free" }, { "value": "Basic" }, { "value": "Standard" }, { "value": "Premium" } ] }, "azure-native:agricultureplatform:Solution": { "description": "Installed data manager for Agriculture solution detail.", "properties": { "applicationName": { "type": "string", "description": "Application name of the solution." }, "marketPlacePublisherId": { "type": "string", "description": "Marketplace publisher Id." }, "partnerId": { "type": "string", "description": "Partner Id." }, "planId": { "type": "string", "description": "Plan Id." }, "saasSubscriptionId": { "type": "string", "description": "Saas subscription Id." }, "saasSubscriptionName": { "type": "string", "description": "Saas subscription name." } }, "type": "object" }, "azure-native:agricultureplatform:SolutionResponse": { "description": "Installed data manager for Agriculture solution detail.", "properties": { "applicationName": { "type": "string", "description": "Application name of the solution." }, "marketPlacePublisherId": { "type": "string", "description": "Marketplace publisher Id." }, "partnerId": { "type": "string", "description": "Partner Id." }, "planId": { "type": "string", "description": "Plan Id." }, "saasSubscriptionId": { "type": "string", "description": "Saas subscription Id." }, "saasSubscriptionName": { "type": "string", "description": "Saas subscription name." } }, "type": "object" }, "azure-native:agricultureplatform:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:agricultureplatform:UserAssignedIdentityResponse": { "description": "User assigned identity properties", "properties": { "clientId": { "type": "string", "description": "The client ID of the assigned identity." }, "principalId": { "type": "string", "description": "The principal ID of the assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:alertsmanagement:ActionGroup": { "description": "Action rule with action group configuration", "properties": { "actionGroupId": { "type": "string", "description": "Action group to trigger if action rule matches" }, "conditions": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Conditions", "description": "conditions on which alerts will be filtered" }, "description": { "type": "string", "description": "Description of action rule" }, "scope": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Scope", "description": "scope on which action rule will apply" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:ActionRuleStatus" } ], "description": "Indicates if the given action rule is enabled or disabled" }, "type": { "type": "string", "description": "Indicates type of action rule\nExpected value is 'ActionGroup'.", "const": "ActionGroup" } }, "type": "object", "required": [ "actionGroupId", "type" ] }, "azure-native:alertsmanagement:ActionGroupResponse": { "description": "Action rule with action group configuration", "properties": { "actionGroupId": { "type": "string", "description": "Action group to trigger if action rule matches" }, "conditions": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionsResponse", "description": "conditions on which alerts will be filtered" }, "createdAt": { "type": "string", "description": "Creation time of action rule. Date-Time in ISO-8601 format." }, "createdBy": { "type": "string", "description": "Created by user name." }, "description": { "type": "string", "description": "Description of action rule" }, "lastModifiedAt": { "type": "string", "description": "Last updated time of action rule. Date-Time in ISO-8601 format." }, "lastModifiedBy": { "type": "string", "description": "Last modified by user name." }, "scope": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ScopeResponse", "description": "scope on which action rule will apply" }, "status": { "type": "string", "description": "Indicates if the given action rule is enabled or disabled" }, "type": { "type": "string", "description": "Indicates type of action rule\nExpected value is 'ActionGroup'.", "const": "ActionGroup" } }, "type": "object", "required": [ "actionGroupId", "createdAt", "createdBy", "lastModifiedAt", "lastModifiedBy", "type" ] }, "azure-native:alertsmanagement:ActionGroupsInformation": { "description": "The Action Groups information, used by the alert rule.", "properties": { "customEmailSubject": { "type": "string", "description": "An optional custom email subject to use in email notifications." }, "customWebhookPayload": { "type": "string", "description": "An optional custom web-hook payload to use in web-hook notifications." }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "The Action Group resource IDs." } }, "type": "object", "required": [ "groupIds" ] }, "azure-native:alertsmanagement:ActionGroupsInformationResponse": { "description": "The Action Groups information, used by the alert rule.", "properties": { "customEmailSubject": { "type": "string", "description": "An optional custom email subject to use in email notifications." }, "customWebhookPayload": { "type": "string", "description": "An optional custom web-hook payload to use in web-hook notifications." }, "groupIds": { "type": "array", "items": { "type": "string" }, "description": "The Action Group resource IDs." } }, "type": "object", "required": [ "groupIds" ] }, "azure-native:alertsmanagement:ActionRuleStatus": { "description": "Indicates if the given action rule is enabled or disabled", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:alertsmanagement:ActionRuleType": { "description": "Indicates type of action rule", "type": "string", "enum": [ { "value": "Suppression" }, { "value": "ActionGroup" }, { "value": "Diagnostics" } ] }, "azure-native:alertsmanagement:ActionType": { "description": "Action that should be applied.", "type": "string", "enum": [ { "name": "AddActionGroups", "description": "AddActionGroups", "value": "AddActionGroups" }, { "name": "RemoveAllActionGroups", "description": "RemoveAllActionGroups", "value": "RemoveAllActionGroups" } ] }, "azure-native:alertsmanagement:AddActionGroups": { "description": "Add action groups to alert processing rule.", "properties": { "actionGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of action group Ids to add to alert processing rule." }, "actionType": { "type": "string", "description": "Action that should be applied.\nExpected value is 'AddActionGroups'.", "const": "AddActionGroups" } }, "type": "object", "required": [ "actionGroupIds", "actionType" ] }, "azure-native:alertsmanagement:AddActionGroupsResponse": { "description": "Add action groups to alert processing rule.", "properties": { "actionGroupIds": { "type": "array", "items": { "type": "string" }, "description": "List of action group Ids to add to alert processing rule." }, "actionType": { "type": "string", "description": "Action that should be applied.\nExpected value is 'AddActionGroups'.", "const": "AddActionGroups" } }, "type": "object", "required": [ "actionGroupIds", "actionType" ] }, "azure-native:alertsmanagement:AlertProcessingRuleProperties": { "description": "Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.", "properties": { "actions": { "type": "array", "items": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:AddActionGroups" }, { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:RemoveAllActionGroups" } ], "discriminator": { "propertyName": "actionType", "mapping": { "AddActionGroups": "#/types/azure-native:alertsmanagement:AddActionGroups", "RemoveAllActionGroups": "#/types/azure-native:alertsmanagement:RemoveAllActionGroups" } } }, "description": "Actions to be applied." }, "conditions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition" }, "description": "Conditions on which alerts will be filtered." }, "description": { "type": "string", "description": "Actions to be applied.Description of alert processing rule." }, "enabled": { "type": "boolean", "description": "Indicates if the given alert processing rule is enabled or disabled.", "default": true }, "schedule": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Schedule", "description": "Scheduling for alert processing rule." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Scopes on which alert processing rule will apply." } }, "type": "object", "required": [ "actions", "scopes" ] }, "azure-native:alertsmanagement:AlertProcessingRulePropertiesResponse": { "description": "Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule.", "properties": { "actions": { "type": "array", "items": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:AddActionGroupsResponse" }, { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:RemoveAllActionGroupsResponse" } ], "discriminator": { "propertyName": "actionType", "mapping": { "AddActionGroups": "#/types/azure-native:alertsmanagement:AddActionGroupsResponse", "RemoveAllActionGroups": "#/types/azure-native:alertsmanagement:RemoveAllActionGroupsResponse" } } }, "description": "Actions to be applied." }, "conditions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponseV1" }, "description": "Conditions on which alerts will be filtered." }, "description": { "type": "string", "description": "Actions to be applied.Description of alert processing rule." }, "enabled": { "type": "boolean", "description": "Indicates if the given alert processing rule is enabled or disabled.", "default": true }, "schedule": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ScheduleResponse", "description": "Scheduling for alert processing rule." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Scopes on which alert processing rule will apply." } }, "type": "object", "required": [ "actions", "scopes" ] }, "azure-native:alertsmanagement:AlertRuleState": { "description": "The alert rule state.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:alertsmanagement:Condition": { "description": "Condition to trigger an alert processing rule.", "properties": { "field": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:Field" } ], "description": "Field for a given condition." }, "operator": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:Operator" } ], "description": "Operator for a given condition." }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of values to match for a given condition." } }, "type": "object" }, "azure-native:alertsmanagement:ConditionResponse": { "description": "condition to trigger an action rule", "properties": { "operator": { "type": "string", "description": "operator for a given condition" }, "values": { "type": "array", "items": { "type": "string" }, "description": "list of values to match for a given condition." } }, "type": "object" }, "azure-native:alertsmanagement:ConditionResponseV1": { "description": "Condition to trigger an alert processing rule.", "properties": { "field": { "type": "string", "description": "Field for a given condition." }, "operator": { "type": "string", "description": "Operator for a given condition." }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of values to match for a given condition." } }, "type": "object" }, "azure-native:alertsmanagement:Conditions": { "description": "Conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation.", "properties": { "alertContext": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by alert context (payload)" }, "alertRuleId": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by alert rule id" }, "alertRuleName": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by alert rule name" }, "description": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by alert rule description" }, "monitorCondition": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by monitor condition" }, "monitorService": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by monitor service" }, "severity": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by severity" }, "targetResourceType": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Condition", "description": "filter alerts by target resource type" } }, "type": "object" }, "azure-native:alertsmanagement:ConditionsResponse": { "description": "Conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation.", "properties": { "alertContext": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by alert context (payload)" }, "alertRuleId": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by alert rule id" }, "alertRuleName": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by alert rule name" }, "description": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by alert rule description" }, "monitorCondition": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by monitor condition" }, "monitorService": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by monitor service" }, "severity": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by severity" }, "targetResourceType": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionResponse", "description": "filter alerts by target resource type" } }, "type": "object" }, "azure-native:alertsmanagement:DailyRecurrence": { "description": "Daily recurrence object.", "properties": { "endTime": { "type": "string", "description": "End time for recurrence." }, "recurrenceType": { "type": "string", "description": "Specifies when the recurrence should be applied.\nExpected value is 'Daily'.", "const": "Daily" }, "startTime": { "type": "string", "description": "Start time for recurrence." } }, "type": "object", "required": [ "recurrenceType" ] }, "azure-native:alertsmanagement:DailyRecurrenceResponse": { "description": "Daily recurrence object.", "properties": { "endTime": { "type": "string", "description": "End time for recurrence." }, "recurrenceType": { "type": "string", "description": "Specifies when the recurrence should be applied.\nExpected value is 'Daily'.", "const": "Daily" }, "startTime": { "type": "string", "description": "Start time for recurrence." } }, "type": "object", "required": [ "recurrenceType" ] }, "azure-native:alertsmanagement:DaysOfWeek": { "description": "Days of week.", "type": "string", "enum": [ { "name": "Sunday", "description": "Sunday", "value": "Sunday" }, { "name": "Monday", "description": "Monday", "value": "Monday" }, { "name": "Tuesday", "description": "Tuesday", "value": "Tuesday" }, { "name": "Wednesday", "description": "Wednesday", "value": "Wednesday" }, { "name": "Thursday", "description": "Thursday", "value": "Thursday" }, { "name": "Friday", "description": "Friday", "value": "Friday" }, { "name": "Saturday", "description": "Saturday", "value": "Saturday" } ] }, "azure-native:alertsmanagement:Detector": { "description": "The detector information. By default this is not populated, unless it's specified in expandDetector", "properties": { "id": { "type": "string", "description": "The detector id." }, "parameters": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "The detector's parameters.'" } }, "type": "object", "required": [ "id" ] }, "azure-native:alertsmanagement:DetectorParameterDefinitionResponse": { "description": "The detector parameter definition.", "properties": { "description": { "type": "string", "description": "The detector parameter description." }, "displayName": { "type": "string", "description": "The detector parameter display name." }, "isMandatory": { "type": "boolean", "description": "A value indicating whether this detector parameter is mandatory." }, "name": { "type": "string", "description": "The detector parameter name." }, "type": { "type": "string", "description": "The detector parameter type." } }, "type": "object" }, "azure-native:alertsmanagement:DetectorResponse": { "description": "The detector information. By default this is not populated, unless it's specified in expandDetector", "properties": { "description": { "type": "string", "description": "The Smart Detector description." }, "id": { "type": "string", "description": "The detector id." }, "imagePaths": { "type": "array", "items": { "type": "string" }, "description": "The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector" }, "name": { "type": "string", "description": "The Smart Detector name." }, "parameterDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:DetectorParameterDefinitionResponse" }, "description": "The Smart Detector parameters definitions.'" }, "parameters": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "The detector's parameters.'" }, "supportedCadences": { "type": "array", "items": { "type": "integer" }, "description": "The Smart Detector supported cadences." }, "supportedResourceTypes": { "type": "array", "items": { "type": "string" }, "description": "The Smart Detector supported resource types." } }, "type": "object", "required": [ "description", "id", "imagePaths", "name", "parameterDefinitions", "supportedCadences", "supportedResourceTypes" ] }, "azure-native:alertsmanagement:Diagnostics": { "description": "Action rule with diagnostics configuration", "properties": { "conditions": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Conditions", "description": "conditions on which alerts will be filtered" }, "description": { "type": "string", "description": "Description of action rule" }, "scope": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Scope", "description": "scope on which action rule will apply" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:ActionRuleStatus" } ], "description": "Indicates if the given action rule is enabled or disabled" }, "type": { "type": "string", "description": "Indicates type of action rule\nExpected value is 'Diagnostics'.", "const": "Diagnostics" } }, "type": "object", "required": [ "type" ] }, "azure-native:alertsmanagement:DiagnosticsResponse": { "description": "Action rule with diagnostics configuration", "properties": { "conditions": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionsResponse", "description": "conditions on which alerts will be filtered" }, "createdAt": { "type": "string", "description": "Creation time of action rule. Date-Time in ISO-8601 format." }, "createdBy": { "type": "string", "description": "Created by user name." }, "description": { "type": "string", "description": "Description of action rule" }, "lastModifiedAt": { "type": "string", "description": "Last updated time of action rule. Date-Time in ISO-8601 format." }, "lastModifiedBy": { "type": "string", "description": "Last modified by user name." }, "scope": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ScopeResponse", "description": "scope on which action rule will apply" }, "status": { "type": "string", "description": "Indicates if the given action rule is enabled or disabled" }, "type": { "type": "string", "description": "Indicates type of action rule\nExpected value is 'Diagnostics'.", "const": "Diagnostics" } }, "type": "object", "required": [ "createdAt", "createdBy", "lastModifiedAt", "lastModifiedBy", "type" ] }, "azure-native:alertsmanagement:Field": { "description": "Field for a given condition.", "type": "string", "enum": [ { "name": "Severity", "description": "Severity", "value": "Severity" }, { "name": "MonitorService", "description": "MonitorService", "value": "MonitorService" }, { "name": "MonitorCondition", "description": "MonitorCondition", "value": "MonitorCondition" }, { "name": "SignalType", "description": "SignalType", "value": "SignalType" }, { "name": "TargetResourceType", "description": "TargetResourceType", "value": "TargetResourceType" }, { "name": "TargetResource", "description": "TargetResource", "value": "TargetResource" }, { "name": "TargetResourceGroup", "description": "TargetResourceGroup", "value": "TargetResourceGroup" }, { "name": "AlertRuleId", "description": "AlertRuleId", "value": "AlertRuleId" }, { "name": "AlertRuleName", "description": "AlertRuleName", "value": "AlertRuleName" }, { "name": "Description", "description": "Description", "value": "Description" }, { "name": "AlertContext", "description": "AlertContext", "value": "AlertContext" } ] }, "azure-native:alertsmanagement:InvestigationExecutionResponse": { "description": "Details about the execution of the investigation", "properties": { "completedAt": { "type": "string", "description": "The time at which the investigation execution completed (in UTC)" }, "runState": { "type": "string", "description": "The state of the investigation execution" } }, "type": "object", "required": [ "completedAt", "runState" ] }, "azure-native:alertsmanagement:InvestigationMetadataResponse": { "description": "Properties of the current investigation", "properties": { "createdAt": { "type": "string", "description": "The creation time of the investigation (in UTC)" }, "execution": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:InvestigationExecutionResponse", "description": "The execution details of the investigation" }, "id": { "type": "string", "description": "The unique identifier of the investigation" }, "runParameters": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:RunParametersResponse", "description": "The parameters that were used to start the investigation" } }, "type": "object", "required": [ "createdAt", "execution", "id", "runParameters" ] }, "azure-native:alertsmanagement:InvestigationScopeResponse": { "description": "A single scope of the investigation", "properties": { "id": { "type": "string", "description": "The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID" }, "origin": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:OriginResponse", "description": "The origin of the scope" }, "relevance": { "type": "string", "description": "The relevance of the scope" } }, "type": "object", "required": [ "id", "origin" ] }, "azure-native:alertsmanagement:IssueProperties": { "description": "The issue properties", "properties": { "impactTime": { "type": "string", "description": "The issue impact time (in UTC)" }, "severity": { "type": "string", "description": "The issue severity" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:Status" } ], "description": "The issue status" }, "title": { "type": "string", "description": "The issue title" } }, "type": "object", "required": [ "impactTime", "severity", "status", "title" ] }, "azure-native:alertsmanagement:IssuePropertiesResponse": { "description": "The issue properties", "properties": { "impactTime": { "type": "string", "description": "The issue impact time (in UTC)" }, "investigations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:InvestigationMetadataResponse" }, "description": "The list of investigations in the issue" }, "investigationsCount": { "type": "integer", "description": "The number of investigations in the issue" }, "provisioningState": { "type": "string", "description": "The provisioning state of the resource." }, "severity": { "type": "string", "description": "The issue severity" }, "status": { "type": "string", "description": "The issue status" }, "title": { "type": "string", "description": "The issue title" } }, "type": "object", "required": [ "impactTime", "investigations", "investigationsCount", "provisioningState", "severity", "status", "title" ] }, "azure-native:alertsmanagement:MonthlyRecurrence": { "description": "Monthly recurrence object.", "properties": { "daysOfMonth": { "type": "array", "items": { "type": "integer" }, "description": "Specifies the values for monthly recurrence pattern." }, "endTime": { "type": "string", "description": "End time for recurrence." }, "recurrenceType": { "type": "string", "description": "Specifies when the recurrence should be applied.\nExpected value is 'Monthly'.", "const": "Monthly" }, "startTime": { "type": "string", "description": "Start time for recurrence." } }, "type": "object", "required": [ "daysOfMonth", "recurrenceType" ] }, "azure-native:alertsmanagement:MonthlyRecurrenceResponse": { "description": "Monthly recurrence object.", "properties": { "daysOfMonth": { "type": "array", "items": { "type": "integer" }, "description": "Specifies the values for monthly recurrence pattern." }, "endTime": { "type": "string", "description": "End time for recurrence." }, "recurrenceType": { "type": "string", "description": "Specifies when the recurrence should be applied.\nExpected value is 'Monthly'.", "const": "Monthly" }, "startTime": { "type": "string", "description": "Start time for recurrence." } }, "type": "object", "required": [ "daysOfMonth", "recurrenceType" ] }, "azure-native:alertsmanagement:Operator": { "description": "Operator for a given condition.", "type": "string", "enum": [ { "name": "Equals", "description": "Equals", "value": "Equals" }, { "name": "NotEquals", "description": "NotEquals", "value": "NotEquals" }, { "name": "Contains", "description": "Contains", "value": "Contains" }, { "name": "DoesNotContain", "description": "DoesNotContain", "value": "DoesNotContain" } ] }, "azure-native:alertsmanagement:OriginResponse": { "description": "Details about the origin of the entity - the source that added it to the issue", "properties": { "addedBy": { "type": "string", "description": "The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system" }, "addedByType": { "type": "string", "description": "The source of the origin - Manual or Automatic" } }, "type": "object", "required": [ "addedBy", "addedByType" ] }, "azure-native:alertsmanagement:PrometheusRule": { "description": "An Azure Prometheus alerting or recording rule.", "properties": { "actions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:PrometheusRuleGroupAction" }, "description": "Actions that are performed when the alert rule becomes active, and when an alert condition is resolved." }, "alert": { "type": "string", "description": "Alert rule name." }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated." }, "enabled": { "type": "boolean", "description": "Enable/disable rule." }, "expression": { "type": "string", "description": "The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'." }, "for": { "type": "string", "description": "The amount of time alert must be active before firing." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels to add or overwrite before storing the result." }, "record": { "type": "string", "description": "Recorded metrics name." }, "resolveConfiguration": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:PrometheusRuleResolveConfiguration", "description": "Defines the configuration for resolving fired alerts. Only relevant for alerts." }, "severity": { "type": "integer", "description": "The severity of the alerts fired by the rule. Must be between 0 and 4." } }, "type": "object", "required": [ "expression" ] }, "azure-native:alertsmanagement:PrometheusRuleGroupAction": { "description": "An alert action. Only relevant for alerts.", "properties": { "actionGroupId": { "type": "string", "description": "The resource id of the action group to use." }, "actionProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The properties of an action group object." } }, "type": "object" }, "azure-native:alertsmanagement:PrometheusRuleGroupActionResponse": { "description": "An alert action. Only relevant for alerts.", "properties": { "actionGroupId": { "type": "string", "description": "The resource id of the action group to use." }, "actionProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The properties of an action group object." } }, "type": "object" }, "azure-native:alertsmanagement:PrometheusRuleResolveConfiguration": { "description": "Specifies the Prometheus alert rule configuration.", "properties": { "autoResolved": { "type": "boolean", "description": "Enable alert auto-resolution." }, "timeToResolve": { "type": "string", "description": "Alert auto-resolution timeout." } }, "type": "object" }, "azure-native:alertsmanagement:PrometheusRuleResolveConfigurationResponse": { "description": "Specifies the Prometheus alert rule configuration.", "properties": { "autoResolved": { "type": "boolean", "description": "Enable alert auto-resolution." }, "timeToResolve": { "type": "string", "description": "Alert auto-resolution timeout." } }, "type": "object" }, "azure-native:alertsmanagement:PrometheusRuleResponse": { "description": "An Azure Prometheus alerting or recording rule.", "properties": { "actions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:PrometheusRuleGroupActionResponse" }, "description": "Actions that are performed when the alert rule becomes active, and when an alert condition is resolved." }, "alert": { "type": "string", "description": "Alert rule name." }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated." }, "enabled": { "type": "boolean", "description": "Enable/disable rule." }, "expression": { "type": "string", "description": "The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'." }, "for": { "type": "string", "description": "The amount of time alert must be active before firing." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Labels to add or overwrite before storing the result." }, "record": { "type": "string", "description": "Recorded metrics name." }, "resolveConfiguration": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:PrometheusRuleResolveConfigurationResponse", "description": "Defines the configuration for resolving fired alerts. Only relevant for alerts." }, "severity": { "type": "integer", "description": "The severity of the alerts fired by the rule. Must be between 0 and 4." } }, "type": "object", "required": [ "expression" ] }, "azure-native:alertsmanagement:RecurrenceType": { "description": "Specifies when the recurrence should be applied.", "type": "string", "enum": [ { "name": "Daily", "description": "Daily", "value": "Daily" }, { "name": "Weekly", "description": "Weekly", "value": "Weekly" }, { "name": "Monthly", "description": "Monthly", "value": "Monthly" } ] }, "azure-native:alertsmanagement:RelatedAlertResponse": { "description": "Properties of an alert which is related to the issue", "properties": { "addedAt": { "type": "string", "description": "The time this relation was added to the issue (in UTC)" }, "id": { "type": "string", "description": "The alert ID" }, "lastModifiedAt": { "type": "string", "description": "The last update time of this relation (in UTC)" }, "origin": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:OriginResponse", "description": "The source that related the alert to the issue" }, "relevance": { "type": "string", "description": "The alerts's relevance status" } }, "type": "object", "required": [ "addedAt", "id", "lastModifiedAt", "origin", "relevance" ] }, "azure-native:alertsmanagement:RelatedResourceResponse": { "description": "Properties of a resource which is related to the issue", "properties": { "addedAt": { "type": "string", "description": "The time this relation was added to the issue (in UTC)" }, "id": { "type": "string", "description": "The resource ID" }, "lastModifiedAt": { "type": "string", "description": "The last update time of this relation (in UTC)" }, "origin": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:OriginResponse", "description": "The source that related the resource to the issue" }, "relevance": { "type": "string", "description": "The resource's relevance status" } }, "type": "object", "required": [ "addedAt", "id", "lastModifiedAt", "origin", "relevance" ] }, "azure-native:alertsmanagement:RemoveAllActionGroups": { "description": "Indicates if all action groups should be removed.", "properties": { "actionType": { "type": "string", "description": "Action that should be applied.\nExpected value is 'RemoveAllActionGroups'.", "const": "RemoveAllActionGroups" } }, "type": "object", "required": [ "actionType" ] }, "azure-native:alertsmanagement:RemoveAllActionGroupsResponse": { "description": "Indicates if all action groups should be removed.", "properties": { "actionType": { "type": "string", "description": "Action that should be applied.\nExpected value is 'RemoveAllActionGroups'.", "const": "RemoveAllActionGroups" } }, "type": "object", "required": [ "actionType" ] }, "azure-native:alertsmanagement:RunParametersResponse": { "description": "The parameters used to run the investigation", "properties": { "alerts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:InvestigationScopeResponse" }, "description": "The alerts used to run the investigation" }, "impactTime": { "type": "string", "description": "The impact time to investigate (in UTC)" }, "resources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:InvestigationScopeResponse" }, "description": "The resources used to run the investigation" } }, "type": "object", "required": [ "alerts", "impactTime", "resources" ] }, "azure-native:alertsmanagement:Schedule": { "description": "Scheduling configuration for a given alert processing rule.", "properties": { "effectiveFrom": { "type": "string", "description": "Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix." }, "effectiveUntil": { "type": "string", "description": "Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix." }, "recurrences": { "type": "array", "items": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:DailyRecurrence" }, { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:MonthlyRecurrence" }, { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:WeeklyRecurrence" } ], "discriminator": { "propertyName": "recurrenceType", "mapping": { "Daily": "#/types/azure-native:alertsmanagement:DailyRecurrence", "Monthly": "#/types/azure-native:alertsmanagement:MonthlyRecurrence", "Weekly": "#/types/azure-native:alertsmanagement:WeeklyRecurrence" } } }, "description": "List of recurrences." }, "timeZone": { "type": "string", "description": "Scheduling time zone." } }, "type": "object" }, "azure-native:alertsmanagement:ScheduleResponse": { "description": "Scheduling configuration for a given alert processing rule.", "properties": { "effectiveFrom": { "type": "string", "description": "Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix." }, "effectiveUntil": { "type": "string", "description": "Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix." }, "recurrences": { "type": "array", "items": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:DailyRecurrenceResponse" }, { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:MonthlyRecurrenceResponse" }, { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:WeeklyRecurrenceResponse" } ], "discriminator": { "propertyName": "recurrenceType", "mapping": { "Daily": "#/types/azure-native:alertsmanagement:DailyRecurrenceResponse", "Monthly": "#/types/azure-native:alertsmanagement:MonthlyRecurrenceResponse", "Weekly": "#/types/azure-native:alertsmanagement:WeeklyRecurrenceResponse" } } }, "description": "List of recurrences." }, "timeZone": { "type": "string", "description": "Scheduling time zone." } }, "type": "object" }, "azure-native:alertsmanagement:Scope": { "description": "Target scope for a given action rule. By default scope will be the subscription. User can also provide list of resource groups or list of resources from the scope subscription as well.", "properties": { "scopeType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:ScopeType" } ], "description": "type of target scope" }, "values": { "type": "array", "items": { "type": "string" }, "description": "list of ARM IDs of the given scope type which will be the target of the given action rule." } }, "type": "object" }, "azure-native:alertsmanagement:ScopeResponse": { "description": "Target scope for a given action rule. By default scope will be the subscription. User can also provide list of resource groups or list of resources from the scope subscription as well.", "properties": { "scopeType": { "type": "string", "description": "type of target scope" }, "values": { "type": "array", "items": { "type": "string" }, "description": "list of ARM IDs of the given scope type which will be the target of the given action rule." } }, "type": "object" }, "azure-native:alertsmanagement:ScopeType": { "description": "type of target scope", "type": "string", "enum": [ { "value": "ResourceGroup" }, { "value": "Resource" }, { "value": "Subscription" } ] }, "azure-native:alertsmanagement:Severity": { "description": "The alert rule severity.", "type": "string", "enum": [ { "value": "Sev0" }, { "value": "Sev1" }, { "value": "Sev2" }, { "value": "Sev3" }, { "value": "Sev4" } ] }, "azure-native:alertsmanagement:Status": { "description": "The issue status", "type": "string", "enum": [ { "name": "New", "description": "The issue is new", "value": "New" }, { "name": "InProgress", "description": "The issue is in progress", "value": "InProgress" }, { "name": "Mitigated", "description": "The issue is mitigated", "value": "Mitigated" }, { "name": "Closed", "description": "The issue is closed", "value": "Closed" }, { "name": "Canceled", "description": "The issue is canceled", "value": "Canceled" } ] }, "azure-native:alertsmanagement:Suppression": { "description": "Action rule with suppression configuration", "properties": { "conditions": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Conditions", "description": "conditions on which alerts will be filtered" }, "description": { "type": "string", "description": "Description of action rule" }, "scope": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:Scope", "description": "scope on which action rule will apply" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:ActionRuleStatus" } ], "description": "Indicates if the given action rule is enabled or disabled" }, "suppressionConfig": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:SuppressionConfig", "description": "suppression configuration for the action rule" }, "type": { "type": "string", "description": "Indicates type of action rule\nExpected value is 'Suppression'.", "const": "Suppression" } }, "type": "object", "required": [ "suppressionConfig", "type" ] }, "azure-native:alertsmanagement:SuppressionConfig": { "description": "Suppression logic for a given action rule", "properties": { "recurrenceType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:SuppressionType" } ], "description": "Specifies when the suppression should be applied" }, "schedule": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:SuppressionSchedule", "description": "suppression schedule configuration" } }, "type": "object", "required": [ "recurrenceType" ] }, "azure-native:alertsmanagement:SuppressionConfigResponse": { "description": "Suppression logic for a given action rule", "properties": { "recurrenceType": { "type": "string", "description": "Specifies when the suppression should be applied" }, "schedule": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:SuppressionScheduleResponse", "description": "suppression schedule configuration" } }, "type": "object", "required": [ "recurrenceType" ] }, "azure-native:alertsmanagement:SuppressionResponse": { "description": "Action rule with suppression configuration", "properties": { "conditions": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ConditionsResponse", "description": "conditions on which alerts will be filtered" }, "createdAt": { "type": "string", "description": "Creation time of action rule. Date-Time in ISO-8601 format." }, "createdBy": { "type": "string", "description": "Created by user name." }, "description": { "type": "string", "description": "Description of action rule" }, "lastModifiedAt": { "type": "string", "description": "Last updated time of action rule. Date-Time in ISO-8601 format." }, "lastModifiedBy": { "type": "string", "description": "Last modified by user name." }, "scope": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:ScopeResponse", "description": "scope on which action rule will apply" }, "status": { "type": "string", "description": "Indicates if the given action rule is enabled or disabled" }, "suppressionConfig": { "type": "object", "$ref": "#/types/azure-native:alertsmanagement:SuppressionConfigResponse", "description": "suppression configuration for the action rule" }, "type": { "type": "string", "description": "Indicates type of action rule\nExpected value is 'Suppression'.", "const": "Suppression" } }, "type": "object", "required": [ "createdAt", "createdBy", "lastModifiedAt", "lastModifiedBy", "suppressionConfig", "type" ] }, "azure-native:alertsmanagement:SuppressionSchedule": { "description": "Schedule for a given suppression configuration.", "properties": { "endDate": { "type": "string", "description": "End date for suppression" }, "endTime": { "type": "string", "description": "End date for suppression" }, "recurrenceValues": { "type": "array", "items": { "type": "integer" }, "description": "Specifies the values for recurrence pattern" }, "startDate": { "type": "string", "description": "Start date for suppression" }, "startTime": { "type": "string", "description": "Start time for suppression" } }, "type": "object" }, "azure-native:alertsmanagement:SuppressionScheduleResponse": { "description": "Schedule for a given suppression configuration.", "properties": { "endDate": { "type": "string", "description": "End date for suppression" }, "endTime": { "type": "string", "description": "End date for suppression" }, "recurrenceValues": { "type": "array", "items": { "type": "integer" }, "description": "Specifies the values for recurrence pattern" }, "startDate": { "type": "string", "description": "Start date for suppression" }, "startTime": { "type": "string", "description": "Start time for suppression" } }, "type": "object" }, "azure-native:alertsmanagement:SuppressionType": { "description": "Specifies when the suppression should be applied", "type": "string", "enum": [ { "value": "Always" }, { "value": "Once" }, { "value": "Daily" }, { "value": "Weekly" }, { "value": "Monthly" } ] }, "azure-native:alertsmanagement:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:alertsmanagement:ThrottlingInformation": { "description": "Optional throttling information for the alert rule.", "properties": { "duration": { "type": "string", "description": "The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes" } }, "type": "object" }, "azure-native:alertsmanagement:ThrottlingInformationResponse": { "description": "Optional throttling information for the alert rule.", "properties": { "duration": { "type": "string", "description": "The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes" } }, "type": "object" }, "azure-native:alertsmanagement:WeeklyRecurrence": { "description": "Weekly recurrence object.", "properties": { "daysOfWeek": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:alertsmanagement:DaysOfWeek" } ] }, "description": "Specifies the values for weekly recurrence pattern." }, "endTime": { "type": "string", "description": "End time for recurrence." }, "recurrenceType": { "type": "string", "description": "Specifies when the recurrence should be applied.\nExpected value is 'Weekly'.", "const": "Weekly" }, "startTime": { "type": "string", "description": "Start time for recurrence." } }, "type": "object", "required": [ "daysOfWeek", "recurrenceType" ] }, "azure-native:alertsmanagement:WeeklyRecurrenceResponse": { "description": "Weekly recurrence object.", "properties": { "daysOfWeek": { "type": "array", "items": { "type": "string" }, "description": "Specifies the values for weekly recurrence pattern." }, "endTime": { "type": "string", "description": "End time for recurrence." }, "recurrenceType": { "type": "string", "description": "Specifies when the recurrence should be applied.\nExpected value is 'Weekly'.", "const": "Weekly" }, "startTime": { "type": "string", "description": "Start time for recurrence." } }, "type": "object", "required": [ "daysOfWeek", "recurrenceType" ] }, "azure-native:analysisservices:ConnectionMode": { "description": "How the read-write server's participation in the query pool is controlled.\u003cbr/\u003eIt can have the following values: \u003cul\u003e\u003cli\u003ereadOnly - indicates that the read-write server is intended not to participate in query operations\u003c/li\u003e\u003cli\u003eall - indicates that the read-write server can participate in query operations\u003c/li\u003e\u003c/ul\u003eSpecifying readOnly when capacity is 1 results in error.", "type": "string", "enum": [ { "value": "All" }, { "value": "ReadOnly" } ] }, "azure-native:analysisservices:GatewayDetails": { "description": "The gateway details.", "properties": { "gatewayResourceId": { "type": "string", "description": "Gateway resource to be associated with the server." } }, "type": "object" }, "azure-native:analysisservices:GatewayDetailsResponse": { "description": "The gateway details.", "properties": { "dmtsClusterUri": { "type": "string", "description": "Uri of the DMTS cluster." }, "gatewayObjectId": { "type": "string", "description": "Gateway object id from in the DMTS cluster for the gateway resource." }, "gatewayResourceId": { "type": "string", "description": "Gateway resource to be associated with the server." } }, "type": "object", "required": [ "dmtsClusterUri", "gatewayObjectId" ] }, "azure-native:analysisservices:IPv4FirewallRule": { "description": "The detail of firewall rule.", "properties": { "firewallRuleName": { "type": "string", "description": "The rule name." }, "rangeEnd": { "type": "string", "description": "The end range of IPv4." }, "rangeStart": { "type": "string", "description": "The start range of IPv4." } }, "type": "object" }, "azure-native:analysisservices:IPv4FirewallRuleResponse": { "description": "The detail of firewall rule.", "properties": { "firewallRuleName": { "type": "string", "description": "The rule name." }, "rangeEnd": { "type": "string", "description": "The end range of IPv4." }, "rangeStart": { "type": "string", "description": "The start range of IPv4." } }, "type": "object" }, "azure-native:analysisservices:IPv4FirewallSettings": { "description": "An array of firewall rules.", "properties": { "enablePowerBIService": { "type": "boolean", "description": "The indicator of enabling PBI service." }, "firewallRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:analysisservices:IPv4FirewallRule" }, "description": "An array of firewall rules." } }, "type": "object" }, "azure-native:analysisservices:IPv4FirewallSettingsResponse": { "description": "An array of firewall rules.", "properties": { "enablePowerBIService": { "type": "boolean", "description": "The indicator of enabling PBI service." }, "firewallRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:analysisservices:IPv4FirewallRuleResponse" }, "description": "An array of firewall rules." } }, "type": "object" }, "azure-native:analysisservices:ResourceSku": { "description": "Represents the SKU name and Azure pricing tier for Analysis Services resource.", "properties": { "capacity": { "type": "integer", "description": "The number of instances in the read only query pool.", "default": 1 }, "name": { "type": "string", "description": "Name of the SKU level." }, "tier": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:analysisservices:SkuTier" } ], "description": "The name of the Azure pricing tier to which the SKU applies." } }, "type": "object", "required": [ "name" ] }, "azure-native:analysisservices:ResourceSkuResponse": { "description": "Represents the SKU name and Azure pricing tier for Analysis Services resource.", "properties": { "capacity": { "type": "integer", "description": "The number of instances in the read only query pool.", "default": 1 }, "name": { "type": "string", "description": "Name of the SKU level." }, "tier": { "type": "string", "description": "The name of the Azure pricing tier to which the SKU applies." } }, "type": "object", "required": [ "name" ] }, "azure-native:analysisservices:ServerAdministrators": { "description": "An array of administrator user identities.", "properties": { "members": { "type": "array", "items": { "type": "string" }, "description": "An array of administrator user identities." } }, "type": "object" }, "azure-native:analysisservices:ServerAdministratorsResponse": { "description": "An array of administrator user identities.", "properties": { "members": { "type": "array", "items": { "type": "string" }, "description": "An array of administrator user identities." } }, "type": "object" }, "azure-native:analysisservices:SkuTier": { "description": "The name of the Azure pricing tier to which the SKU applies.", "type": "string", "enum": [ { "value": "Development" }, { "value": "Basic" }, { "value": "Standard" } ] }, "azure-native:apicenter:ApiDefinitionPropertiesSpecificationResponse": { "description": "API specification details.", "properties": { "name": { "type": "string", "description": "Specification name." }, "version": { "type": "string", "description": "Specification version." } }, "type": "object" }, "azure-native:apicenter:ApiKind": { "description": "Kind of API. For example, REST or GraphQL.", "type": "string", "enum": [ { "name": "rest", "description": "A Representational State Transfer Api", "value": "rest" }, { "name": "graphql", "description": "A Graph query language Api", "value": "graphql" }, { "name": "grpc", "description": "A gRPC Api", "value": "grpc" }, { "name": "soap", "description": "A SOAP Api", "value": "soap" }, { "name": "webhook", "description": "Web Hook", "value": "webhook" }, { "name": "websocket", "description": "Web Socket", "value": "websocket" } ] }, "azure-native:apicenter:AzureApiManagementSource": { "description": "API source configuration for Azure API Management.", "properties": { "msiResourceId": { "type": "string", "description": "The resource ID of the managed identity that has access to the API Management instance." }, "resourceId": { "type": "string", "description": "API Management service resource ID." } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:apicenter:AzureApiManagementSourceResponse": { "description": "API source configuration for Azure API Management.", "properties": { "msiResourceId": { "type": "string", "description": "The resource ID of the managed identity that has access to the API Management instance." }, "resourceId": { "type": "string", "description": "API Management service resource ID." } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:apicenter:Contact": { "description": "Contact information", "properties": { "email": { "type": "string", "description": "Email address of the contact." }, "name": { "type": "string", "description": "Name of the contact." }, "url": { "type": "string", "description": "URL for the contact." } }, "type": "object" }, "azure-native:apicenter:ContactResponse": { "description": "Contact information", "properties": { "email": { "type": "string", "description": "Email address of the contact." }, "name": { "type": "string", "description": "Name of the contact." }, "url": { "type": "string", "description": "URL for the contact." } }, "type": "object" }, "azure-native:apicenter:DeploymentServer": { "description": "Server", "properties": { "runtimeUri": { "type": "array", "items": { "type": "string" }, "description": "Base runtime URLs for this deployment." } }, "type": "object" }, "azure-native:apicenter:DeploymentServerResponse": { "description": "Server", "properties": { "runtimeUri": { "type": "array", "items": { "type": "string" }, "description": "Base runtime URLs for this deployment." } }, "type": "object" }, "azure-native:apicenter:DeploymentState": { "description": "State of API deployment.", "type": "string", "enum": [ { "name": "active", "description": "Active State", "value": "active" }, { "name": "inactive", "description": "Inactive State", "value": "inactive" } ] }, "azure-native:apicenter:EnvironmentKind": { "description": "Environment kind.", "type": "string", "enum": [ { "name": "development", "description": "Development environment", "value": "development" }, { "name": "testing", "description": "Testing environment", "value": "testing" }, { "name": "staging", "description": "Staging environment", "value": "staging" }, { "name": "production", "description": "Production environment", "value": "production" } ] }, "azure-native:apicenter:EnvironmentServer": { "description": "Server information of the environment.", "properties": { "managementPortalUri": { "type": "array", "items": { "type": "string" }, "description": "The location of the management portal" }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apicenter:EnvironmentServerType" } ], "description": "Type of the server that represents the environment." } }, "type": "object" }, "azure-native:apicenter:EnvironmentServerResponse": { "description": "Server information of the environment.", "properties": { "managementPortalUri": { "type": "array", "items": { "type": "string" }, "description": "The location of the management portal" }, "type": { "type": "string", "description": "Type of the server that represents the environment." } }, "type": "object" }, "azure-native:apicenter:EnvironmentServerType": { "description": "Type of the server that represents the environment.", "type": "string", "enum": [ { "name": "Azure API Management", "description": "Api Management Server", "value": "Azure API Management" }, { "name": "Azure compute service", "description": "Compute server", "value": "Azure compute service" }, { "name": "Apigee API Management", "description": "Apigee server", "value": "Apigee API Management" }, { "name": "AWS API Gateway", "description": "AWS Api Gateway server", "value": "AWS API Gateway" }, { "name": "Kong API Gateway", "description": "Kong API Gateway server", "value": "Kong API Gateway" }, { "name": "Kubernetes", "description": "Kubernetes server", "value": "Kubernetes" }, { "name": "MuleSoft API Management", "description": "Mulesoft Api Management server", "value": "MuleSoft API Management" } ] }, "azure-native:apicenter:ExternalDocumentation": { "description": "Additional, external documentation for the API.", "properties": { "description": { "type": "string", "description": "Description of the documentation." }, "title": { "type": "string", "description": "Title of the documentation." }, "url": { "type": "string", "description": "URL pointing to the documentation." } }, "type": "object", "required": [ "url" ] }, "azure-native:apicenter:ExternalDocumentationResponse": { "description": "Additional, external documentation for the API.", "properties": { "description": { "type": "string", "description": "Description of the documentation." }, "title": { "type": "string", "description": "Title of the documentation." }, "url": { "type": "string", "description": "URL pointing to the documentation." } }, "type": "object", "required": [ "url" ] }, "azure-native:apicenter:ImportSpecificationOptions": { "description": "Indicates if the specification should be imported along with metadata.", "type": "string", "enum": [ { "name": "Never", "description": "Indicates that the specification should be never be imported.", "value": "never" }, { "name": "OnDemand", "description": "Indicates that the specification should be imported only by request.", "value": "ondemand" }, { "name": "Always", "description": "Indicates that the specification should always be imported along with metadata.", "value": "always" } ] }, "azure-native:apicenter:License": { "description": "The license information for the API.", "properties": { "identifier": { "type": "string", "description": "SPDX license information for the API. The identifier field is mutually\nexclusive of the URL field." }, "name": { "type": "string", "description": "Name of the license." }, "url": { "type": "string", "description": "URL pointing to the license details. The URL field is mutually exclusive of the\nidentifier field." } }, "type": "object" }, "azure-native:apicenter:LicenseResponse": { "description": "The license information for the API.", "properties": { "identifier": { "type": "string", "description": "SPDX license information for the API. The identifier field is mutually\nexclusive of the URL field." }, "name": { "type": "string", "description": "Name of the license." }, "url": { "type": "string", "description": "URL pointing to the license details. The URL field is mutually exclusive of the\nidentifier field." } }, "type": "object" }, "azure-native:apicenter:LifecycleStage": { "description": "Current lifecycle stage of the API.", "type": "string", "enum": [ { "name": "design", "description": "design stage", "value": "design" }, { "name": "development", "description": "development stage", "value": "development" }, { "name": "testing", "description": "testing stage", "value": "testing" }, { "name": "preview", "description": "In preview", "value": "preview" }, { "name": "production", "description": "In production", "value": "production" }, { "name": "deprecated", "description": "deprecated stage", "value": "deprecated" }, { "name": "retired", "description": "Retired stage", "value": "retired" } ] }, "azure-native:apicenter:LinkStateResponse": { "description": "The link state.", "properties": { "lastUpdatedOn": { "type": "string", "description": "The timestamp of the last update of the link state." }, "message": { "type": "string", "description": "The state message." }, "state": { "type": "string", "description": "The state of the link." } }, "type": "object", "required": [ "lastUpdatedOn" ] }, "azure-native:apicenter:ManagedServiceIdentity": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apicenter:ManagedServiceIdentityType" } ], "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "type" ] }, "azure-native:apicenter:ManagedServiceIdentityResponse": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "principalId": { "type": "string", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "type": "string", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apicenter:UserAssignedIdentityResponse" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:apicenter:ManagedServiceIdentityType": { "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned,UserAssigned" } ] }, "azure-native:apicenter:MetadataAssignment": { "description": "Assignment metadata", "properties": { "deprecated": { "type": "boolean", "description": "Deprecated assignment" }, "entity": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apicenter:MetadataAssignmentEntity" } ], "description": "The entities this metadata schema component gets applied to." }, "required": { "type": "boolean", "description": "Required assignment" } }, "type": "object" }, "azure-native:apicenter:MetadataAssignmentEntity": { "description": "The entities this metadata schema component gets applied to.", "type": "string", "enum": [ { "name": "api", "description": "Assigned to API", "value": "api" }, { "name": "environment", "description": "Assigned to Environment", "value": "environment" }, { "name": "deployment", "description": "Assigned to Deployment", "value": "deployment" } ] }, "azure-native:apicenter:MetadataAssignmentResponse": { "description": "Assignment metadata", "properties": { "deprecated": { "type": "boolean", "description": "Deprecated assignment" }, "entity": { "type": "string", "description": "The entities this metadata schema component gets applied to." }, "required": { "type": "boolean", "description": "Required assignment" } }, "type": "object" }, "azure-native:apicenter:Onboarding": { "description": "Onboarding information", "properties": { "developerPortalUri": { "type": "array", "items": { "type": "string" }, "description": "The location of the development portal" }, "instructions": { "type": "string", "description": "Onboarding guide." } }, "type": "object" }, "azure-native:apicenter:OnboardingResponse": { "description": "Onboarding information", "properties": { "developerPortalUri": { "type": "array", "items": { "type": "string" }, "description": "The location of the development portal" }, "instructions": { "type": "string", "description": "Onboarding guide." } }, "type": "object" }, "azure-native:apicenter:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:apicenter:TermsOfService": { "description": "Terms of service for the API.", "properties": { "url": { "type": "string", "description": "URL pointing to the terms of service." } }, "type": "object", "required": [ "url" ] }, "azure-native:apicenter:TermsOfServiceResponse": { "description": "Terms of service for the API.", "properties": { "url": { "type": "string", "description": "URL pointing to the terms of service." } }, "type": "object", "required": [ "url" ] }, "azure-native:apicenter:UserAssignedIdentityResponse": { "description": "User assigned identity properties", "properties": { "clientId": { "type": "string", "description": "The client ID of the assigned identity." }, "principalId": { "type": "string", "description": "The principal ID of the assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:apimanagement:AdditionalLocation": { "description": "Description of an additional API Management resource location.", "properties": { "disableGateway": { "type": "boolean", "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.", "default": false }, "location": { "type": "string", "description": "The location name of the additional region among Azure Data center regions." }, "natGatewayState": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:NatGatewayState" } ], "description": "Property can be used to enable NAT Gateway for this API Management service.", "default": "Disabled" }, "publicIpAddressId": { "type": "string", "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network." }, "sku": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ApiManagementServiceSkuProperties", "description": "SKU properties of the API Management service." }, "virtualNetworkConfiguration": { "type": "object", "$ref": "#/types/azure-native:apimanagement:VirtualNetworkConfiguration", "description": "Virtual network configuration for the location." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "A list of availability zones denoting where the resource needs to come from." } }, "type": "object", "required": [ "location", "sku" ] }, "azure-native:apimanagement:AdditionalLocationResponse": { "description": "Description of an additional API Management resource location.", "properties": { "disableGateway": { "type": "boolean", "description": "Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.", "default": false }, "gatewayRegionalUrl": { "type": "string", "description": "Gateway URL of the API Management service in the Region." }, "location": { "type": "string", "description": "The location name of the additional region among Azure Data center regions." }, "natGatewayState": { "type": "string", "description": "Property can be used to enable NAT Gateway for this API Management service.", "default": "Disabled" }, "outboundPublicIPAddresses": { "type": "array", "items": { "type": "string" }, "description": "Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform." }, "platformVersion": { "type": "string", "description": "Compute Platform Version running the service." }, "privateIPAddresses": { "type": "array", "items": { "type": "string" }, "description": "Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU." }, "publicIPAddresses": { "type": "array", "items": { "type": "string" }, "description": "Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU." }, "publicIpAddressId": { "type": "string", "description": "Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network." }, "sku": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ApiManagementServiceSkuPropertiesResponse", "description": "SKU properties of the API Management service." }, "virtualNetworkConfiguration": { "type": "object", "$ref": "#/types/azure-native:apimanagement:VirtualNetworkConfigurationResponse", "description": "Virtual network configuration for the location." }, "zones": { "type": "array", "items": { "type": "string" }, "description": "A list of availability zones denoting where the resource needs to come from." } }, "type": "object", "required": [ "gatewayRegionalUrl", "location", "outboundPublicIPAddresses", "platformVersion", "privateIPAddresses", "publicIPAddresses", "sku" ] }, "azure-native:apimanagement:AlwaysLog": { "description": "Specifies for what type of messages sampling settings should not apply.", "type": "string", "enum": [ { "description": "Always log all erroneous request regardless of sampling settings.", "value": "allErrors" } ] }, "azure-native:apimanagement:ApiContactInformation": { "description": "API contact information", "properties": { "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address" }, "name": { "type": "string", "description": "The identifying name of the contact person/organization" }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL" } }, "type": "object" }, "azure-native:apimanagement:ApiContactInformationResponse": { "description": "API contact information", "properties": { "email": { "type": "string", "description": "The email address of the contact person/organization. MUST be in the format of an email address" }, "name": { "type": "string", "description": "The identifying name of the contact person/organization" }, "url": { "type": "string", "description": "The URL pointing to the contact information. MUST be in the format of a URL" } }, "type": "object" }, "azure-native:apimanagement:ApiCreateOrUpdatePropertiesWsdlSelector": { "description": "Criteria to limit import of WSDL to a subset of the document.", "properties": { "wsdlEndpointName": { "type": "string", "description": "Name of endpoint(port) to import from WSDL" }, "wsdlServiceName": { "type": "string", "description": "Name of service to import from WSDL" } }, "type": "object" }, "azure-native:apimanagement:ApiGatewaySkuType": { "description": "Name of the Sku.", "type": "string", "enum": [ { "description": "Standard SKU of the API gateway.", "value": "Standard" }, { "description": "Standard SKU of the API gateway to be used in Workspaces.", "value": "WorkspaceGatewayStandard" }, { "description": "Premium SKU of the API gateway to be used in Workspaces.", "value": "WorkspaceGatewayPremium" } ] }, "azure-native:apimanagement:ApiLicenseInformation": { "description": "API license information", "properties": { "name": { "type": "string", "description": "The license name used for the API" }, "url": { "type": "string", "description": "A URL to the license used for the API. MUST be in the format of a URL" } }, "type": "object" }, "azure-native:apimanagement:ApiLicenseInformationResponse": { "description": "API license information", "properties": { "name": { "type": "string", "description": "The license name used for the API" }, "url": { "type": "string", "description": "A URL to the license used for the API. MUST be in the format of a URL" } }, "type": "object" }, "azure-native:apimanagement:ApiManagementGatewaySkuProperties": { "description": "API Management gateway resource SKU properties.", "properties": { "capacity": { "type": "integer", "description": "Capacity of the SKU (number of deployed units of the SKU)" }, "name": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:ApiGatewaySkuType" } ], "description": "Name of the Sku." } }, "type": "object", "required": [ "name" ] }, "azure-native:apimanagement:ApiManagementGatewaySkuPropertiesResponse": { "description": "API Management gateway resource SKU properties.", "properties": { "capacity": { "type": "integer", "description": "Capacity of the SKU (number of deployed units of the SKU)" }, "name": { "type": "string", "description": "Name of the Sku." } }, "type": "object", "required": [ "name" ] }, "azure-native:apimanagement:ApiManagementServiceIdentity": { "description": "Identity properties of the Api Management service resource.", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:ApimIdentityType" } ], "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apimanagement:UserIdentityProperties" }, "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object", "required": [ "type" ] }, "azure-native:apimanagement:ApiManagementServiceIdentityResponse": { "description": "Identity properties of the Api Management service resource.", "properties": { "principalId": { "type": "string", "description": "The principal id of the identity." }, "tenantId": { "type": "string", "description": "The client tenant id of the identity." }, "type": { "type": "string", "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apimanagement:UserIdentityPropertiesResponse" }, "description": "The list of user identities associated with the resource. The user identity \r\ndictionary key references will be ARM resource ids in the form: \r\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/\r\n providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:apimanagement:ApiManagementServiceSkuProperties": { "description": "API Management service resource SKU properties.", "properties": { "capacity": { "type": "integer", "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." }, "name": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:SkuType" } ], "description": "Name of the Sku." } }, "type": "object", "required": [ "capacity", "name" ] }, "azure-native:apimanagement:ApiManagementServiceSkuPropertiesResponse": { "description": "API Management service resource SKU properties.", "properties": { "capacity": { "type": "integer", "description": "Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0." }, "name": { "type": "string", "description": "Name of the Sku." } }, "type": "object", "required": [ "capacity", "name" ] }, "azure-native:apimanagement:ApiType": { "description": "Type of API.", "type": "string", "enum": [ { "value": "http" }, { "value": "soap" }, { "value": "websocket" }, { "value": "graphql" }, { "value": "odata" }, { "value": "grpc" } ] }, "azure-native:apimanagement:ApiVersionConstraint": { "description": "Control Plane Apis version constraint for the API Management service.", "properties": { "minApiVersion": { "type": "string", "description": "Limit control plane API calls to API Management service with version equal to or newer than this value." } }, "type": "object" }, "azure-native:apimanagement:ApiVersionConstraintResponse": { "description": "Control Plane Apis version constraint for the API Management service.", "properties": { "minApiVersion": { "type": "string", "description": "Limit control plane API calls to API Management service with version equal to or newer than this value." } }, "type": "object" }, "azure-native:apimanagement:ApiVersionSetContractDetails": { "description": "An API Version Set contains the common configuration for a set of API Versions relating ", "properties": { "description": { "type": "string", "description": "Description of API Version Set." }, "id": { "type": "string", "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." }, "name": { "type": "string", "description": "The display Name of the API Version Set." }, "versionHeaderName": { "type": "string", "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." }, "versionQueryName": { "type": "string", "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." }, "versioningScheme": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:VersioningScheme" } ], "description": "An value that determines where the API Version identifier will be located in a HTTP request." } }, "type": "object" }, "azure-native:apimanagement:ApiVersionSetContractDetailsResponse": { "description": "An API Version Set contains the common configuration for a set of API Versions relating ", "properties": { "description": { "type": "string", "description": "Description of API Version Set." }, "id": { "type": "string", "description": "Identifier for existing API Version Set. Omit this value to create a new Version Set." }, "name": { "type": "string", "description": "The display Name of the API Version Set." }, "versionHeaderName": { "type": "string", "description": "Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`." }, "versionQueryName": { "type": "string", "description": "Name of query parameter that indicates the API Version if versioningScheme is set to `query`." }, "versioningScheme": { "type": "string", "description": "An value that determines where the API Version identifier will be located in a HTTP request." } }, "type": "object" }, "azure-native:apimanagement:ApimIdentityType": { "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.", "type": "string", "enum": [ { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned, UserAssigned" }, { "value": "None" } ] }, "azure-native:apimanagement:AppType": { "description": "Determines the type of application which send the create user request. Default is legacy portal.", "type": "string", "enum": [ { "description": "User create request was sent by legacy developer portal.", "value": "portal" }, { "description": "User create request was sent by new developer portal.", "value": "developerPortal" } ] }, "azure-native:apimanagement:ArmIdWrapperResponse": { "description": "A wrapper for an ARM resource id", "properties": { "id": { "type": "string" } }, "type": "object", "required": [ "id" ] }, "azure-native:apimanagement:AuthenticationSettingsContract": { "description": "API Authentication Settings.", "properties": { "oAuth2": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OAuth2AuthenticationSettingsContract", "description": "OAuth2 Authentication settings" }, "oAuth2AuthenticationSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OAuth2AuthenticationSettingsContract" }, "description": "Collection of OAuth2 authentication settings included into this API." }, "openid": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OpenIdAuthenticationSettingsContract", "description": "OpenID Connect Authentication Settings" }, "openidAuthenticationSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OpenIdAuthenticationSettingsContract" }, "description": "Collection of Open ID Connect authentication settings included into this API." } }, "type": "object" }, "azure-native:apimanagement:AuthenticationSettingsContractResponse": { "description": "API Authentication Settings.", "properties": { "oAuth2": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OAuth2AuthenticationSettingsContractResponse", "description": "OAuth2 Authentication settings" }, "oAuth2AuthenticationSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OAuth2AuthenticationSettingsContractResponse" }, "description": "Collection of OAuth2 authentication settings included into this API." }, "openid": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OpenIdAuthenticationSettingsContractResponse", "description": "OpenID Connect Authentication Settings" }, "openidAuthenticationSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:OpenIdAuthenticationSettingsContractResponse" }, "description": "Collection of Open ID Connect authentication settings included into this API." } }, "type": "object" }, "azure-native:apimanagement:AuthorizationError": { "description": "Authorization error details.", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" } }, "type": "object" }, "azure-native:apimanagement:AuthorizationErrorResponse": { "description": "Authorization error details.", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message" } }, "type": "object" }, "azure-native:apimanagement:AuthorizationMethod": { "type": "string", "enum": [ { "value": "HEAD" }, { "value": "OPTIONS" }, { "value": "TRACE" }, { "value": "GET" }, { "value": "POST" }, { "value": "PUT" }, { "value": "PATCH" }, { "value": "DELETE" } ] }, "azure-native:apimanagement:AuthorizationProviderOAuth2GrantTypes": { "description": "Authorization Provider oauth2 grant types settings", "properties": { "authorizationCode": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OAuth2 authorization code grant parameters" }, "clientCredentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OAuth2 client credential grant parameters" } }, "type": "object" }, "azure-native:apimanagement:AuthorizationProviderOAuth2GrantTypesResponse": { "description": "Authorization Provider oauth2 grant types settings", "properties": { "authorizationCode": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OAuth2 authorization code grant parameters" }, "clientCredentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OAuth2 client credential grant parameters" } }, "type": "object" }, "azure-native:apimanagement:AuthorizationProviderOAuth2Settings": { "description": "OAuth2 settings details", "properties": { "grantTypes": { "type": "object", "$ref": "#/types/azure-native:apimanagement:AuthorizationProviderOAuth2GrantTypes", "description": "OAuth2 settings" }, "redirectUrl": { "type": "string", "description": "Redirect URL to be set in the OAuth application." } }, "type": "object" }, "azure-native:apimanagement:AuthorizationProviderOAuth2SettingsResponse": { "description": "OAuth2 settings details", "properties": { "grantTypes": { "type": "object", "$ref": "#/types/azure-native:apimanagement:AuthorizationProviderOAuth2GrantTypesResponse", "description": "OAuth2 settings" }, "redirectUrl": { "type": "string", "description": "Redirect URL to be set in the OAuth application." } }, "type": "object" }, "azure-native:apimanagement:AuthorizationType": { "description": "Authorization type options", "type": "string", "enum": [ { "name": "OAuth2", "description": "OAuth2 authorization type", "value": "OAuth2" } ] }, "azure-native:apimanagement:BackendAuthorizationHeaderCredentials": { "description": "Authorization header information.", "properties": { "parameter": { "type": "string", "description": "Authentication Parameter value." }, "scheme": { "type": "string", "description": "Authentication Scheme name." } }, "type": "object", "required": [ "parameter", "scheme" ] }, "azure-native:apimanagement:BackendAuthorizationHeaderCredentialsResponse": { "description": "Authorization header information.", "properties": { "parameter": { "type": "string", "description": "Authentication Parameter value." }, "scheme": { "type": "string", "description": "Authentication Scheme name." } }, "type": "object", "required": [ "parameter", "scheme" ] }, "azure-native:apimanagement:BackendBaseParametersPool": { "properties": { "services": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendPoolItem" }, "description": "The list of backend entities belonging to a pool." } }, "type": "object" }, "azure-native:apimanagement:BackendBaseParametersResponsePool": { "properties": { "services": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendPoolItemResponse" }, "description": "The list of backend entities belonging to a pool." } }, "type": "object" }, "azure-native:apimanagement:BackendCircuitBreaker": { "description": "The configuration of the backend circuit breaker", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CircuitBreakerRule" }, "description": "The rules for tripping the backend." } }, "type": "object" }, "azure-native:apimanagement:BackendCircuitBreakerResponse": { "description": "The configuration of the backend circuit breaker", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CircuitBreakerRuleResponse" }, "description": "The rules for tripping the backend." } }, "type": "object" }, "azure-native:apimanagement:BackendConfiguration": { "description": "Information regarding how the gateway should integrate with backend systems.", "properties": { "subnet": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendSubnetConfiguration", "description": "The default hostname of the data-plane gateway to which requests can be sent." } }, "type": "object" }, "azure-native:apimanagement:BackendConfigurationResponse": { "description": "Information regarding how the gateway should integrate with backend systems.", "properties": { "subnet": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendSubnetConfigurationResponse", "description": "The default hostname of the data-plane gateway to which requests can be sent." } }, "type": "object" }, "azure-native:apimanagement:BackendCredentialsContract": { "description": "Details of the Credentials used to connect to Backend.", "properties": { "authorization": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendAuthorizationHeaderCredentials", "description": "Authorization header authentication" }, "certificate": { "type": "array", "items": { "type": "string" }, "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided." }, "certificateIds": { "type": "array", "items": { "type": "string" }, "description": "List of Client Certificate Ids." }, "header": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Header Parameter description." }, "query": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Query Parameter description." } }, "type": "object" }, "azure-native:apimanagement:BackendCredentialsContractResponse": { "description": "Details of the Credentials used to connect to Backend.", "properties": { "authorization": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendAuthorizationHeaderCredentialsResponse", "description": "Authorization header authentication" }, "certificate": { "type": "array", "items": { "type": "string" }, "description": "List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided." }, "certificateIds": { "type": "array", "items": { "type": "string" }, "description": "List of Client Certificate Ids." }, "header": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Header Parameter description." }, "query": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Query Parameter description." } }, "type": "object" }, "azure-native:apimanagement:BackendPoolItem": { "description": "Backend pool service information", "properties": { "id": { "type": "string", "description": "The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity." }, "priority": { "type": "integer", "description": "The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified." }, "weight": { "type": "integer", "description": "The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified." } }, "type": "object", "required": [ "id" ] }, "azure-native:apimanagement:BackendPoolItemResponse": { "description": "Backend pool service information", "properties": { "id": { "type": "string", "description": "The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity." }, "priority": { "type": "integer", "description": "The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified." }, "weight": { "type": "integer", "description": "The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified." } }, "type": "object", "required": [ "id" ] }, "azure-native:apimanagement:BackendProperties": { "description": "Properties specific to the Backend Type.", "properties": { "serviceFabricCluster": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendServiceFabricClusterProperties", "description": "Backend Service Fabric Cluster Properties" } }, "type": "object" }, "azure-native:apimanagement:BackendPropertiesResponse": { "description": "Properties specific to the Backend Type.", "properties": { "serviceFabricCluster": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BackendServiceFabricClusterPropertiesResponse", "description": "Backend Service Fabric Cluster Properties" } }, "type": "object" }, "azure-native:apimanagement:BackendProtocol": { "description": "Backend communication protocol. Required when backend type is 'Single'.", "type": "string", "enum": [ { "description": "The Backend is a RESTful service.", "value": "http" }, { "description": "The Backend is a SOAP service.", "value": "soap" } ] }, "azure-native:apimanagement:BackendProxyContract": { "description": "Details of the Backend WebProxy Server to use in the Request to Backend.", "properties": { "password": { "type": "string", "description": "Password to connect to the WebProxy Server" }, "url": { "type": "string", "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings." }, "username": { "type": "string", "description": "Username to connect to the WebProxy server" } }, "type": "object", "required": [ "url" ] }, "azure-native:apimanagement:BackendProxyContractResponse": { "description": "Details of the Backend WebProxy Server to use in the Request to Backend.", "properties": { "password": { "type": "string", "description": "Password to connect to the WebProxy Server" }, "url": { "type": "string", "description": "WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings." }, "username": { "type": "string", "description": "Username to connect to the WebProxy server" } }, "type": "object", "required": [ "url" ] }, "azure-native:apimanagement:BackendServiceFabricClusterProperties": { "description": "Properties of the Service Fabric Type Backend.", "properties": { "clientCertificateId": { "type": "string", "description": "The client certificate id for the management endpoint." }, "clientCertificatethumbprint": { "type": "string", "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided" }, "managementEndpoints": { "type": "array", "items": { "type": "string" }, "description": "The cluster management endpoint." }, "maxPartitionResolutionRetries": { "type": "integer", "description": "Maximum number of retries while attempting resolve the partition." }, "serverCertificateThumbprints": { "type": "array", "items": { "type": "string" }, "description": "Thumbprints of certificates cluster management service uses for tls communication" }, "serverX509Names": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:X509CertificateName" }, "description": "Server X509 Certificate Names Collection" } }, "type": "object", "required": [ "managementEndpoints" ] }, "azure-native:apimanagement:BackendServiceFabricClusterPropertiesResponse": { "description": "Properties of the Service Fabric Type Backend.", "properties": { "clientCertificateId": { "type": "string", "description": "The client certificate id for the management endpoint." }, "clientCertificatethumbprint": { "type": "string", "description": "The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided" }, "managementEndpoints": { "type": "array", "items": { "type": "string" }, "description": "The cluster management endpoint." }, "maxPartitionResolutionRetries": { "type": "integer", "description": "Maximum number of retries while attempting resolve the partition." }, "serverCertificateThumbprints": { "type": "array", "items": { "type": "string" }, "description": "Thumbprints of certificates cluster management service uses for tls communication" }, "serverX509Names": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:X509CertificateNameResponse" }, "description": "Server X509 Certificate Names Collection" } }, "type": "object", "required": [ "managementEndpoints" ] }, "azure-native:apimanagement:BackendSubnetConfiguration": { "description": "Information regarding how the subnet to which the gateway should be injected.", "properties": { "id": { "type": "string", "description": "The ARM ID of the subnet in which the backend systems are hosted." } }, "type": "object" }, "azure-native:apimanagement:BackendSubnetConfigurationResponse": { "description": "Information regarding how the subnet to which the gateway should be injected.", "properties": { "id": { "type": "string", "description": "The ARM ID of the subnet in which the backend systems are hosted." } }, "type": "object" }, "azure-native:apimanagement:BackendTlsProperties": { "description": "Properties controlling TLS Certificate Validation.", "properties": { "validateCertificateChain": { "type": "boolean", "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", "default": true }, "validateCertificateName": { "type": "boolean", "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", "default": true } }, "type": "object" }, "azure-native:apimanagement:BackendTlsPropertiesResponse": { "description": "Properties controlling TLS Certificate Validation.", "properties": { "validateCertificateChain": { "type": "boolean", "description": "Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.", "default": true }, "validateCertificateName": { "type": "boolean", "description": "Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.", "default": true } }, "type": "object" }, "azure-native:apimanagement:BackendType": { "description": "Type of the backend. A backend can be either Single or Pool.", "type": "string", "enum": [ { "description": "supports single backend", "value": "Single" }, { "description": "supports pool backend", "value": "Pool" } ] }, "azure-native:apimanagement:BearerTokenSendingMethod": { "type": "string", "enum": [ { "value": "authorizationHeader" }, { "value": "query" } ] }, "azure-native:apimanagement:BearerTokenSendingMethods": { "description": "Form of an authorization grant, which the client uses to request the access token.", "type": "string", "enum": [ { "description": "Access token will be transmitted in the Authorization header using Bearer schema", "value": "authorizationHeader" }, { "description": "Access token will be transmitted as query parameters.", "value": "query" } ] }, "azure-native:apimanagement:BodyDiagnosticSettings": { "description": "Body logging settings.", "properties": { "bytes": { "type": "integer", "description": "Number of request body bytes to log." } }, "type": "object" }, "azure-native:apimanagement:BodyDiagnosticSettingsResponse": { "description": "Body logging settings.", "properties": { "bytes": { "type": "integer", "description": "Number of request body bytes to log." } }, "type": "object" }, "azure-native:apimanagement:CertificateConfiguration": { "description": "Certificate configuration which consist of non-trusted intermediates and root certificates.", "properties": { "certificate": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CertificateInformation", "description": "Certificate information." }, "certificatePassword": { "type": "string", "description": "Certificate Password." }, "encodedCertificate": { "type": "string", "description": "Base64 Encoded certificate." }, "storeName": { "type": "string", "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations." } }, "type": "object", "required": [ "storeName" ] }, "azure-native:apimanagement:CertificateConfigurationResponse": { "description": "Certificate configuration which consist of non-trusted intermediates and root certificates.", "properties": { "certificate": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CertificateInformationResponse", "description": "Certificate information." }, "certificatePassword": { "type": "string", "description": "Certificate Password." }, "encodedCertificate": { "type": "string", "description": "Base64 Encoded certificate." }, "storeName": { "type": "string", "description": "The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations." } }, "type": "object", "required": [ "storeName" ] }, "azure-native:apimanagement:CertificateInformation": { "description": "SSL certificate information.", "properties": { "expiry": { "type": "string", "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." }, "subject": { "type": "string", "description": "Subject of the certificate." }, "thumbprint": { "type": "string", "description": "Thumbprint of the certificate." } }, "type": "object", "required": [ "expiry", "subject", "thumbprint" ] }, "azure-native:apimanagement:CertificateInformationResponse": { "description": "SSL certificate information.", "properties": { "expiry": { "type": "string", "description": "Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." }, "subject": { "type": "string", "description": "Subject of the certificate." }, "thumbprint": { "type": "string", "description": "Thumbprint of the certificate." } }, "type": "object", "required": [ "expiry", "subject", "thumbprint" ] }, "azure-native:apimanagement:CertificateSource": { "description": "Certificate Source.", "type": "string", "enum": [ { "value": "Managed" }, { "value": "KeyVault" }, { "value": "Custom" }, { "value": "BuiltIn" } ] }, "azure-native:apimanagement:CertificateStatus": { "description": "Certificate Status.", "type": "string", "enum": [ { "value": "Completed" }, { "value": "Failed" }, { "value": "InProgress" } ] }, "azure-native:apimanagement:CircuitBreakerFailureCondition": { "description": "The trip conditions of the circuit breaker", "properties": { "count": { "type": "number", "description": "The threshold for opening the circuit." }, "errorReasons": { "type": "array", "items": { "type": "string" }, "description": "The error reasons which are considered as failure." }, "interval": { "type": "string", "description": "The interval during which the failures are counted." }, "percentage": { "type": "number", "description": "The threshold for opening the circuit." }, "statusCodeRanges": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:FailureStatusCodeRange" }, "description": "The status code ranges which are considered as failure." } }, "type": "object" }, "azure-native:apimanagement:CircuitBreakerFailureConditionResponse": { "description": "The trip conditions of the circuit breaker", "properties": { "count": { "type": "number", "description": "The threshold for opening the circuit." }, "errorReasons": { "type": "array", "items": { "type": "string" }, "description": "The error reasons which are considered as failure." }, "interval": { "type": "string", "description": "The interval during which the failures are counted." }, "percentage": { "type": "number", "description": "The threshold for opening the circuit." }, "statusCodeRanges": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:FailureStatusCodeRangeResponse" }, "description": "The status code ranges which are considered as failure." } }, "type": "object" }, "azure-native:apimanagement:CircuitBreakerRule": { "description": "Rule configuration to trip the backend.", "properties": { "acceptRetryAfter": { "type": "boolean", "description": "flag to accept Retry-After header from the backend." }, "failureCondition": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CircuitBreakerFailureCondition", "description": "The conditions for tripping the circuit breaker." }, "name": { "type": "string", "description": "The rule name." }, "tripDuration": { "type": "string", "description": "The duration for which the circuit will be tripped." } }, "type": "object" }, "azure-native:apimanagement:CircuitBreakerRuleResponse": { "description": "Rule configuration to trip the backend.", "properties": { "acceptRetryAfter": { "type": "boolean", "description": "flag to accept Retry-After header from the backend." }, "failureCondition": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CircuitBreakerFailureConditionResponse", "description": "The conditions for tripping the circuit breaker." }, "name": { "type": "string", "description": "The rule name." }, "tripDuration": { "type": "string", "description": "The duration for which the circuit will be tripped." } }, "type": "object" }, "azure-native:apimanagement:ClientApplicationSecretsContractResponseEntra": { "description": "Microsoft EntraID client application secrets", "properties": { "clientSecret": { "type": "string", "description": "EntraID client application secret" }, "expiresAt": { "type": "string", "description": "EntraID client application secret expiration date." } }, "type": "object", "required": [ "expiresAt" ] }, "azure-native:apimanagement:ClientAuthenticationMethod": { "type": "string", "enum": [ { "description": "Basic Client Authentication method.", "value": "Basic" }, { "description": "Body based Authentication method.", "value": "Body" } ] }, "azure-native:apimanagement:ConfigurationApi": { "description": "Information regarding the Configuration API of the API Management service.", "properties": { "legacyApi": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:LegacyApiState" } ], "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", "default": "Enabled" } }, "type": "object" }, "azure-native:apimanagement:ConfigurationApiResponse": { "description": "Information regarding the Configuration API of the API Management service.", "properties": { "legacyApi": { "type": "string", "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", "default": "Enabled" } }, "type": "object" }, "azure-native:apimanagement:Confirmation": { "description": "Determines the type of confirmation e-mail that will be sent to the newly created user.", "type": "string", "enum": [ { "description": "Send an e-mail to the user confirming they have successfully signed up.", "value": "signup" }, { "description": "Send an e-mail inviting the user to sign-up and complete registration.", "value": "invite" } ] }, "azure-native:apimanagement:ContentFormat": { "description": "Format of the Content in which the API is getting imported. New formats can be added in the future", "type": "string", "enum": [ { "description": "The contents are inline and Content type is a WADL document.", "value": "wadl-xml" }, { "description": "The WADL document is hosted on a publicly accessible internet address.", "value": "wadl-link-json" }, { "description": "The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.", "value": "swagger-json" }, { "description": "The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.", "value": "swagger-link-json" }, { "description": "The contents are inline and the document is a WSDL/Soap document.", "value": "wsdl" }, { "description": "The WSDL document is hosted on a publicly accessible internet address.", "value": "wsdl-link" }, { "description": "The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.", "value": "openapi" }, { "description": "The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.", "value": "openapi+json" }, { "description": "The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.", "value": "openapi-link" }, { "description": "The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.", "value": "openapi+json-link" }, { "description": "The GraphQL API endpoint hosted on a publicly accessible internet address.", "value": "graphql-link" }, { "description": "The contents are inline and Content Type is a OData XML Document.", "value": "odata" }, { "description": "The OData metadata document hosted on a publicly accessible internet address.", "value": "odata-link" }, { "description": "The contents are inline and Content Type is a gRPC protobuf file.", "value": "grpc" }, { "description": "The gRPC protobuf file is hosted on a publicly accessible internet address.", "value": "grpc-link" } ] }, "azure-native:apimanagement:DataMasking": { "properties": { "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:DataMaskingEntity" }, "description": "Masking settings for headers" }, "queryParams": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:DataMaskingEntity" }, "description": "Masking settings for Url query parameters" } }, "type": "object" }, "azure-native:apimanagement:DataMaskingEntity": { "properties": { "mode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:DataMaskingMode" } ], "description": "Data masking mode." }, "value": { "type": "string", "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." } }, "type": "object" }, "azure-native:apimanagement:DataMaskingEntityResponse": { "properties": { "mode": { "type": "string", "description": "Data masking mode." }, "value": { "type": "string", "description": "The name of an entity to mask (e.g. a name of a header or a query parameter)." } }, "type": "object" }, "azure-native:apimanagement:DataMaskingMode": { "description": "Data masking mode.", "type": "string", "enum": [ { "description": "Mask the value of an entity.", "value": "Mask" }, { "description": "Hide the presence of an entity.", "value": "Hide" } ] }, "azure-native:apimanagement:DataMaskingResponse": { "properties": { "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:DataMaskingEntityResponse" }, "description": "Masking settings for headers" }, "queryParams": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:DataMaskingEntityResponse" }, "description": "Masking settings for Url query parameters" } }, "type": "object" }, "azure-native:apimanagement:DeveloperPortalStatus": { "description": "Status of developer portal in this API Management service.", "type": "string", "enum": [ { "description": "Developer Portal is enabled for the service.", "value": "Enabled" }, { "description": "Developer Portal is disabled for the service.", "value": "Disabled" } ] }, "azure-native:apimanagement:EmailTemplateParametersContractProperties": { "description": "Email Template Parameter contract.", "properties": { "description": { "type": "string", "description": "Template parameter description." }, "name": { "type": "string", "description": "Template parameter name." }, "title": { "type": "string", "description": "Template parameter title." } }, "type": "object" }, "azure-native:apimanagement:EmailTemplateParametersContractPropertiesResponse": { "description": "Email Template Parameter contract.", "properties": { "description": { "type": "string", "description": "Template parameter description." }, "name": { "type": "string", "description": "Template parameter name." }, "title": { "type": "string", "description": "Template parameter title." } }, "type": "object" }, "azure-native:apimanagement:FailureStatusCodeRange": { "description": "The failure http status code range", "properties": { "max": { "type": "integer", "description": "The maximum http status code." }, "min": { "type": "integer", "description": "The minimum http status code." } }, "type": "object" }, "azure-native:apimanagement:FailureStatusCodeRangeResponse": { "description": "The failure http status code range", "properties": { "max": { "type": "integer", "description": "The maximum http status code." }, "min": { "type": "integer", "description": "The minimum http status code." } }, "type": "object" }, "azure-native:apimanagement:FrontendConfigurationResponse": { "description": "Information regarding how the gateway should be exposed.", "properties": { "defaultHostname": { "type": "string", "description": "The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU." } }, "type": "object", "required": [ "defaultHostname" ] }, "azure-native:apimanagement:GatewayConfigurationApiResponse": { "description": "Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU.", "properties": { "hostname": { "type": "string", "description": "Hostname to which the agent connects to propagate configuration to the cloud." } }, "type": "object", "required": [ "hostname" ] }, "azure-native:apimanagement:GatewayHostnameBindingCertificateResponse": { "properties": { "expiry": { "type": "string", "description": "The expiration date of the certificate." }, "subject": { "type": "string", "description": "The subject of the certificate." }, "thumbprint": { "type": "string", "description": "The thumbprint of the certificate." } }, "type": "object", "required": [ "expiry", "subject", "thumbprint" ] }, "azure-native:apimanagement:GatewayHostnameBindingKeyVault": { "properties": { "identityClientId": { "type": "string", "description": "The default hostname of the data-plane gateway." }, "secretId": { "type": "string", "description": "The current provisioning state of the API Management gateway hostname binding." } }, "type": "object", "required": [ "secretId" ] }, "azure-native:apimanagement:GatewayHostnameBindingKeyVaultLastStatusResponse": { "properties": { "code": { "type": "string", "description": "The last status of the Key Vault certificate fetch process." }, "lastSuccessTimeStampUtc": { "type": "string", "description": "The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." }, "timeStampUtc": { "type": "string", "description": "The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard." } }, "type": "object", "required": [ "code", "lastSuccessTimeStampUtc", "timeStampUtc" ] }, "azure-native:apimanagement:GatewayHostnameBindingKeyVaultResponse": { "properties": { "identityClientId": { "type": "string", "description": "The default hostname of the data-plane gateway." }, "lastStatus": { "type": "object", "$ref": "#/types/azure-native:apimanagement:GatewayHostnameBindingKeyVaultLastStatusResponse", "description": "The last status of the Key Vault certificate fetch process." }, "secretId": { "type": "string", "description": "The current provisioning state of the API Management gateway hostname binding." } }, "type": "object", "required": [ "secretId" ] }, "azure-native:apimanagement:GatewayListDebugCredentialsContractPurpose": { "description": "Purpose of debug credential.", "type": "string", "enum": [ { "description": "The tracing purpose.", "value": "tracing" } ] }, "azure-native:apimanagement:GrantType": { "type": "string", "enum": [ { "description": "Authorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.", "value": "authorizationCode" }, { "description": "Implicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.", "value": "implicit" }, { "description": "Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.", "value": "resourceOwnerPassword" }, { "description": "Client Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.", "value": "clientCredentials" } ] }, "azure-native:apimanagement:GroupContractPropertiesResponse": { "description": "Group contract Properties.", "properties": { "builtIn": { "type": "boolean", "description": "true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false." }, "description": { "type": "string", "description": "Group description. Can contain HTML formatting tags." }, "displayName": { "type": "string", "description": "Group name." }, "externalId": { "type": "string", "description": "For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://\u003ctenant\u003e.onmicrosoft.com/groups/\u003cgroup object id\u003e`; otherwise the value is null." }, "type": { "type": "string", "description": "Group type." } }, "type": "object", "required": [ "builtIn", "displayName" ] }, "azure-native:apimanagement:GroupType": { "description": "Group type.", "type": "string", "enum": [ { "value": "custom" }, { "value": "system" }, { "value": "external" } ] }, "azure-native:apimanagement:HostnameConfiguration": { "description": "Custom hostname configuration.", "properties": { "certificate": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CertificateInformation", "description": "Certificate information." }, "certificatePassword": { "type": "string", "description": "Certificate Password." }, "certificateSource": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:CertificateSource" } ], "description": "Certificate Source." }, "certificateStatus": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:CertificateStatus" } ], "description": "Certificate Status." }, "defaultSslBinding": { "type": "boolean", "description": "Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.", "default": false }, "encodedCertificate": { "type": "string", "description": "Base64 Encoded certificate." }, "hostName": { "type": "string", "description": "Hostname to configure on the Api Management service." }, "identityClientId": { "type": "string", "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." }, "keyVaultId": { "type": "string", "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12*" }, "negotiateClientCertificate": { "type": "boolean", "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false.", "default": false }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:HostnameType" } ], "description": "Hostname type." } }, "type": "object", "required": [ "hostName", "type" ] }, "azure-native:apimanagement:HostnameConfigurationResponse": { "description": "Custom hostname configuration.", "properties": { "certificate": { "type": "object", "$ref": "#/types/azure-native:apimanagement:CertificateInformationResponse", "description": "Certificate information." }, "certificatePassword": { "type": "string", "description": "Certificate Password." }, "certificateSource": { "type": "string", "description": "Certificate Source." }, "certificateStatus": { "type": "string", "description": "Certificate Status." }, "defaultSslBinding": { "type": "boolean", "description": "Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type.", "default": false }, "encodedCertificate": { "type": "string", "description": "Base64 Encoded certificate." }, "hostName": { "type": "string", "description": "Hostname to configure on the Api Management service." }, "identityClientId": { "type": "string", "description": "System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate." }, "keyVaultId": { "type": "string", "description": "Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12*" }, "negotiateClientCertificate": { "type": "boolean", "description": "Specify true to always negotiate client certificate on the hostname. Default Value is false.", "default": false }, "type": { "type": "string", "description": "Hostname type." } }, "type": "object", "required": [ "hostName", "type" ] }, "azure-native:apimanagement:HostnameType": { "description": "Hostname type.", "type": "string", "enum": [ { "value": "Proxy" }, { "value": "Portal" }, { "value": "Management" }, { "value": "Scm" }, { "value": "DeveloperPortal" }, { "value": "ConfigurationApi" } ] }, "azure-native:apimanagement:HttpCorrelationProtocol": { "description": "Sets correlation protocol to use for Application Insights diagnostics.", "type": "string", "enum": [ { "description": "Do not read and inject correlation headers.", "value": "None" }, { "description": "Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.", "value": "Legacy" }, { "description": "Inject Trace Context headers. See https://w3c.github.io/trace-context.", "value": "W3C" } ] }, "azure-native:apimanagement:HttpMessageDiagnostic": { "description": "Http message diagnostic settings.", "properties": { "body": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BodyDiagnosticSettings", "description": "Body logging settings." }, "dataMasking": { "type": "object", "$ref": "#/types/azure-native:apimanagement:DataMasking", "description": "Data masking settings." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "Array of HTTP Headers to log." } }, "type": "object" }, "azure-native:apimanagement:HttpMessageDiagnosticResponse": { "description": "Http message diagnostic settings.", "properties": { "body": { "type": "object", "$ref": "#/types/azure-native:apimanagement:BodyDiagnosticSettingsResponse", "description": "Body logging settings." }, "dataMasking": { "type": "object", "$ref": "#/types/azure-native:apimanagement:DataMaskingResponse", "description": "Data masking settings." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "Array of HTTP Headers to log." } }, "type": "object" }, "azure-native:apimanagement:IdentityProviderType": { "description": "Identity Provider Type identifier.", "type": "string", "enum": [ { "description": "Facebook as Identity provider.", "value": "facebook" }, { "description": "Google as Identity provider.", "value": "google" }, { "description": "Microsoft Live as Identity provider.", "value": "microsoft" }, { "description": "Twitter as Identity provider.", "value": "twitter" }, { "description": "Azure Active Directory as Identity provider.", "value": "aad" }, { "description": "Azure Active Directory B2C as Identity provider.", "value": "aadB2C" } ] }, "azure-native:apimanagement:KeyType": { "description": "The Key to be used to generate token for user.", "type": "string", "enum": [ { "value": "primary" }, { "value": "secondary" } ] }, "azure-native:apimanagement:KeyVaultContractCreateProperties": { "description": "Create keyVault contract details.", "properties": { "identityClientId": { "type": "string", "description": "Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret." }, "secretIdentifier": { "type": "string", "description": "Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi" } }, "type": "object" }, "azure-native:apimanagement:KeyVaultContractPropertiesResponse": { "description": "KeyVault contract details.", "properties": { "identityClientId": { "type": "string", "description": "Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret." }, "lastStatus": { "type": "object", "$ref": "#/types/azure-native:apimanagement:KeyVaultLastAccessStatusContractPropertiesResponse", "description": "Last time sync and refresh status of secret from key vault." }, "secretIdentifier": { "type": "string", "description": "Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi" } }, "type": "object" }, "azure-native:apimanagement:KeyVaultLastAccessStatusContractPropertiesResponse": { "description": "Issue contract Update Properties.", "properties": { "code": { "type": "string", "description": "Last status code for sync and refresh of secret from key vault." }, "message": { "type": "string", "description": "Details of the error else empty." }, "timeStampUtc": { "type": "string", "description": "Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.\n" } }, "type": "object" }, "azure-native:apimanagement:LegacyApiState": { "description": "Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled'", "type": "string", "enum": [ { "description": "Legacy Configuration API (v1) is enabled for the service and self-hosted gateways can connect to it.", "value": "Enabled" }, { "description": "Legacy Configuration API (v1) is disabled for the service and self-hosted gateways can not connect to it.", "value": "Disabled" } ] }, "azure-native:apimanagement:LegacyPortalStatus": { "description": "Status of legacy portal in the API Management service.", "type": "string", "enum": [ { "description": "Legacy Portal is enabled for the service.", "value": "Enabled" }, { "description": "Legacy Portal is disabled for the service.", "value": "Disabled" } ] }, "azure-native:apimanagement:LoggerType": { "description": "Logger type.", "type": "string", "enum": [ { "description": "Azure Event Hub as log destination.", "value": "azureEventHub" }, { "description": "Azure Application Insights as log destination.", "value": "applicationInsights" }, { "description": "Azure Monitor", "value": "azureMonitor" } ] }, "azure-native:apimanagement:NatGatewayState": { "description": "Property can be used to enable NAT Gateway for this API Management service.", "type": "string", "enum": [ { "description": "Nat Gateway is enabled for the service.", "value": "Enabled" }, { "description": "Nat Gateway is disabled for the service.", "value": "Disabled" } ] }, "azure-native:apimanagement:OAuth2AuthenticationSettingsContract": { "description": "API OAuth2 Authentication settings details.", "properties": { "authorizationServerId": { "type": "string", "description": "OAuth authorization server identifier." }, "scope": { "type": "string", "description": "operations scope." } }, "type": "object" }, "azure-native:apimanagement:OAuth2AuthenticationSettingsContractResponse": { "description": "API OAuth2 Authentication settings details.", "properties": { "authorizationServerId": { "type": "string", "description": "OAuth authorization server identifier." }, "scope": { "type": "string", "description": "operations scope." } }, "type": "object" }, "azure-native:apimanagement:OAuth2GrantType": { "description": "OAuth2 grant type options", "type": "string", "enum": [ { "name": "AuthorizationCode", "description": "Authorization Code grant", "value": "AuthorizationCode" }, { "name": "ClientCredentials", "description": "Client Credential grant", "value": "ClientCredentials" } ] }, "azure-native:apimanagement:OpenIdAuthenticationSettingsContract": { "description": "API OAuth2 Authentication settings details.", "properties": { "bearerTokenSendingMethods": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:BearerTokenSendingMethods" } ] }, "description": "How to send token to the server." }, "openidProviderId": { "type": "string", "description": "OAuth authorization server identifier." } }, "type": "object" }, "azure-native:apimanagement:OpenIdAuthenticationSettingsContractResponse": { "description": "API OAuth2 Authentication settings details.", "properties": { "bearerTokenSendingMethods": { "type": "array", "items": { "type": "string" }, "description": "How to send token to the server." }, "openidProviderId": { "type": "string", "description": "OAuth authorization server identifier." } }, "type": "object" }, "azure-native:apimanagement:OperationNameFormat": { "description": "The format of the Operation Name for Application Insights telemetries. Default is Name.", "type": "string", "enum": [ { "description": "API_NAME;rev=API_REVISION - OPERATION_NAME", "value": "Name" }, { "description": "HTTP_VERB URL", "value": "Url" } ] }, "azure-native:apimanagement:ParameterContract": { "description": "Operation parameters details.", "properties": { "defaultValue": { "type": "string", "description": "Default parameter value." }, "description": { "type": "string", "description": "Parameter description." }, "examples": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterExampleContract" }, "description": "Exampled defined for the parameter." }, "name": { "type": "string", "description": "Parameter name." }, "required": { "type": "boolean", "description": "Specifies whether parameter is required or not." }, "schemaId": { "type": "string", "description": "Schema identifier." }, "type": { "type": "string", "description": "Parameter type." }, "typeName": { "type": "string", "description": "Type name defined by the schema." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values." } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:apimanagement:ParameterContractResponse": { "description": "Operation parameters details.", "properties": { "defaultValue": { "type": "string", "description": "Default parameter value." }, "description": { "type": "string", "description": "Parameter description." }, "examples": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterExampleContractResponse" }, "description": "Exampled defined for the parameter." }, "name": { "type": "string", "description": "Parameter name." }, "required": { "type": "boolean", "description": "Specifies whether parameter is required or not." }, "schemaId": { "type": "string", "description": "Schema identifier." }, "type": { "type": "string", "description": "Parameter type." }, "typeName": { "type": "string", "description": "Type name defined by the schema." }, "values": { "type": "array", "items": { "type": "string" }, "description": "Parameter values." } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:apimanagement:ParameterExampleContract": { "description": "Parameter example.", "properties": { "description": { "type": "string", "description": "Long description for the example" }, "externalValue": { "type": "string", "description": "A URL that points to the literal example" }, "summary": { "type": "string", "description": "Short description for the example" }, "value": { "$ref": "pulumi.json#/Any", "description": "Example value. May be a primitive value, or an object." } }, "type": "object" }, "azure-native:apimanagement:ParameterExampleContractResponse": { "description": "Parameter example.", "properties": { "description": { "type": "string", "description": "Long description for the example" }, "externalValue": { "type": "string", "description": "A URL that points to the literal example" }, "summary": { "type": "string", "description": "Short description for the example" }, "value": { "$ref": "pulumi.json#/Any", "description": "Example value. May be a primitive value, or an object." } }, "type": "object" }, "azure-native:apimanagement:PipelineDiagnosticSettings": { "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.", "properties": { "request": { "type": "object", "$ref": "#/types/azure-native:apimanagement:HttpMessageDiagnostic", "description": "Diagnostic settings for request." }, "response": { "type": "object", "$ref": "#/types/azure-native:apimanagement:HttpMessageDiagnostic", "description": "Diagnostic settings for response." } }, "type": "object" }, "azure-native:apimanagement:PipelineDiagnosticSettingsResponse": { "description": "Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.", "properties": { "request": { "type": "object", "$ref": "#/types/azure-native:apimanagement:HttpMessageDiagnosticResponse", "description": "Diagnostic settings for request." }, "response": { "type": "object", "$ref": "#/types/azure-native:apimanagement:HttpMessageDiagnosticResponse", "description": "Diagnostic settings for response." } }, "type": "object" }, "azure-native:apimanagement:PolicyContentFormat": { "description": "Format of the policyContent.", "type": "string", "enum": [ { "description": "The contents are inline and Content type is an XML document.", "value": "xml" }, { "description": "The policy XML document is hosted on a HTTP endpoint accessible from the API Management service.", "value": "xml-link" }, { "description": "The contents are inline and Content type is a non XML encoded policy document.", "value": "rawxml" }, { "description": "The policy document is not XML encoded and is hosted on a HTTP endpoint accessible from the API Management service.", "value": "rawxml-link" } ] }, "azure-native:apimanagement:PolicyFragmentContentFormat": { "description": "Format of the policy fragment content.", "type": "string", "enum": [ { "description": "The contents are inline and Content type is an XML document.", "value": "xml" }, { "description": "The contents are inline and Content type is a non XML encoded policy document.", "value": "rawxml" } ] }, "azure-native:apimanagement:PolicyRestrictionRequireBase": { "description": "Indicates if base policy should be enforced for the policy document.", "type": "string", "enum": [ { "description": "The policy is required to have base policy", "value": "true" }, { "description": "The policy does not require to have base policy", "value": "false" } ] }, "azure-native:apimanagement:PrivateEndpointConnectionRequestProperties": { "description": "The connection state of the private endpoint connection.", "properties": { "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:apimanagement:PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." } }, "type": "object" }, "azure-native:apimanagement:PrivateEndpointResponse": { "description": "The Private Endpoint resource.", "properties": { "id": { "type": "string", "description": "The ARM identifier for Private Endpoint" } }, "type": "object", "required": [ "id" ] }, "azure-native:apimanagement:PrivateEndpointServiceConnectionStatus": { "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", "type": "string", "enum": [ { "value": "Pending" }, { "value": "Approved" }, { "value": "Rejected" } ] }, "azure-native:apimanagement:PrivateLinkServiceConnectionState": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:PrivateEndpointServiceConnectionStatus" } ], "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:apimanagement:PrivateLinkServiceConnectionStateResponse": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "type": "string", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:apimanagement:ProductState": { "description": "whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.", "type": "string", "enum": [ { "value": "notPublished" }, { "value": "published" } ] }, "azure-native:apimanagement:Protocol": { "type": "string", "enum": [ { "value": "http" }, { "value": "https" }, { "value": "ws" }, { "value": "wss" } ] }, "azure-native:apimanagement:ProvisioningState": { "description": "Provisioning state.", "type": "string", "enum": [ { "value": "created" } ] }, "azure-native:apimanagement:PublicNetworkAccess": { "description": "Whether or not public endpoint access is allowed for this API Management service. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:apimanagement:RemotePrivateEndpointConnectionWrapper": { "description": "Remote Private Endpoint Connection resource.", "properties": { "id": { "type": "string", "description": "Private Endpoint connection resource id" }, "name": { "type": "string", "description": "Private Endpoint Connection Name" }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:apimanagement:PrivateLinkServiceConnectionState", "description": "A collection of information about the state of the connection between service consumer and provider." }, "type": { "type": "string", "description": "Private Endpoint Connection Resource Type" } }, "type": "object", "required": [ "privateLinkServiceConnectionState" ] }, "azure-native:apimanagement:RemotePrivateEndpointConnectionWrapperResponse": { "description": "Remote Private Endpoint Connection resource.", "properties": { "groupIds": { "type": "array", "items": { "type": "string" }, "description": "All the Group ids." }, "id": { "type": "string", "description": "Private Endpoint connection resource id" }, "name": { "type": "string", "description": "Private Endpoint Connection Name" }, "privateEndpoint": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ArmIdWrapperResponse", "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:apimanagement:PrivateLinkServiceConnectionStateResponse", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "type": "string", "description": "The provisioning state of the private endpoint connection resource." }, "type": { "type": "string", "description": "Private Endpoint Connection Resource Type" } }, "type": "object", "required": [ "groupIds", "privateLinkServiceConnectionState", "provisioningState" ] }, "azure-native:apimanagement:RepresentationContract": { "description": "Operation request/response representation details.", "properties": { "contentType": { "type": "string", "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." }, "examples": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterExampleContract" }, "description": "Exampled defined for the representation." }, "formParameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContract" }, "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." }, "schemaId": { "type": "string", "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." }, "typeName": { "type": "string", "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." } }, "type": "object", "required": [ "contentType" ] }, "azure-native:apimanagement:RepresentationContractResponse": { "description": "Operation request/response representation details.", "properties": { "contentType": { "type": "string", "description": "Specifies a registered or custom content type for this representation, e.g. application/xml." }, "examples": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterExampleContractResponse" }, "description": "Exampled defined for the representation." }, "formParameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContractResponse" }, "description": "Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.." }, "schemaId": { "type": "string", "description": "Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." }, "typeName": { "type": "string", "description": "Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'." } }, "type": "object", "required": [ "contentType" ] }, "azure-native:apimanagement:RequestContract": { "description": "Operation request details.", "properties": { "description": { "type": "string", "description": "Operation request description." }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContract" }, "description": "Collection of operation request headers." }, "queryParameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContract" }, "description": "Collection of operation request query parameters." }, "representations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:RepresentationContract" }, "description": "Collection of operation request representations." } }, "type": "object" }, "azure-native:apimanagement:RequestContractResponse": { "description": "Operation request details.", "properties": { "description": { "type": "string", "description": "Operation request description." }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContractResponse" }, "description": "Collection of operation request headers." }, "queryParameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContractResponse" }, "description": "Collection of operation request query parameters." }, "representations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:RepresentationContractResponse" }, "description": "Collection of operation request representations." } }, "type": "object" }, "azure-native:apimanagement:ResourceCollectionResponseValue": { "properties": { "id": { "type": "string", "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" }, "name": { "type": "string", "description": "The name of the resource" }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "id", "name", "type" ] }, "azure-native:apimanagement:ResourceLocationDataContract": { "description": "Resource location data properties.", "properties": { "city": { "type": "string", "description": "The city or locality where the resource is located." }, "countryOrRegion": { "type": "string", "description": "The country or region where the resource is located." }, "district": { "type": "string", "description": "The district, state, or province where the resource is located." }, "name": { "type": "string", "description": "A canonical name for the geographic or physical location." } }, "type": "object", "required": [ "name" ] }, "azure-native:apimanagement:ResourceLocationDataContractResponse": { "description": "Resource location data properties.", "properties": { "city": { "type": "string", "description": "The city or locality where the resource is located." }, "countryOrRegion": { "type": "string", "description": "The country or region where the resource is located." }, "district": { "type": "string", "description": "The district, state, or province where the resource is located." }, "name": { "type": "string", "description": "A canonical name for the geographic or physical location." } }, "type": "object", "required": [ "name" ] }, "azure-native:apimanagement:ResponseContract": { "description": "Operation response details.", "properties": { "description": { "type": "string", "description": "Operation response description." }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContract" }, "description": "Collection of operation response headers." }, "representations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:RepresentationContract" }, "description": "Collection of operation response representations." }, "statusCode": { "type": "integer", "description": "Operation response HTTP status code." } }, "type": "object", "required": [ "statusCode" ] }, "azure-native:apimanagement:ResponseContractResponse": { "description": "Operation response details.", "properties": { "description": { "type": "string", "description": "Operation response description." }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:ParameterContractResponse" }, "description": "Collection of operation response headers." }, "representations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:apimanagement:RepresentationContractResponse" }, "description": "Collection of operation response representations." }, "statusCode": { "type": "integer", "description": "Operation response HTTP status code." } }, "type": "object", "required": [ "statusCode" ] }, "azure-native:apimanagement:SamplingSettings": { "description": "Sampling settings for Diagnostic.", "properties": { "percentage": { "type": "number", "description": "Rate of sampling for fixed-rate sampling." }, "samplingType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:apimanagement:SamplingType" } ], "description": "Sampling type." } }, "type": "object" }, "azure-native:apimanagement:SamplingSettingsResponse": { "description": "Sampling settings for Diagnostic.", "properties": { "percentage": { "type": "number", "description": "Rate of sampling for fixed-rate sampling." }, "samplingType": { "type": "string", "description": "Sampling type." } }, "type": "object" }, "azure-native:apimanagement:SamplingType": { "description": "Sampling type.", "type": "string", "enum": [ { "description": "Fixed-rate sampling.", "value": "fixed" } ] }, "azure-native:apimanagement:SchemaType": { "description": "Schema Type. Immutable.", "type": "string", "enum": [ { "name": "Xml", "description": "XML schema type.", "value": "xml" }, { "name": "Json", "description": "Json schema type.", "value": "json" } ] }, "azure-native:apimanagement:SkuType": { "description": "Name of the Sku.", "type": "string", "enum": [ { "description": "Developer SKU of Api Management.", "value": "Developer" }, { "description": "Standard SKU of Api Management.", "value": "Standard" }, { "description": "Premium SKU of Api Management.", "value": "Premium" }, { "description": "Basic SKU of Api Management.", "value": "Basic" }, { "description": "Consumption SKU of Api Management.", "value": "Consumption" }, { "description": "Isolated SKU of Api Management.", "value": "Isolated" }, { "description": "BasicV2 SKU of Api Management.", "value": "BasicV2" }, { "description": "StandardV2 SKU of Api Management.", "value": "StandardV2" } ] }, "azure-native:apimanagement:SoapApiType": { "description": "Type of API to create. \n * `http` creates a REST API \n * `soap` creates a SOAP pass-through API \n * `websocket` creates websocket API \n * `graphql` creates GraphQL API. \n New types can be added in the future.", "type": "string", "enum": [ { "name": "SoapToRest", "description": "Imports a SOAP API having a RESTful front end.", "value": "http" }, { "name": "SoapPassThrough", "description": "Imports the SOAP API having a SOAP front end.", "value": "soap" }, { "name": "WebSocket", "description": "Imports the API having a Websocket front end.", "value": "websocket" }, { "name": "GraphQL", "description": "Imports the API having a GraphQL front end.", "value": "graphql" }, { "name": "OData", "description": "Imports the API having a OData front end.", "value": "odata" }, { "name": "gRPC", "description": "Imports the API having a gRPC front end.", "value": "grpc" } ] }, "azure-native:apimanagement:State": { "description": "Status of the issue.", "type": "string", "enum": [ { "description": "The issue is proposed.", "value": "proposed" }, { "description": "The issue is opened.", "value": "open" }, { "description": "The issue was removed.", "value": "removed" }, { "description": "The issue is now resolved.", "value": "resolved" }, { "description": "The issue was closed.", "value": "closed" } ] }, "azure-native:apimanagement:SubscriptionKeyParameterNamesContract": { "description": "Subscription key parameter names details.", "properties": { "header": { "type": "string", "description": "Subscription key header name." }, "query": { "type": "string", "description": "Subscription key query string parameter name." } }, "type": "object" }, "azure-native:apimanagement:SubscriptionKeyParameterNamesContractResponse": { "description": "Subscription key parameter names details.", "properties": { "header": { "type": "string", "description": "Subscription key header name." }, "query": { "type": "string", "description": "Subscription key query string parameter name." } }, "type": "object" }, "azure-native:apimanagement:SubscriptionState": { "description": "Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.", "type": "string", "enum": [ { "value": "suspended" }, { "value": "active" }, { "value": "expired" }, { "value": "submitted" }, { "value": "rejected" }, { "value": "cancelled" } ] }, "azure-native:apimanagement:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:apimanagement:TokenBodyParameterContract": { "description": "OAuth acquire token request body parameter (www-url-form-encoded).", "properties": { "name": { "type": "string", "description": "body parameter name." }, "value": { "type": "string", "description": "body parameter value." } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:apimanagement:TokenBodyParameterContractResponse": { "description": "OAuth acquire token request body parameter (www-url-form-encoded).", "properties": { "name": { "type": "string", "description": "body parameter name." }, "value": { "type": "string", "description": "body parameter value." } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:apimanagement:TranslateRequiredQueryParametersConduct": { "description": "Strategy of translating required query parameters to template ones. By default has value 'template'. Possible values: 'template', 'query'", "type": "string", "enum": [ { "name": "Template", "description": "Translates required query parameters to template ones. Is a default value", "value": "template" }, { "name": "Query", "description": "Leaves required query parameters as they are (no translation done).", "value": "query" } ] }, "azure-native:apimanagement:UserIdentityContract": { "description": "User identity details.", "properties": { "id": { "type": "string", "description": "Identifier value within provider." }, "provider": { "type": "string", "description": "Identity provider name." } }, "type": "object" }, "azure-native:apimanagement:UserIdentityContractResponse": { "description": "User identity details.", "properties": { "id": { "type": "string", "description": "Identifier value within provider." }, "provider": { "type": "string", "description": "Identity provider name." } }, "type": "object" }, "azure-native:apimanagement:UserIdentityProperties": { "properties": { "clientId": { "type": "string", "description": "The client id of user assigned identity." }, "principalId": { "type": "string", "description": "The principal id of user assigned identity." } }, "type": "object" }, "azure-native:apimanagement:UserIdentityPropertiesResponse": { "properties": { "clientId": { "type": "string", "description": "The client id of user assigned identity." }, "principalId": { "type": "string", "description": "The principal id of user assigned identity." } }, "type": "object" }, "azure-native:apimanagement:UserState": { "description": "Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.", "type": "string", "enum": [ { "description": "User state is active.", "value": "active" }, { "description": "User is blocked. Blocked users cannot authenticate at developer portal or call API.", "value": "blocked" }, { "description": "User account is pending. Requires identity confirmation before it can be made active.", "value": "pending" }, { "description": "User account is closed. All identities and related entities are removed.", "value": "deleted" } ] }, "azure-native:apimanagement:Verbosity": { "description": "The verbosity level applied to traces emitted by trace policies.", "type": "string", "enum": [ { "description": "All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.", "value": "verbose" }, { "description": "Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.", "value": "information" }, { "description": "Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.", "value": "error" } ] }, "azure-native:apimanagement:VersioningScheme": { "description": "An value that determines where the API Version identifier will be located in a HTTP request.", "type": "string", "enum": [ { "description": "The API Version is passed in a path segment.", "value": "Segment" }, { "description": "The API Version is passed in a query parameter.", "value": "Query" }, { "description": "The API Version is passed in a HTTP header.", "value": "Header" } ] }, "azure-native:apimanagement:VirtualNetworkConfiguration": { "description": "Configuration of a virtual network to which API Management service is deployed.", "properties": { "subnetResourceId": { "type": "string", "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." } }, "type": "object" }, "azure-native:apimanagement:VirtualNetworkConfigurationResponse": { "description": "Configuration of a virtual network to which API Management service is deployed.", "properties": { "subnetResourceId": { "type": "string", "description": "The full resource ID of a subnet in a virtual network to deploy the API Management service in." }, "subnetname": { "type": "string", "description": "The name of the subnet." }, "vnetid": { "type": "string", "description": "The virtual network ID. This is typically a GUID. Expect a null GUID by default." } }, "type": "object", "required": [ "subnetname", "vnetid" ] }, "azure-native:apimanagement:VirtualNetworkType": { "description": "The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only.", "type": "string", "enum": [ { "description": "The service is not part of any Virtual Network.", "value": "None" }, { "description": "The service is part of Virtual Network and it is accessible from Internet.", "value": "External" }, { "description": "The service is part of Virtual Network and it is only accessible from within the virtual network.", "value": "Internal" } ] }, "azure-native:apimanagement:WikiDocumentationContract": { "description": "Wiki documentation details.", "properties": { "documentationId": { "type": "string", "description": "Documentation Identifier" } }, "type": "object" }, "azure-native:apimanagement:WikiDocumentationContractResponse": { "description": "Wiki documentation details.", "properties": { "documentationId": { "type": "string", "description": "Documentation Identifier" } }, "type": "object" }, "azure-native:apimanagement:X509CertificateName": { "description": "Properties of server X509Names.", "properties": { "issuerCertificateThumbprint": { "type": "string", "description": "Thumbprint for the Issuer of the Certificate." }, "name": { "type": "string", "description": "Common Name of the Certificate." } }, "type": "object" }, "azure-native:apimanagement:X509CertificateNameResponse": { "description": "Properties of server X509Names.", "properties": { "issuerCertificateThumbprint": { "type": "string", "description": "Thumbprint for the Issuer of the Certificate." }, "name": { "type": "string", "description": "Common Name of the Certificate." } }, "type": "object" }, "azure-native:app:AccessMode": { "description": "Access mode for storage", "type": "string", "enum": [ { "value": "ReadOnly" }, { "value": "ReadWrite" } ] }, "azure-native:app:Action": { "description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny", "type": "string", "enum": [ { "value": "Allow" }, { "value": "Deny" } ] }, "azure-native:app:ActionConfiguration": { "description": "Configuration for action", "properties": { "accessLevel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:AgentAccessLevel" } ], "description": "The access level of the action" }, "identity": { "type": "string", "description": "The identity used by the action" }, "mode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:AgentMode" } ], "description": "The mode of the action" } }, "type": "object" }, "azure-native:app:ActionConfigurationResponse": { "description": "Configuration for action", "properties": { "accessLevel": { "type": "string", "description": "The access level of the action" }, "identity": { "type": "string", "description": "The identity used by the action" }, "mode": { "type": "string", "description": "The mode of the action" } }, "type": "object" }, "azure-native:app:ActiveRevisionsMode": { "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\n\u003clist\u003e\u003citem\u003eSingle: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.\u003c/item\u003e\u003citem\u003eMultiple: Multiple revisions can be active, including optional traffic weights and labels.\u003c/item\u003e\u003citem\u003eLabels: Only revisions with labels are active. Traffic weights can be applied to labels.\u003c/item\u003e\u003c/list\u003e", "type": "string", "enum": [ { "value": "Multiple" }, { "value": "Single" }, { "value": "Labels" } ] }, "azure-native:app:Affinity": { "description": "Sticky Session Affinity", "type": "string", "enum": [ { "value": "sticky" }, { "value": "none" } ] }, "azure-native:app:AgentAccessLevel": { "description": "The access level of the action", "type": "string", "enum": [ { "name": "Low", "description": "Agent has read-only permissions on managed resource groups", "value": "Low" }, { "name": "High", "description": "Agent can take approved actions on resources using its own managed identity", "value": "High" } ] }, "azure-native:app:AgentConnectorProperties": { "description": "Agent Connector Properties", "properties": { "dataConnectorType": { "type": "string", "description": "The type of the data connector" }, "dataSource": { "type": "string", "description": "Data source connection string or endpoint" }, "endpoint": { "type": "string", "description": "Endpoint of the connector" }, "extendedProperties": { "$ref": "pulumi.json#/Any", "description": "Additional properties for the data connector which can be used to store custom key-value pairs" }, "identity": { "type": "string", "description": "Identity used to access the data source" } }, "type": "object" }, "azure-native:app:AgentConnectorPropertiesResponse": { "description": "Agent Connector Properties", "properties": { "dataConnectorType": { "type": "string", "description": "The type of the data connector" }, "dataSource": { "type": "string", "description": "Data source connection string or endpoint" }, "deploymentError": { "type": "string", "description": "Deployment error message if provisioning failed" }, "endpoint": { "type": "string", "description": "Endpoint of the connector" }, "extendedProperties": { "$ref": "pulumi.json#/Any", "description": "Additional properties for the data connector which can be used to store custom key-value pairs" }, "identity": { "type": "string", "description": "Identity used to access the data source" }, "provisioningState": { "type": "string", "description": "Provisioning state of the connector" }, "source": { "type": "string", "description": "Source of the data connector - \"Agent\" when directly stored in agent, \"AgentSpace\" when inherited" } }, "type": "object", "required": [ "deploymentError", "provisioningState", "source" ] }, "azure-native:app:AgentConnectorResponse": { "description": "Agent Connector used to connect to data sources", "properties": { "id": { "type": "string", "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" }, "name": { "type": "string", "description": "The name of the resource" }, "properties": { "type": "object", "$ref": "#/types/azure-native:app:AgentConnectorPropertiesResponse", "description": "The resource-specific properties for this resource." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:app:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "id", "name", "systemData", "type" ] }, "azure-native:app:AgentIdentity": { "description": "Agent identity configuration", "properties": { "initialSponsorGroupId": { "type": "string", "description": "Initial sponsor group ID (required for agent identity)" } }, "type": "object", "required": [ "initialSponsorGroupId" ] }, "azure-native:app:AgentIdentityResponse": { "description": "Agent identity configuration", "properties": { "clientId": { "type": "string", "description": "Client ID (GUID) for the agent identity" }, "enabled": { "type": "boolean", "description": "Indicates whether the agent identity is enabled" }, "initialSponsorGroupId": { "type": "string", "description": "Initial sponsor group ID (required for agent identity)" } }, "type": "object", "required": [ "clientId", "enabled", "initialSponsorGroupId" ] }, "azure-native:app:AgentMode": { "description": "The mode of the action", "type": "string", "enum": [ { "name": "Autonomous", "description": "Write actions are executed automatically without user approval", "value": "Autonomous" }, { "name": "Review", "description": "Write actions require user approval before execution", "value": "Review" }, { "name": "ReadOnly", "description": "No write actions are executed", "value": "ReadOnly" } ] }, "azure-native:app:AgentProperties": { "description": "Properties of the Agent", "properties": { "actionConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:ActionConfiguration", "description": "Configuration for action" }, "agentIdentity": { "type": "object", "$ref": "#/types/azure-native:app:AgentIdentity", "description": "Agent identity configuration for accessing resources" }, "agentSpaceId": { "type": "string", "description": "The agent space ID referenced by the agent" }, "defaultModel": { "type": "object", "$ref": "#/types/azure-native:app:DefaultModel", "description": "Default AI model configuration for the agent" }, "incidentManagementConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:IncidentManagementConfiguration", "description": "Incident management configurations" }, "knowledgeGraphConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:KnowledgeGraphConfiguration", "description": "Knowledge graph configuration for agent" }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LogConfiguration", "description": "Log configurations" }, "upgradeChannel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:UpgradeChannel" } ], "description": "The upgrade channel of the agent" } }, "type": "object" }, "azure-native:app:AgentPropertiesResponse": { "description": "Properties of the Agent", "properties": { "actionConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:ActionConfigurationResponse", "description": "Configuration for action" }, "agentEndpoint": { "type": "string", "description": "The endpoint of the Agent" }, "agentIdentity": { "type": "object", "$ref": "#/types/azure-native:app:AgentIdentityResponse", "description": "Agent identity configuration for accessing resources" }, "agentSpaceId": { "type": "string", "description": "The agent space ID referenced by the agent" }, "defaultModel": { "type": "object", "$ref": "#/types/azure-native:app:DefaultModelResponse", "description": "Default AI model configuration for the agent" }, "incidentManagementConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:IncidentManagementConfigurationResponse", "description": "Incident management configurations" }, "knowledgeGraphConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:KnowledgeGraphConfigurationResponse", "description": "Knowledge graph configuration for agent" }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LogConfigurationResponse", "description": "Log configurations" }, "powerState": { "type": "string", "description": "The power state of the Agent" }, "provisioningState": { "type": "string", "description": "Provisioning state of the Agent" }, "runningState": { "type": "string", "description": "The running state of the Agent" }, "upgradeChannel": { "type": "string", "description": "The upgrade channel of the agent" } }, "type": "object", "required": [ "agentEndpoint", "powerState", "provisioningState", "runningState" ] }, "azure-native:app:AgentSpaceComplianceStatusResponse": { "description": "Compliance status of the Agent Space", "properties": { "complianceIssues": { "type": "array", "items": { "type": "string" }, "description": "List of compliance issues found in the Agent Space" }, "isCompliant": { "type": "boolean", "description": "Indicates whether the Agent Space is compliant" }, "lastComplianceCheck": { "type": "string", "description": "Timestamp of the last compliance check" } }, "type": "object", "required": [ "complianceIssues", "isCompliant", "lastComplianceCheck" ] }, "azure-native:app:AgentSpaceConnectorProperties": { "description": "Agent Space Connector Properties", "properties": { "dataConnectorType": { "type": "string", "description": "The type of the data connector" }, "dataSource": { "type": "string", "description": "Data source connection string or endpoint" }, "endpoint": { "type": "string", "description": "Endpoint of the connector" }, "extendedProperties": { "$ref": "pulumi.json#/Any", "description": "Additional properties for the data connector which can be used to store custom key-value pairs" }, "identity": { "type": "string", "description": "Identity used to access the data source" } }, "type": "object" }, "azure-native:app:AgentSpaceConnectorPropertiesResponse": { "description": "Agent Space Connector Properties", "properties": { "dataConnectorType": { "type": "string", "description": "The type of the data connector" }, "dataSource": { "type": "string", "description": "Data source connection string or endpoint" }, "deploymentError": { "type": "string", "description": "Deployment error message if provisioning failed" }, "endpoint": { "type": "string", "description": "Endpoint of the connector" }, "extendedProperties": { "$ref": "pulumi.json#/Any", "description": "Additional properties for the data connector which can be used to store custom key-value pairs" }, "identity": { "type": "string", "description": "Identity used to access the data source" }, "provisioningState": { "type": "string", "description": "Provisioning state of the connector" } }, "type": "object", "required": [ "deploymentError", "provisioningState" ] }, "azure-native:app:AgentSpaceConnectorResponse": { "description": "Agent Space Connector used to connect to data sources", "properties": { "id": { "type": "string", "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" }, "name": { "type": "string", "description": "The name of the resource" }, "properties": { "type": "object", "$ref": "#/types/azure-native:app:AgentSpaceConnectorPropertiesResponse", "description": "The resource-specific properties for this resource." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:app:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "id", "name", "systemData", "type" ] }, "azure-native:app:AgentSpacePolicies": { "description": "Policy configurations for an Agent Space", "properties": { "genevaActionsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:GenevaActionsPolicy", "description": "Configuration for Geneva Actions policy" } }, "type": "object" }, "azure-native:app:AgentSpacePoliciesResponse": { "description": "Policy configurations for an Agent Space", "properties": { "genevaActionsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:GenevaActionsPolicyResponse", "description": "Configuration for Geneva Actions policy" } }, "type": "object" }, "azure-native:app:AgentSpaceProperties": { "description": "Agent Space specific properties", "properties": { "description": { "type": "string", "description": "Description of the Agent Space" }, "maxAgentCount": { "type": "integer", "description": "Maximum number of agents allowed in the Agent Space" }, "policies": { "type": "object", "$ref": "#/types/azure-native:app:AgentSpacePolicies", "description": "Policy configurations for the Agent Space" }, "serviceTreeId": { "type": "string", "description": "Universal unique ID (UUID) of the Service Tree associated with this Agent Space" } }, "type": "object" }, "azure-native:app:AgentSpacePropertiesResponse": { "description": "Agent Space specific properties", "properties": { "complianceStatus": { "type": "object", "$ref": "#/types/azure-native:app:AgentSpaceComplianceStatusResponse", "description": "Compliance status of the Agent Space" }, "currentAgentCount": { "type": "integer", "description": "Current number of agents in the Agent Space" }, "description": { "type": "string", "description": "Description of the Agent Space" }, "lastPolicyPropagation": { "type": "string", "description": "Timestamp of the last policy propagation to agents in this Agent Space" }, "maxAgentCount": { "type": "integer", "description": "Maximum number of agents allowed in the Agent Space" }, "memberAgents": { "type": "array", "items": { "type": "string" }, "description": "List of agents referencing the Agent Space" }, "policies": { "type": "object", "$ref": "#/types/azure-native:app:AgentSpacePoliciesResponse", "description": "Policy configurations for the Agent Space" }, "provisioningState": { "type": "string", "description": "Provisioning state of the Agent Space" }, "serviceTreeId": { "type": "string", "description": "Universal unique ID (UUID) of the Service Tree associated with this Agent Space" } }, "type": "object", "required": [ "complianceStatus", "currentAgentCount", "lastPolicyPropagation", "memberAgents", "provisioningState" ] }, "azure-native:app:AllowedAudiencesValidation": { "description": "The configuration settings of the Allowed Audiences validation flow.", "properties": { "allowedAudiences": { "type": "array", "items": { "type": "string" }, "description": "The configuration settings of the allowed list of audiences from which to validate the JWT token." } }, "type": "object" }, "azure-native:app:AllowedAudiencesValidationResponse": { "description": "The configuration settings of the Allowed Audiences validation flow.", "properties": { "allowedAudiences": { "type": "array", "items": { "type": "string" }, "description": "The configuration settings of the allowed list of audiences from which to validate the JWT token." } }, "type": "object" }, "azure-native:app:AllowedPrincipals": { "description": "The configuration settings of the Azure Active Directory allowed principals.", "properties": { "groups": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed groups." }, "identities": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed identities." } }, "type": "object" }, "azure-native:app:AllowedPrincipalsResponse": { "description": "The configuration settings of the Azure Active Directory allowed principals.", "properties": { "groups": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed groups." }, "identities": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed identities." } }, "type": "object" }, "azure-native:app:AppInsightsConfiguration": { "description": "Configuration of Application Insights ", "properties": { "connectionString": { "type": "string", "description": "Application Insights connection string" } }, "type": "object" }, "azure-native:app:AppInsightsConfigurationResponse": { "description": "Configuration of Application Insights ", "properties": { "connectionString": { "type": "string", "description": "Application Insights connection string" } }, "type": "object" }, "azure-native:app:AppLogsConfiguration": { "description": "Configuration of application logs", "properties": { "destination": { "type": "string", "description": "Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'" }, "logAnalyticsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LogAnalyticsConfiguration", "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'" } }, "type": "object" }, "azure-native:app:AppLogsConfigurationResponse": { "description": "Configuration of application logs", "properties": { "destination": { "type": "string", "description": "Logs destination, can be 'log-analytics', 'azure-monitor' or 'none'" }, "logAnalyticsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LogAnalyticsConfigurationResponse", "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'" } }, "type": "object" }, "azure-native:app:AppProtocol": { "description": "Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http", "type": "string", "enum": [ { "value": "http" }, { "value": "grpc" } ] }, "azure-native:app:AppRegistration": { "description": "The configuration settings of the app registration for providers that have app ids and app secrets", "properties": { "appId": { "type": "string", "description": "The App ID of the app used for login." }, "appSecretSettingName": { "type": "string", "description": "The app setting name that contains the app secret." } }, "type": "object" }, "azure-native:app:AppRegistrationResponse": { "description": "The configuration settings of the app registration for providers that have app ids and app secrets", "properties": { "appId": { "type": "string", "description": "The App ID of the app used for login." }, "appSecretSettingName": { "type": "string", "description": "The app setting name that contains the app secret." } }, "type": "object" }, "azure-native:app:Apple": { "description": "The configuration settings of the Apple provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Apple provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopes", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AppleRegistration", "description": "The configuration settings of the Apple registration." } }, "type": "object" }, "azure-native:app:AppleRegistration": { "description": "The configuration settings of the registration for the Apple provider", "properties": { "clientId": { "type": "string", "description": "The Client ID of the app used for login." }, "clientSecretSettingName": { "type": "string", "description": "The app setting name that contains the client secret." } }, "type": "object" }, "azure-native:app:AppleRegistrationResponse": { "description": "The configuration settings of the registration for the Apple provider", "properties": { "clientId": { "type": "string", "description": "The Client ID of the app used for login." }, "clientSecretSettingName": { "type": "string", "description": "The app setting name that contains the client secret." } }, "type": "object" }, "azure-native:app:AppleResponse": { "description": "The configuration settings of the Apple provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Apple provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopesResponse", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AppleRegistrationResponse", "description": "The configuration settings of the Apple registration." } }, "type": "object" }, "azure-native:app:ApplicationInsightsConfiguration": { "description": "Application Insights Configuration", "properties": { "appId": { "type": "string", "description": "The Application ID for the Application Insights resource" }, "connectionString": { "type": "string", "description": "The connection string for the Application Insights resource" } }, "type": "object" }, "azure-native:app:ApplicationInsightsConfigurationResponse": { "description": "Application Insights Configuration", "properties": { "appId": { "type": "string", "description": "The Application ID for the Application Insights resource" }, "connectionString": { "type": "string", "description": "The connection string for the Application Insights resource" } }, "type": "object" }, "azure-native:app:AuthPlatform": { "description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e if the Authentication / Authorization feature is enabled for the current app; otherwise, \u003ccode\u003efalse\u003c/code\u003e." }, "runtimeVersion": { "type": "string", "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module." } }, "type": "object" }, "azure-native:app:AuthPlatformResponse": { "description": "The configuration settings of the platform of ContainerApp Service Authentication/Authorization.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e if the Authentication / Authorization feature is enabled for the current app; otherwise, \u003ccode\u003efalse\u003c/code\u003e." }, "runtimeVersion": { "type": "string", "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module." } }, "type": "object" }, "azure-native:app:AzureActiveDirectory": { "description": "The configuration settings of the Azure Active directory provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "isAutoProvisioned": { "type": "boolean", "description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryLogin", "description": "The configuration settings of the Azure Active Directory login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryRegistration", "description": "The configuration settings of the Azure Active Directory app registration." }, "validation": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryValidation", "description": "The configuration settings of the Azure Active Directory token validation flow." } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryLogin": { "description": "The configuration settings of the Azure Active Directory login flow.", "properties": { "disableWWWAuthenticate": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e if the www-authenticate provider should be omitted from the request; otherwise, \u003ccode\u003efalse\u003c/code\u003e." }, "loginParameters": { "type": "array", "items": { "type": "string" }, "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"." } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryLoginResponse": { "description": "The configuration settings of the Azure Active Directory login flow.", "properties": { "disableWWWAuthenticate": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e if the www-authenticate provider should be omitted from the request; otherwise, \u003ccode\u003efalse\u003c/code\u003e." }, "loginParameters": { "type": "array", "items": { "type": "string" }, "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\"." } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryRegistration": { "description": "The configuration settings of the Azure Active Directory app registration.", "properties": { "clientId": { "type": "string", "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html" }, "clientSecretCertificateIssuer": { "type": "string", "description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional." }, "clientSecretCertificateSubjectAlternativeName": { "type": "string", "description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional." }, "clientSecretCertificateThumbprint": { "type": "string", "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional." }, "clientSecretSettingName": { "type": "string", "description": "The app setting name that contains the client secret of the relying party application." }, "openIdIssuer": { "type": "string", "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html" } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryRegistrationResponse": { "description": "The configuration settings of the Azure Active Directory app registration.", "properties": { "clientId": { "type": "string", "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html" }, "clientSecretCertificateIssuer": { "type": "string", "description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional." }, "clientSecretCertificateSubjectAlternativeName": { "type": "string", "description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional." }, "clientSecretCertificateThumbprint": { "type": "string", "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional." }, "clientSecretSettingName": { "type": "string", "description": "The app setting name that contains the client secret of the relying party application." }, "openIdIssuer": { "type": "string", "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html" } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryResponse": { "description": "The configuration settings of the Azure Active directory provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "isAutoProvisioned": { "type": "boolean", "description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryLoginResponse", "description": "The configuration settings of the Azure Active Directory login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryRegistrationResponse", "description": "The configuration settings of the Azure Active Directory app registration." }, "validation": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryValidationResponse", "description": "The configuration settings of the Azure Active Directory token validation flow." } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryValidation": { "description": "The configuration settings of the Azure Active Directory token validation flow.", "properties": { "allowedAudiences": { "type": "array", "items": { "type": "string" }, "description": "The list of audiences that can make successful authentication/authorization requests." }, "defaultAuthorizationPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DefaultAuthorizationPolicy", "description": "The configuration settings of the default authorization policy." }, "jwtClaimChecks": { "type": "object", "$ref": "#/types/azure-native:app:JwtClaimChecks", "description": "The configuration settings of the checks that should be made while validating the JWT Claims." } }, "type": "object" }, "azure-native:app:AzureActiveDirectoryValidationResponse": { "description": "The configuration settings of the Azure Active Directory token validation flow.", "properties": { "allowedAudiences": { "type": "array", "items": { "type": "string" }, "description": "The list of audiences that can make successful authentication/authorization requests." }, "defaultAuthorizationPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DefaultAuthorizationPolicyResponse", "description": "The configuration settings of the default authorization policy." }, "jwtClaimChecks": { "type": "object", "$ref": "#/types/azure-native:app:JwtClaimChecksResponse", "description": "The configuration settings of the checks that should be made while validating the JWT Claims." } }, "type": "object" }, "azure-native:app:AzureCredentials": { "description": "Container App credentials.", "properties": { "clientId": { "type": "string", "description": "Client Id." }, "clientSecret": { "type": "string", "description": "Client Secret." }, "kind": { "type": "string", "description": "Kind of auth github does for deploying the template" }, "subscriptionId": { "type": "string", "description": "Subscription Id." }, "tenantId": { "type": "string", "description": "Tenant Id." } }, "type": "object" }, "azure-native:app:AzureCredentialsResponse": { "description": "Container App credentials.", "properties": { "subscriptionId": { "type": "string", "description": "Subscription Id." } }, "type": "object" }, "azure-native:app:AzureFileProperties": { "description": "Azure File Properties.", "properties": { "accessMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:AccessMode" } ], "description": "Access mode for storage" }, "accountKey": { "type": "string", "description": "Storage account key for azure file." }, "accountKeyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:app:SecretKeyVaultProperties", "description": "Storage account key stored as an Azure Key Vault secret." }, "accountName": { "type": "string", "description": "Storage account name for azure file." }, "shareName": { "type": "string", "description": "Azure file share name." } }, "type": "object" }, "azure-native:app:AzureFilePropertiesResponse": { "description": "Azure File Properties.", "properties": { "accessMode": { "type": "string", "description": "Access mode for storage" }, "accountKey": { "type": "string", "description": "Storage account key for azure file." }, "accountKeyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:app:SecretKeyVaultPropertiesResponse", "description": "Storage account key stored as an Azure Key Vault secret." }, "accountName": { "type": "string", "description": "Storage account name for azure file." }, "shareName": { "type": "string", "description": "Azure file share name." } }, "type": "object" }, "azure-native:app:AzureStaticWebApps": { "description": "The configuration settings of the Azure Static Web Apps provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AzureStaticWebAppsRegistration", "description": "The configuration settings of the Azure Static Web Apps registration." } }, "type": "object" }, "azure-native:app:AzureStaticWebAppsRegistration": { "description": "The configuration settings of the registration for the Azure Static Web Apps provider", "properties": { "clientId": { "type": "string", "description": "The Client ID of the app used for login." } }, "type": "object" }, "azure-native:app:AzureStaticWebAppsRegistrationResponse": { "description": "The configuration settings of the registration for the Azure Static Web Apps provider", "properties": { "clientId": { "type": "string", "description": "The Client ID of the app used for login." } }, "type": "object" }, "azure-native:app:AzureStaticWebAppsResponse": { "description": "The configuration settings of the Azure Static Web Apps provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AzureStaticWebAppsRegistrationResponse", "description": "The configuration settings of the Azure Static Web Apps registration." } }, "type": "object" }, "azure-native:app:BindingType": { "description": "Custom Domain binding type.", "type": "string", "enum": [ { "value": "Disabled" }, { "value": "SniEnabled" }, { "value": "Auto" } ] }, "azure-native:app:BlobStorageTokenStore": { "description": "The configuration settings of the storage of the tokens if blob storage is used.", "properties": { "blobContainerUri": { "type": "string", "description": "The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName." }, "clientId": { "type": "string", "description": "The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId." }, "managedIdentityResourceId": { "type": "string", "description": "The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId." }, "sasUrlSettingName": { "type": "string", "description": "The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri." } }, "type": "object" }, "azure-native:app:BlobStorageTokenStoreResponse": { "description": "The configuration settings of the storage of the tokens if blob storage is used.", "properties": { "blobContainerUri": { "type": "string", "description": "The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName." }, "clientId": { "type": "string", "description": "The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId." }, "managedIdentityResourceId": { "type": "string", "description": "The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId." }, "sasUrlSettingName": { "type": "string", "description": "The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri." } }, "type": "object" }, "azure-native:app:BuildConfiguration": { "description": "Configuration of the build.", "properties": { "baseOs": { "type": "string", "description": "Base OS used to build and run the app." }, "environmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVariable" }, "description": "List of environment variables to be passed to the build, secrets should not be used in environment variable." }, "platform": { "type": "string", "description": "Platform to be used to build and run the app." }, "platformVersion": { "type": "string", "description": "Platform version to be used to build and run the app." }, "preBuildSteps": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:PreBuildStep" }, "description": "List of steps to perform before the build." } }, "type": "object" }, "azure-native:app:BuildConfigurationResponse": { "description": "Configuration of the build.", "properties": { "baseOs": { "type": "string", "description": "Base OS used to build and run the app." }, "environmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVariableResponse" }, "description": "List of environment variables to be passed to the build, secrets should not be used in environment variable." }, "platform": { "type": "string", "description": "Platform to be used to build and run the app." }, "platformVersion": { "type": "string", "description": "Platform version to be used to build and run the app." }, "preBuildSteps": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:PreBuildStepResponse" }, "description": "List of steps to perform before the build." } }, "type": "object" }, "azure-native:app:CertificateKeyVaultProperties": { "description": "Properties for a certificate stored in a Key Vault.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "URL pointing to the Azure Key Vault secret that holds the certificate." } }, "type": "object" }, "azure-native:app:CertificateKeyVaultPropertiesResponse": { "description": "Properties for a certificate stored in a Key Vault.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "URL pointing to the Azure Key Vault secret that holds the certificate." } }, "type": "object" }, "azure-native:app:CertificateProperties": { "description": "Certificate resource specific properties", "properties": { "certificateKeyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:app:CertificateKeyVaultProperties", "description": "Properties for a certificate stored in a Key Vault." }, "certificateType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:CertificateType" } ], "description": "The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA`" }, "password": { "type": "string", "description": "Certificate password." }, "value": { "type": "string", "description": "PFX or PEM blob" } }, "type": "object" }, "azure-native:app:CertificateResponseProperties": { "description": "Certificate resource specific properties", "properties": { "certificateKeyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:app:CertificateKeyVaultPropertiesResponse", "description": "Properties for a certificate stored in a Key Vault." }, "certificateType": { "type": "string", "description": "The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA`" }, "deploymentErrors": { "type": "string", "description": "Any errors that occurred during deployment or deployment validation" }, "expirationDate": { "type": "string", "description": "Certificate expiration date." }, "issueDate": { "type": "string", "description": "Certificate issue Date." }, "issuer": { "type": "string", "description": "Certificate issuer." }, "provisioningState": { "type": "string", "description": "Provisioning state of the certificate." }, "publicKeyHash": { "type": "string", "description": "Public key hash." }, "subjectAlternativeNames": { "type": "array", "items": { "type": "string" }, "description": "Subject alternative names the certificate applies to." }, "subjectName": { "type": "string", "description": "Subject name of the certificate." }, "thumbprint": { "type": "string", "description": "Certificate thumbprint." }, "valid": { "type": "boolean", "description": "Is the certificate valid?." } }, "type": "object", "required": [ "deploymentErrors", "expirationDate", "issueDate", "issuer", "provisioningState", "publicKeyHash", "subjectAlternativeNames", "subjectName", "thumbprint", "valid" ] }, "azure-native:app:CertificateType": { "description": "The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA`", "type": "string", "enum": [ { "value": "ServerSSLCertificate" }, { "value": "ImagePullTrustedCA" } ] }, "azure-native:app:CircuitBreakerPolicy": { "description": "Policy that defines circuit breaker conditions", "properties": { "consecutiveErrors": { "type": "integer", "description": "Number of consecutive errors before the circuit breaker opens" }, "intervalInSeconds": { "type": "integer", "description": "The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s." }, "maxEjectionPercent": { "type": "integer", "description": "Maximum percentage of hosts that will be ejected after failure threshold has been met" } }, "type": "object" }, "azure-native:app:CircuitBreakerPolicyResponse": { "description": "Policy that defines circuit breaker conditions", "properties": { "consecutiveErrors": { "type": "integer", "description": "Number of consecutive errors before the circuit breaker opens" }, "intervalInSeconds": { "type": "integer", "description": "The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s." }, "maxEjectionPercent": { "type": "integer", "description": "Maximum percentage of hosts that will be ejected after failure threshold has been met" } }, "type": "object" }, "azure-native:app:ClientCredentialMethod": { "description": "The method that should be used to authenticate the user.", "type": "string", "enum": [ { "value": "ClientSecretPost" } ] }, "azure-native:app:ClientRegistration": { "description": "The configuration settings of the app registration for providers that have client ids and client secrets", "properties": { "clientId": { "type": "string", "description": "The Client ID of the app used for login." }, "clientSecretSettingName": { "type": "string", "description": "The app setting name that contains the client secret." } }, "type": "object" }, "azure-native:app:ClientRegistrationResponse": { "description": "The configuration settings of the app registration for providers that have client ids and client secrets", "properties": { "clientId": { "type": "string", "description": "The Client ID of the app used for login." }, "clientSecretSettingName": { "type": "string", "description": "The app setting name that contains the client secret." } }, "type": "object" }, "azure-native:app:Configuration": { "description": "Non versioned Container App configuration properties that define the mutable settings of a Container app", "properties": { "activeRevisionsMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:ActiveRevisionsMode" } ], "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\n\u003clist\u003e\u003citem\u003eSingle: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.\u003c/item\u003e\u003citem\u003eMultiple: Multiple revisions can be active, including optional traffic weights and labels.\u003c/item\u003e\u003citem\u003eLabels: Only revisions with labels are active. Traffic weights can be applied to labels.\u003c/item\u003e\u003c/list\u003e", "default": "Single" }, "dapr": { "type": "object", "$ref": "#/types/azure-native:app:Dapr", "description": "Dapr configuration for the Container App." }, "identitySettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IdentitySettings" }, "description": "Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used." }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:Ingress", "description": "Ingress configurations." }, "maxInactiveRevisions": { "type": "integer", "description": "Optional. Max inactive revisions a Container App can have." }, "registries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:RegistryCredentials" }, "description": "Collection of private container registry credentials for containers used by the Container app" }, "revisionTransitionThreshold": { "type": "integer", "description": "Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100." }, "runtime": { "type": "object", "$ref": "#/types/azure-native:app:Runtime", "description": "App runtime configuration for the Container App." }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Secret" }, "description": "Collection of secrets used by a Container app" }, "service": { "type": "object", "$ref": "#/types/azure-native:app:Service", "description": "Container App to be a dev Container App Service" }, "targetLabel": { "type": "string", "description": "Required in labels revisions mode. Label to apply to newly created revision." } }, "type": "object" }, "azure-native:app:ConfigurationResponse": { "description": "Non versioned Container App configuration properties that define the mutable settings of a Container app", "properties": { "activeRevisionsMode": { "type": "string", "description": "ActiveRevisionsMode controls how active revisions are handled for the Container app:\n\u003clist\u003e\u003citem\u003eSingle: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.\u003c/item\u003e\u003citem\u003eMultiple: Multiple revisions can be active, including optional traffic weights and labels.\u003c/item\u003e\u003citem\u003eLabels: Only revisions with labels are active. Traffic weights can be applied to labels.\u003c/item\u003e\u003c/list\u003e", "default": "Single" }, "dapr": { "type": "object", "$ref": "#/types/azure-native:app:DaprResponse", "description": "Dapr configuration for the Container App." }, "identitySettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IdentitySettingsResponse" }, "description": "Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used." }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:IngressResponse", "description": "Ingress configurations." }, "maxInactiveRevisions": { "type": "integer", "description": "Optional. Max inactive revisions a Container App can have." }, "registries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:RegistryCredentialsResponse" }, "description": "Collection of private container registry credentials for containers used by the Container app" }, "revisionTransitionThreshold": { "type": "integer", "description": "Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100." }, "runtime": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeResponse", "description": "App runtime configuration for the Container App." }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SecretResponse" }, "description": "Collection of secrets used by a Container app" }, "service": { "type": "object", "$ref": "#/types/azure-native:app:ServiceResponse", "description": "Container App to be a dev Container App Service" }, "targetLabel": { "type": "string", "description": "Required in labels revisions mode. Label to apply to newly created revision." } }, "type": "object" }, "azure-native:app:ConnectedEnvironmentStorageProperties": { "description": "Storage properties", "properties": { "azureFile": { "type": "object", "$ref": "#/types/azure-native:app:AzureFileProperties", "description": "Azure file properties" }, "smb": { "type": "object", "$ref": "#/types/azure-native:app:SmbStorage", "description": "SMB storage properties" } }, "type": "object" }, "azure-native:app:ConnectedEnvironmentStorageResponseProperties": { "description": "Storage properties", "properties": { "azureFile": { "type": "object", "$ref": "#/types/azure-native:app:AzureFilePropertiesResponse", "description": "Azure file properties" }, "deploymentErrors": { "type": "string", "description": "Any errors that occurred during deployment or deployment validation" }, "provisioningState": { "type": "string", "description": "Provisioning state of the storage." }, "smb": { "type": "object", "$ref": "#/types/azure-native:app:SmbStorageResponse", "description": "SMB storage properties" } }, "type": "object", "required": [ "deploymentErrors", "provisioningState" ] }, "azure-native:app:Container": { "description": "Container App container definition", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Container start command arguments." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Container start command." }, "env": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVar" }, "description": "Container environment variables." }, "image": { "type": "string", "description": "Container image tag." }, "imageType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:ImageType" } ], "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image." }, "name": { "type": "string", "description": "Custom container name." }, "probes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbe" }, "description": "List of probes for the container." }, "resources": { "type": "object", "$ref": "#/types/azure-native:app:ContainerResources", "description": "Container resource requirements." }, "volumeMounts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:VolumeMount" }, "description": "Container volume mounts." } }, "type": "object" }, "azure-native:app:ContainerAppPatchingConfiguration": { "description": "Container App auto patch configuration.", "properties": { "patchingMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:PatchingMode" } ], "description": "Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching." } }, "type": "object" }, "azure-native:app:ContainerAppProbe": { "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "properties": { "failureThreshold": { "type": "integer", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10." }, "httpGet": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeHttpGet", "description": "HTTPGet specifies the http request to perform." }, "initialDelaySeconds": { "type": "integer", "description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60." }, "periodSeconds": { "type": "integer", "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240." }, "successThreshold": { "type": "integer", "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10." }, "tcpSocket": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeTcpSocket", "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported." }, "terminationGracePeriodSeconds": { "type": "number", "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)" }, "timeoutSeconds": { "type": "integer", "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:Type" } ], "description": "The type of probe." } }, "type": "object" }, "azure-native:app:ContainerAppProbeHttpGet": { "description": "HTTPGet specifies the http request to perform.", "properties": { "host": { "type": "string", "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." }, "httpHeaders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeHttpHeaders" }, "description": "Custom headers to set in the request. HTTP allows repeated headers." }, "path": { "type": "string", "description": "Path to access on the HTTP server." }, "port": { "type": "integer", "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." }, "scheme": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:Scheme" } ], "description": "Scheme to use for connecting to the host. Defaults to HTTP." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:ContainerAppProbeHttpHeaders": { "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "type": "string", "description": "The header field name" }, "value": { "type": "string", "description": "The header field value" } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:ContainerAppProbeResponse": { "description": "Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic.", "properties": { "failureThreshold": { "type": "integer", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10." }, "httpGet": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeResponseHttpGet", "description": "HTTPGet specifies the http request to perform." }, "initialDelaySeconds": { "type": "integer", "description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60." }, "periodSeconds": { "type": "integer", "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240." }, "successThreshold": { "type": "integer", "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10." }, "tcpSocket": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeResponseTcpSocket", "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported." }, "terminationGracePeriodSeconds": { "type": "number", "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)" }, "timeoutSeconds": { "type": "integer", "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240." }, "type": { "type": "string", "description": "The type of probe." } }, "type": "object" }, "azure-native:app:ContainerAppProbeResponseHttpGet": { "description": "HTTPGet specifies the http request to perform.", "properties": { "host": { "type": "string", "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." }, "httpHeaders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeResponseHttpHeaders" }, "description": "Custom headers to set in the request. HTTP allows repeated headers." }, "path": { "type": "string", "description": "Path to access on the HTTP server." }, "port": { "type": "integer", "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." }, "scheme": { "type": "string", "description": "Scheme to use for connecting to the host. Defaults to HTTP." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:ContainerAppProbeResponseHttpHeaders": { "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "type": "string", "description": "The header field name" }, "value": { "type": "string", "description": "The header field value" } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:ContainerAppProbeResponseTcpSocket": { "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.", "properties": { "host": { "type": "string", "description": "Optional: Host name to connect to, defaults to the pod IP." }, "port": { "type": "integer", "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:ContainerAppProbeTcpSocket": { "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.", "properties": { "host": { "type": "string", "description": "Optional: Host name to connect to, defaults to the pod IP." }, "port": { "type": "integer", "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:ContainerAppResponsePatchingConfiguration": { "description": "Container App auto patch configuration.", "properties": { "patchingMode": { "type": "string", "description": "Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching." } }, "type": "object" }, "azure-native:app:ContainerAppSecretResponse": { "description": "Container App Secret.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "Azure Key Vault URL pointing to the secret referenced by the container app." }, "name": { "type": "string", "description": "Secret Name." }, "value": { "type": "string", "description": "Secret Value." } }, "type": "object", "required": [ "identity", "keyVaultUrl", "name", "value" ] }, "azure-native:app:ContainerRegistry": { "description": "Model representing a mapping from a container registry to the identity used to connect to it.", "properties": { "containerRegistryServer": { "type": "string", "description": "Login server of the container registry." }, "identityResourceId": { "type": "string", "description": "Resource ID of the managed identity." } }, "type": "object", "required": [ "containerRegistryServer", "identityResourceId" ] }, "azure-native:app:ContainerRegistryResponse": { "description": "Model representing a mapping from a container registry to the identity used to connect to it.", "properties": { "containerRegistryServer": { "type": "string", "description": "Login server of the container registry." }, "identityResourceId": { "type": "string", "description": "Resource ID of the managed identity." } }, "type": "object", "required": [ "containerRegistryServer", "identityResourceId" ] }, "azure-native:app:ContainerRegistryWithCustomImage": { "description": "Container registry that the final image will be uploaded to.", "properties": { "image": { "type": "string", "description": "Full name that the final image should be uploaded as, including both image name and tag." }, "server": { "type": "string", "description": "Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it." } }, "type": "object", "required": [ "server" ] }, "azure-native:app:ContainerRegistryWithCustomImageResponse": { "description": "Container registry that the final image will be uploaded to.", "properties": { "image": { "type": "string", "description": "Full name that the final image should be uploaded as, including both image name and tag." }, "server": { "type": "string", "description": "Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it." } }, "type": "object", "required": [ "server" ] }, "azure-native:app:ContainerResources": { "description": "Container App container resource requirements.", "properties": { "cpu": { "type": "number", "description": "Required CPU in cores, e.g. 0.5" }, "gpu": { "type": "number", "description": "Required GPU in cores for GPU based app, e.g. 1.0" }, "memory": { "type": "string", "description": "Required memory, e.g. \"250Mb\"" } }, "type": "object" }, "azure-native:app:ContainerResourcesResponse": { "description": "Container App container resource requirements.", "properties": { "cpu": { "type": "number", "description": "Required CPU in cores, e.g. 0.5" }, "ephemeralStorage": { "type": "string", "description": "Ephemeral Storage, e.g. \"1Gi\"" }, "gpu": { "type": "number", "description": "Required GPU in cores for GPU based app, e.g. 1.0" }, "memory": { "type": "string", "description": "Required memory, e.g. \"250Mb\"" } }, "type": "object", "required": [ "ephemeralStorage" ] }, "azure-native:app:ContainerResponse": { "description": "Container App container definition", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Container start command arguments." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Container start command." }, "env": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVarResponse" }, "description": "Container environment variables." }, "image": { "type": "string", "description": "Container image tag." }, "imageType": { "type": "string", "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image." }, "name": { "type": "string", "description": "Custom container name." }, "probes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ContainerAppProbeResponse" }, "description": "List of probes for the container." }, "resources": { "type": "object", "$ref": "#/types/azure-native:app:ContainerResourcesResponse", "description": "Container resource requirements." }, "volumeMounts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:VolumeMountResponse" }, "description": "Container volume mounts." } }, "type": "object" }, "azure-native:app:ContainerType": { "description": "The container type of the sessions.", "type": "string", "enum": [ { "value": "CustomContainer" }, { "value": "PythonLTS" } ] }, "azure-native:app:CookieExpiration": { "description": "The configuration settings of the session cookie's expiration.", "properties": { "convention": { "$ref": "#/types/azure-native:app:CookieExpirationConvention", "description": "The convention used when determining the session cookie's expiration." }, "timeToExpiration": { "type": "string", "description": "The time after the request is made when the session cookie should expire." } }, "type": "object" }, "azure-native:app:CookieExpirationConvention": { "description": "The convention used when determining the session cookie's expiration.", "type": "string", "enum": [ { "value": "FixedTime" }, { "value": "IdentityProviderDerived" } ] }, "azure-native:app:CookieExpirationResponse": { "description": "The configuration settings of the session cookie's expiration.", "properties": { "convention": { "type": "string", "description": "The convention used when determining the session cookie's expiration." }, "timeToExpiration": { "type": "string", "description": "The time after the request is made when the session cookie should expire." } }, "type": "object" }, "azure-native:app:CorsPolicy": { "description": "Cross-Origin-Resource-Sharing policy", "properties": { "allowCredentials": { "type": "boolean", "description": "Specifies whether the resource allows credentials" }, "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-allow-headers header" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-allow-methods header" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-allow-origins header" }, "exposeHeaders": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-expose-headers header " }, "maxAge": { "type": "integer", "description": "Specifies the content for the access-control-max-age header" } }, "type": "object", "required": [ "allowedOrigins" ] }, "azure-native:app:CorsPolicyResponse": { "description": "Cross-Origin-Resource-Sharing policy", "properties": { "allowCredentials": { "type": "boolean", "description": "Specifies whether the resource allows credentials" }, "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-allow-headers header" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-allow-methods header" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-allow-origins header" }, "exposeHeaders": { "type": "array", "items": { "type": "string" }, "description": "Specifies the content for the access-control-expose-headers header " }, "maxAge": { "type": "integer", "description": "Specifies the content for the access-control-max-age header" } }, "type": "object", "required": [ "allowedOrigins" ] }, "azure-native:app:CustomContainerTemplate": { "description": "Custom container configuration.", "properties": { "containers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SessionContainer" }, "description": "List of container definitions for the sessions of the session pool." }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:SessionIngress", "description": "Session pool ingress configuration." }, "registryCredentials": { "type": "object", "$ref": "#/types/azure-native:app:SessionRegistryCredentials", "description": "Private container registry credentials for containers used by the sessions of the session pool." } }, "type": "object" }, "azure-native:app:CustomContainerTemplateResponse": { "description": "Custom container configuration.", "properties": { "containers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SessionContainerResponse" }, "description": "List of container definitions for the sessions of the session pool." }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:SessionIngressResponse", "description": "Session pool ingress configuration." }, "registryCredentials": { "type": "object", "$ref": "#/types/azure-native:app:SessionRegistryCredentialsResponse", "description": "Private container registry credentials for containers used by the sessions of the session pool." } }, "type": "object" }, "azure-native:app:CustomDomain": { "description": "Custom Domain of a Container App", "properties": { "bindingType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:BindingType" } ], "description": "Custom Domain binding type." }, "certificateId": { "type": "string", "description": "Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment." }, "name": { "type": "string", "description": "Hostname." } }, "type": "object", "required": [ "name" ] }, "azure-native:app:CustomDomainConfiguration": { "description": "Configuration properties for apps environment custom domain", "properties": { "certificateKeyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:app:CertificateKeyVaultProperties", "description": "Certificate stored in Azure Key Vault." }, "certificatePassword": { "type": "string", "description": "Certificate password" }, "certificateValue": { "type": "string", "description": "PFX or PEM blob" }, "dnsSuffix": { "type": "string", "description": "Dns suffix for the environment domain" } }, "type": "object" }, "azure-native:app:CustomDomainConfigurationResponse": { "description": "Configuration properties for apps environment custom domain", "properties": { "certificateKeyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:app:CertificateKeyVaultPropertiesResponse", "description": "Certificate stored in Azure Key Vault." }, "certificatePassword": { "type": "string", "description": "Certificate password" }, "certificateValue": { "type": "string", "description": "PFX or PEM blob" }, "customDomainVerificationId": { "type": "string", "description": "Id used to verify domain name ownership" }, "dnsSuffix": { "type": "string", "description": "Dns suffix for the environment domain" }, "expirationDate": { "type": "string", "description": "Certificate expiration date." }, "subjectName": { "type": "string", "description": "Subject name of the certificate." }, "thumbprint": { "type": "string", "description": "Certificate thumbprint." } }, "type": "object", "required": [ "customDomainVerificationId", "expirationDate", "subjectName", "thumbprint" ] }, "azure-native:app:CustomDomainResponse": { "description": "Custom Domain of a Container App", "properties": { "bindingType": { "type": "string", "description": "Custom Domain binding type." }, "certificateId": { "type": "string", "description": "Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment." }, "name": { "type": "string", "description": "Hostname." } }, "type": "object", "required": [ "name" ] }, "azure-native:app:CustomHostnameAnalysisResultResponseCustomDomainVerificationFailureInfo": { "description": "Raw failure information if DNS verification fails.", "properties": { "code": { "type": "string", "description": "Standardized string to programmatically identify the error." }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:CustomHostnameAnalysisResultResponseDetails" }, "description": "Details or the error" }, "message": { "type": "string", "description": "Detailed error description and debugging information." }, "target": { "type": "string", "description": "Detailed error description and debugging information." } }, "type": "object", "required": [ "code", "message", "target" ] }, "azure-native:app:CustomHostnameAnalysisResultResponseDetails": { "description": "Detailed errors.", "properties": { "code": { "type": "string", "description": "Standardized string to programmatically identify the error." }, "message": { "type": "string", "description": "Detailed error description and debugging information." }, "target": { "type": "string", "description": "Detailed error description and debugging information." } }, "type": "object", "required": [ "code", "message", "target" ] }, "azure-native:app:CustomOpenIdConnectProvider": { "description": "The configuration settings of the custom Open ID Connect provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the custom Open ID provider provider should not be enabled; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectLogin", "description": "The configuration settings of the login flow of the custom Open ID Connect provider." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectRegistration", "description": "The configuration settings of the app registration for the custom Open ID Connect provider." } }, "type": "object" }, "azure-native:app:CustomOpenIdConnectProviderResponse": { "description": "The configuration settings of the custom Open ID Connect provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the custom Open ID provider provider should not be enabled; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectLoginResponse", "description": "The configuration settings of the login flow of the custom Open ID Connect provider." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectRegistrationResponse", "description": "The configuration settings of the app registration for the custom Open ID Connect provider." } }, "type": "object" }, "azure-native:app:CustomScaleRule": { "description": "Container App container Custom scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuth" }, "description": "Authentication secrets for the custom scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe custom scale rule." }, "type": { "type": "string", "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc." } }, "type": "object" }, "azure-native:app:CustomScaleRuleResponse": { "description": "Container App container Custom scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the custom scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe custom scale rule." }, "type": { "type": "string", "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc." } }, "type": "object" }, "azure-native:app:Dapr": { "description": "Container App Dapr configuration.", "properties": { "appHealth": { "type": "object", "$ref": "#/types/azure-native:app:DaprAppHealth", "description": "Dapr application health check configuration" }, "appId": { "type": "string", "description": "Dapr application identifier" }, "appPort": { "type": "integer", "description": "Tells Dapr which port your application is listening on" }, "appProtocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:AppProtocol" } ], "description": "Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http", "default": "http" }, "enableApiLogging": { "type": "boolean", "description": "Enables API logging for the Dapr sidecar" }, "enabled": { "type": "boolean", "description": "Boolean indicating if the Dapr side car is enabled", "default": false }, "httpMaxRequestSize": { "type": "integer", "description": "Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB." }, "httpReadBufferSize": { "type": "integer", "description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB." }, "logLevel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:LogLevel" } ], "description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info." }, "maxConcurrency": { "type": "integer", "description": "Maximum number of concurrent requests, events handled by the Dapr sidecar" } }, "type": "object" }, "azure-native:app:DaprAppHealth": { "description": "Dapr application health check configuration", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating if the health probe is enabled" }, "path": { "type": "string", "description": "Path for the health probe" }, "probeIntervalSeconds": { "type": "integer", "description": "Interval for the health probe in seconds" }, "probeTimeoutMilliseconds": { "type": "integer", "description": "Timeout for the health probe in milliseconds" }, "threshold": { "type": "integer", "description": "Threshold for the health probe" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration": { "description": "Dapr Component Resiliency Policy Circuit Breaker Policy Configuration.", "properties": { "consecutiveErrors": { "type": "integer", "description": "The number of consecutive errors before the circuit is opened." }, "intervalInSeconds": { "type": "integer", "description": "The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used." }, "timeoutInSeconds": { "type": "integer", "description": "The interval in seconds until a retry attempt is made after the circuit is opened." } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyCircuitBreakerPolicyConfigurationResponse": { "description": "Dapr Component Resiliency Policy Circuit Breaker Policy Configuration.", "properties": { "consecutiveErrors": { "type": "integer", "description": "The number of consecutive errors before the circuit is opened." }, "intervalInSeconds": { "type": "integer", "description": "The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used." }, "timeoutInSeconds": { "type": "integer", "description": "The interval in seconds until a retry attempt is made after the circuit is opened." } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyConfiguration": { "description": "Dapr Component Resiliency Policy Configuration.", "properties": { "circuitBreakerPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyCircuitBreakerPolicyConfiguration", "description": "The optional circuit breaker policy configuration" }, "httpRetryPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration", "description": "The optional HTTP retry policy configuration" }, "timeoutPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyTimeoutPolicyConfiguration", "description": "The optional timeout policy configuration" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyConfigurationResponse": { "description": "Dapr Component Resiliency Policy Configuration.", "properties": { "circuitBreakerPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyCircuitBreakerPolicyConfigurationResponse", "description": "The optional circuit breaker policy configuration" }, "httpRetryPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyHttpRetryPolicyConfigurationResponse", "description": "The optional HTTP retry policy configuration" }, "timeoutPolicy": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyTimeoutPolicyConfigurationResponse", "description": "The optional timeout policy configuration" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration": { "description": "Dapr Component Resiliency Policy HTTP Retry Backoff Configuration.", "properties": { "initialDelayInMilliseconds": { "type": "integer", "description": "The optional initial delay in milliseconds before an operation is retried" }, "maxIntervalInMilliseconds": { "type": "integer", "description": "The optional maximum time interval in milliseconds between retry attempts" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyHttpRetryBackOffConfigurationResponse": { "description": "Dapr Component Resiliency Policy HTTP Retry Backoff Configuration.", "properties": { "initialDelayInMilliseconds": { "type": "integer", "description": "The optional initial delay in milliseconds before an operation is retried" }, "maxIntervalInMilliseconds": { "type": "integer", "description": "The optional maximum time interval in milliseconds between retry attempts" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyHttpRetryPolicyConfiguration": { "description": "Dapr Component Resiliency Policy HTTP Retry Policy Configuration.", "properties": { "maxRetries": { "type": "integer", "description": "The optional maximum number of retries" }, "retryBackOff": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyHttpRetryBackOffConfiguration", "description": "The optional retry backoff configuration" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyHttpRetryPolicyConfigurationResponse": { "description": "Dapr Component Resiliency Policy HTTP Retry Policy Configuration.", "properties": { "maxRetries": { "type": "integer", "description": "The optional maximum number of retries" }, "retryBackOff": { "type": "object", "$ref": "#/types/azure-native:app:DaprComponentResiliencyPolicyHttpRetryBackOffConfigurationResponse", "description": "The optional retry backoff configuration" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyTimeoutPolicyConfiguration": { "description": "Dapr Component Resiliency Policy Timeout Policy Configuration.", "properties": { "responseTimeoutInSeconds": { "type": "integer", "description": "The optional response timeout in seconds" } }, "type": "object" }, "azure-native:app:DaprComponentResiliencyPolicyTimeoutPolicyConfigurationResponse": { "description": "Dapr Component Resiliency Policy Timeout Policy Configuration.", "properties": { "responseTimeoutInSeconds": { "type": "integer", "description": "The optional response timeout in seconds" } }, "type": "object" }, "azure-native:app:DaprComponentServiceBinding": { "description": "Configuration to bind a Dapr Component to a dev ContainerApp Service", "properties": { "metadata": { "type": "object", "$ref": "#/types/azure-native:app:DaprServiceBindMetadata", "description": "Service bind metadata" }, "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:DaprComponentServiceBindingResponse": { "description": "Configuration to bind a Dapr Component to a dev ContainerApp Service", "properties": { "metadata": { "type": "object", "$ref": "#/types/azure-native:app:DaprServiceBindMetadataResponse", "description": "Service bind metadata" }, "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:DaprConfigurationResponse": { "description": "Configuration properties Dapr component", "properties": { "version": { "type": "string", "description": "The version of Dapr" } }, "type": "object", "required": [ "version" ] }, "azure-native:app:DaprMetadata": { "description": "Dapr component metadata.", "properties": { "name": { "type": "string", "description": "Metadata property name." }, "secretRef": { "type": "string", "description": "Name of the Dapr Component secret from which to pull the metadata property value." }, "value": { "type": "string", "description": "Metadata property value." } }, "type": "object" }, "azure-native:app:DaprMetadataResponse": { "description": "Dapr component metadata.", "properties": { "name": { "type": "string", "description": "Metadata property name." }, "secretRef": { "type": "string", "description": "Name of the Dapr Component secret from which to pull the metadata property value." }, "value": { "type": "string", "description": "Metadata property value." } }, "type": "object" }, "azure-native:app:DaprResponse": { "description": "Container App Dapr configuration.", "properties": { "appHealth": { "type": "object", "$ref": "#/types/azure-native:app:DaprResponseAppHealth", "description": "Dapr application health check configuration" }, "appId": { "type": "string", "description": "Dapr application identifier" }, "appPort": { "type": "integer", "description": "Tells Dapr which port your application is listening on" }, "appProtocol": { "type": "string", "description": "Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http", "default": "http" }, "enableApiLogging": { "type": "boolean", "description": "Enables API logging for the Dapr sidecar" }, "enabled": { "type": "boolean", "description": "Boolean indicating if the Dapr side car is enabled", "default": false }, "httpMaxRequestSize": { "type": "integer", "description": "Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB." }, "httpReadBufferSize": { "type": "integer", "description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB." }, "logLevel": { "type": "string", "description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info." }, "maxConcurrency": { "type": "integer", "description": "Maximum number of concurrent requests, events handled by the Dapr sidecar" } }, "type": "object" }, "azure-native:app:DaprResponseAppHealth": { "description": "Dapr application health check configuration", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating if the health probe is enabled" }, "path": { "type": "string", "description": "Path for the health probe" }, "probeIntervalSeconds": { "type": "integer", "description": "Interval for the health probe in seconds" }, "probeTimeoutMilliseconds": { "type": "integer", "description": "Timeout for the health probe in milliseconds" }, "threshold": { "type": "integer", "description": "Threshold for the health probe" } }, "type": "object" }, "azure-native:app:DaprSecretResponse": { "description": "Dapr component Secret for ListSecrets Action", "properties": { "name": { "type": "string", "description": "Secret Name." }, "value": { "type": "string", "description": "Secret Value." } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:DaprServiceBindMetadata": { "description": "Dapr component metadata.", "properties": { "name": { "type": "string", "description": "Service bind metadata property name." }, "value": { "type": "string", "description": "Service bind metadata property value." } }, "type": "object" }, "azure-native:app:DaprServiceBindMetadataResponse": { "description": "Dapr component metadata.", "properties": { "name": { "type": "string", "description": "Service bind metadata property name." }, "value": { "type": "string", "description": "Service bind metadata property value." } }, "type": "object" }, "azure-native:app:DaprSubscriptionBulkSubscribeOptions": { "description": "Dapr PubSub Bulk Subscription Options.", "properties": { "enabled": { "type": "boolean", "description": "Enable bulk subscription", "default": false }, "maxAwaitDurationMs": { "type": "integer", "description": "Maximum duration in milliseconds to wait before a bulk message is sent to the app." }, "maxMessagesCount": { "type": "integer", "description": "Maximum number of messages to deliver in a bulk message." } }, "type": "object" }, "azure-native:app:DaprSubscriptionBulkSubscribeOptionsResponse": { "description": "Dapr PubSub Bulk Subscription Options.", "properties": { "enabled": { "type": "boolean", "description": "Enable bulk subscription", "default": false }, "maxAwaitDurationMs": { "type": "integer", "description": "Maximum duration in milliseconds to wait before a bulk message is sent to the app." }, "maxMessagesCount": { "type": "integer", "description": "Maximum number of messages to deliver in a bulk message." } }, "type": "object" }, "azure-native:app:DaprSubscriptionRouteRule": { "description": "Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path.", "properties": { "match": { "type": "string", "description": "The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list." }, "path": { "type": "string", "description": "The path for events that match this rule" } }, "type": "object" }, "azure-native:app:DaprSubscriptionRouteRuleResponse": { "description": "Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path.", "properties": { "match": { "type": "string", "description": "The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list." }, "path": { "type": "string", "description": "The path for events that match this rule" } }, "type": "object" }, "azure-native:app:DaprSubscriptionRoutes": { "description": "Dapr PubSub Event Subscription Routes configuration.", "properties": { "default": { "type": "string", "description": "The default path to deliver events that do not match any of the rules." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:DaprSubscriptionRouteRule" }, "description": "The list of Dapr PubSub Event Subscription Route Rules." } }, "type": "object" }, "azure-native:app:DaprSubscriptionRoutesResponse": { "description": "Dapr PubSub Event Subscription Routes configuration.", "properties": { "default": { "type": "string", "description": "The default path to deliver events that do not match any of the rules." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:DaprSubscriptionRouteRuleResponse" }, "description": "The list of Dapr PubSub Event Subscription Route Rules." } }, "type": "object" }, "azure-native:app:DataDogConfiguration": { "description": "Configuration of datadog ", "properties": { "key": { "type": "string", "description": "The data dog api key" }, "site": { "type": "string", "description": "The data dog site" } }, "type": "object" }, "azure-native:app:DataDogConfigurationResponse": { "description": "Configuration of datadog ", "properties": { "key": { "type": "string", "description": "The data dog api key" }, "site": { "type": "string", "description": "The data dog site" } }, "type": "object" }, "azure-native:app:DefaultAuthorizationPolicy": { "description": "The configuration settings of the Azure Active Directory default authorization policy.", "properties": { "allowedApplications": { "type": "array", "items": { "type": "string" }, "description": "The configuration settings of the Azure Active Directory allowed applications." }, "allowedPrincipals": { "type": "object", "$ref": "#/types/azure-native:app:AllowedPrincipals", "description": "The configuration settings of the Azure Active Directory allowed principals." } }, "type": "object" }, "azure-native:app:DefaultAuthorizationPolicyResponse": { "description": "The configuration settings of the Azure Active Directory default authorization policy.", "properties": { "allowedApplications": { "type": "array", "items": { "type": "string" }, "description": "The configuration settings of the Azure Active Directory allowed applications." }, "allowedPrincipals": { "type": "object", "$ref": "#/types/azure-native:app:AllowedPrincipalsResponse", "description": "The configuration settings of the Azure Active Directory allowed principals." } }, "type": "object" }, "azure-native:app:DefaultModel": { "description": "Default AI model configuration", "properties": { "name": { "type": "string", "description": "Model name (e.g., gpt-5, claude-opus-4-5, claude-sonnet-4-5)" }, "provider": { "type": "string", "description": "AI provider name (e.g., MicrosoftFoundry, Anthropic)" } }, "type": "object" }, "azure-native:app:DefaultModelResponse": { "description": "Default AI model configuration", "properties": { "name": { "type": "string", "description": "Model name (e.g., gpt-5, claude-opus-4-5, claude-sonnet-4-5)" }, "provider": { "type": "string", "description": "AI provider name (e.g., MicrosoftFoundry, Anthropic)" } }, "type": "object" }, "azure-native:app:DestinationsConfiguration": { "description": "Configuration of Open Telemetry destinations", "properties": { "dataDogConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:DataDogConfiguration", "description": "Open telemetry datadog destination configuration" }, "otlpConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:OtlpConfiguration" }, "description": "Open telemetry otlp configurations" } }, "type": "object" }, "azure-native:app:DestinationsConfigurationResponse": { "description": "Configuration of Open Telemetry destinations", "properties": { "dataDogConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:DataDogConfigurationResponse", "description": "Open telemetry datadog destination configuration" }, "otlpConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:OtlpConfigurationResponse" }, "description": "Open telemetry otlp configurations" } }, "type": "object" }, "azure-native:app:DiskEncryptionConfiguration": { "description": "Configuration properties for disk encryption", "properties": { "keyVaultConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:DiskEncryptionConfigurationKeyVaultConfiguration", "description": "The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment." } }, "type": "object" }, "azure-native:app:DiskEncryptionConfigurationAuth": { "description": "Configuration properties for the authentication to the Key Vault", "properties": { "identity": { "type": "string", "description": "Resource ID of a user-assigned managed identity to authenticate to the Key Vault. The identity must be assigned to the managed environment, in the same tenant as the Key Vault, and it must have the following key permissions on the Key Vault: wrapkey, unwrapkey, get." } }, "type": "object" }, "azure-native:app:DiskEncryptionConfigurationKeyVaultConfiguration": { "description": "The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment.", "properties": { "auth": { "type": "object", "$ref": "#/types/azure-native:app:DiskEncryptionConfigurationAuth", "description": "Configuration properties for the authentication to the Key Vault" }, "keyUrl": { "type": "string", "description": "Key URL pointing to a key in KeyVault. Version segment of the Url is required." } }, "type": "object" }, "azure-native:app:DiskEncryptionConfigurationResponse": { "description": "Configuration properties for disk encryption", "properties": { "keyVaultConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:DiskEncryptionConfigurationResponseKeyVaultConfiguration", "description": "The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment." } }, "type": "object" }, "azure-native:app:DiskEncryptionConfigurationResponseAuth": { "description": "Configuration properties for the authentication to the Key Vault", "properties": { "identity": { "type": "string", "description": "Resource ID of a user-assigned managed identity to authenticate to the Key Vault. The identity must be assigned to the managed environment, in the same tenant as the Key Vault, and it must have the following key permissions on the Key Vault: wrapkey, unwrapkey, get." } }, "type": "object" }, "azure-native:app:DiskEncryptionConfigurationResponseKeyVaultConfiguration": { "description": "The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment.", "properties": { "auth": { "type": "object", "$ref": "#/types/azure-native:app:DiskEncryptionConfigurationResponseAuth", "description": "Configuration properties for the authentication to the Key Vault" }, "keyUrl": { "type": "string", "description": "Key URL pointing to a key in KeyVault. Version segment of the Url is required." } }, "type": "object" }, "azure-native:app:DotNetComponentConfigurationProperty": { "description": "Configuration properties for a .NET Component", "properties": { "propertyName": { "type": "string", "description": "The name of the property" }, "value": { "type": "string", "description": "The value of the property" } }, "type": "object" }, "azure-native:app:DotNetComponentConfigurationPropertyResponse": { "description": "Configuration properties for a .NET Component", "properties": { "propertyName": { "type": "string", "description": "The name of the property" }, "value": { "type": "string", "description": "The value of the property" } }, "type": "object" }, "azure-native:app:DotNetComponentServiceBind": { "description": "Configuration to bind a .NET Component to another .NET Component", "properties": { "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:DotNetComponentServiceBindResponse": { "description": "Configuration to bind a .NET Component to another .NET Component", "properties": { "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:DotNetComponentType": { "description": "Type of the .NET Component.", "type": "string", "enum": [ { "value": "AspireDashboard" } ] }, "azure-native:app:DynamicPoolConfiguration": { "description": "Dynamic pool configuration.", "properties": { "lifecycleConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LifecycleConfiguration", "description": "The lifecycle configuration of a session in the dynamic session pool" } }, "type": "object" }, "azure-native:app:DynamicPoolConfigurationResponse": { "description": "Dynamic pool configuration.", "properties": { "lifecycleConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LifecycleConfigurationResponse", "description": "The lifecycle configuration of a session in the dynamic session pool" } }, "type": "object" }, "azure-native:app:EncryptionSettings": { "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.", "properties": { "containerAppAuthEncryptionSecretName": { "type": "string", "description": "The secret name which is referenced for EncryptionKey." }, "containerAppAuthSigningSecretName": { "type": "string", "description": "The secret name which is referenced for SigningKey." } }, "type": "object" }, "azure-native:app:EncryptionSettingsResponse": { "description": "The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization.", "properties": { "containerAppAuthEncryptionSecretName": { "type": "string", "description": "The secret name which is referenced for EncryptionKey." }, "containerAppAuthSigningSecretName": { "type": "string", "description": "The secret name which is referenced for SigningKey." } }, "type": "object" }, "azure-native:app:EnvironmentVar": { "description": "Container App container environment variable.", "properties": { "name": { "type": "string", "description": "Environment variable name." }, "secretRef": { "type": "string", "description": "Name of the Container App secret from which to pull the environment variable value." }, "value": { "type": "string", "description": "Non-secret environment variable value." } }, "type": "object" }, "azure-native:app:EnvironmentVarResponse": { "description": "Container App container environment variable.", "properties": { "name": { "type": "string", "description": "Environment variable name." }, "secretRef": { "type": "string", "description": "Name of the Container App secret from which to pull the environment variable value." }, "value": { "type": "string", "description": "Non-secret environment variable value." } }, "type": "object" }, "azure-native:app:EnvironmentVariable": { "description": "Model representing an environment variable.", "properties": { "name": { "type": "string", "description": "Environment variable name." }, "value": { "type": "string", "description": "Environment variable value." } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:EnvironmentVariableResponse": { "description": "Model representing an environment variable.", "properties": { "name": { "type": "string", "description": "Environment variable name." }, "value": { "type": "string", "description": "Environment variable value." } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:ErrorEntityResponse": { "description": "Body of the error response returned from the API.", "properties": { "code": { "type": "string", "description": "Basic error code." }, "details": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ErrorEntityResponse" }, "description": "Error Details." }, "extendedCode": { "type": "string", "description": "Type of error." }, "innerErrors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ErrorEntityResponse" }, "description": "Inner errors." }, "message": { "type": "string", "description": "Any details of the error." }, "messageTemplate": { "type": "string", "description": "Message template." }, "parameters": { "type": "array", "items": { "type": "string" }, "description": "Parameters for the template." }, "target": { "type": "string", "description": "The error target." } }, "type": "object" }, "azure-native:app:ExtendedLocation": { "description": "The complex type of the extended location.", "properties": { "name": { "type": "string", "description": "The name of the extended location." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:ExtendedLocationTypes" } ], "description": "The type of the extended location." } }, "type": "object" }, "azure-native:app:ExtendedLocationResponse": { "description": "The complex type of the extended location.", "properties": { "name": { "type": "string", "description": "The name of the extended location." }, "type": { "type": "string", "description": "The type of the extended location." } }, "type": "object" }, "azure-native:app:ExtendedLocationTypes": { "description": "The type of the extended location.", "type": "string", "enum": [ { "value": "CustomLocation" } ] }, "azure-native:app:Facebook": { "description": "The configuration settings of the Facebook provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Facebook provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "graphApiVersion": { "type": "string", "description": "The version of the Facebook api to be used while logging in." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopes", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AppRegistration", "description": "The configuration settings of the app registration for the Facebook provider." } }, "type": "object" }, "azure-native:app:FacebookResponse": { "description": "The configuration settings of the Facebook provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Facebook provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "graphApiVersion": { "type": "string", "description": "The version of the Facebook api to be used while logging in." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopesResponse", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:AppRegistrationResponse", "description": "The configuration settings of the app registration for the Facebook provider." } }, "type": "object" }, "azure-native:app:ForwardProxy": { "description": "The configuration settings of a forward proxy used to make the requests.", "properties": { "convention": { "$ref": "#/types/azure-native:app:ForwardProxyConvention", "description": "The convention used to determine the url of the request made." }, "customHostHeaderName": { "type": "string", "description": "The name of the header containing the host of the request." }, "customProtoHeaderName": { "type": "string", "description": "The name of the header containing the scheme of the request." } }, "type": "object" }, "azure-native:app:ForwardProxyConvention": { "description": "The convention used to determine the url of the request made.", "type": "string", "enum": [ { "value": "NoProxy" }, { "value": "Standard" }, { "value": "Custom" } ] }, "azure-native:app:ForwardProxyResponse": { "description": "The configuration settings of a forward proxy used to make the requests.", "properties": { "convention": { "type": "string", "description": "The convention used to determine the url of the request made." }, "customHostHeaderName": { "type": "string", "description": "The name of the header containing the host of the request." }, "customProtoHeaderName": { "type": "string", "description": "The name of the header containing the scheme of the request." } }, "type": "object" }, "azure-native:app:GenevaActionAuthenticationMode": { "description": "Authentication mode for Geneva Actions", "type": "string", "enum": [ { "name": "OAuth", "description": "OAuth authentication mode", "value": "OAuth" }, { "name": "WSTrust", "description": "WS-Trust authentication mode", "value": "WS-Trust" } ] }, "azure-native:app:GenevaActionConfig": { "description": "Configuration for a Geneva action", "properties": { "actionName": { "type": "string", "description": "Name of the Geneva action" }, "actionParameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:GenevaActionParameter" }, "description": "Parameters for the Geneva action" }, "approvalRequired": { "type": "boolean", "description": "Indicates whether approval is required for this action" }, "extension": { "type": "string", "description": "Extension associated with the action" } }, "type": "object" }, "azure-native:app:GenevaActionConfigResponse": { "description": "Configuration for a Geneva action", "properties": { "actionName": { "type": "string", "description": "Name of the Geneva action" }, "actionParameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:GenevaActionParameterResponse" }, "description": "Parameters for the Geneva action" }, "approvalRequired": { "type": "boolean", "description": "Indicates whether approval is required for this action" }, "extension": { "type": "string", "description": "Extension associated with the action" } }, "type": "object" }, "azure-native:app:GenevaActionParameter": { "description": "Parameter for a Geneva action", "properties": { "name": { "type": "string", "description": "Name of the parameter" }, "type": { "type": "string", "description": "Type of the parameter" } }, "type": "object" }, "azure-native:app:GenevaActionParameterResponse": { "description": "Parameter for a Geneva action", "properties": { "name": { "type": "string", "description": "Name of the parameter" }, "type": { "type": "string", "description": "Type of the parameter" } }, "type": "object" }, "azure-native:app:GenevaActionsPolicy": { "description": "Geneva Actions policy configuration for Agent Space", "properties": { "acisEndpoint": { "type": "string", "description": "ACIS (Azure Container Instance Service) endpoint URL" }, "allowedActions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:GenevaActionConfig" }, "description": "Collection of allowed Geneva actions" }, "authenticationMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:GenevaActionAuthenticationMode" } ], "description": "Authentication mode for Geneva Actions" }, "certificateSubjectName": { "type": "string", "description": "Subject name of the certificate used for authentication" }, "clientId": { "type": "string", "description": "Client ID for authentication" }, "extensionName": { "type": "string", "description": "Name of the Geneva extension" } }, "type": "object", "required": [ "extensionName" ] }, "azure-native:app:GenevaActionsPolicyResponse": { "description": "Geneva Actions policy configuration for Agent Space", "properties": { "acisEndpoint": { "type": "string", "description": "ACIS (Azure Container Instance Service) endpoint URL" }, "allowedActions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:GenevaActionConfigResponse" }, "description": "Collection of allowed Geneva actions" }, "authenticationMode": { "type": "string", "description": "Authentication mode for Geneva Actions" }, "certificateSubjectAlternativeName": { "type": "string", "description": "Subject alternative name of the certificate used for authentication" }, "certificateSubjectName": { "type": "string", "description": "Subject name of the certificate used for authentication" }, "clientId": { "type": "string", "description": "Client ID for authentication" }, "extensionName": { "type": "string", "description": "Name of the Geneva extension" } }, "type": "object", "required": [ "certificateSubjectAlternativeName", "extensionName" ] }, "azure-native:app:GitHub": { "description": "The configuration settings of the GitHub provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the GitHub provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopes", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:ClientRegistration", "description": "The configuration settings of the app registration for the GitHub provider." } }, "type": "object" }, "azure-native:app:GitHubResponse": { "description": "The configuration settings of the GitHub provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the GitHub provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopesResponse", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:ClientRegistrationResponse", "description": "The configuration settings of the app registration for the GitHub provider." } }, "type": "object" }, "azure-native:app:GithubActionConfiguration": { "description": "Configuration properties that define the mutable settings of a Container App SourceControl", "properties": { "azureCredentials": { "type": "object", "$ref": "#/types/azure-native:app:AzureCredentials", "description": "AzureCredentials configurations." }, "buildEnvironmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVariable" }, "description": "List of environment variables to be passed to the build." }, "contextPath": { "type": "string", "description": "Context path" }, "dockerfilePath": { "type": "string", "description": "Dockerfile path" }, "githubPersonalAccessToken": { "type": "string", "description": "One time Github PAT to configure github environment" }, "image": { "type": "string", "description": "Image name" }, "os": { "type": "string", "description": "Operation system" }, "publishType": { "type": "string", "description": "Code or Image" }, "registryInfo": { "type": "object", "$ref": "#/types/azure-native:app:RegistryInfo", "description": "Registry configurations." }, "runtimeStack": { "type": "string", "description": "Runtime stack" }, "runtimeVersion": { "type": "string", "description": "Runtime version" } }, "type": "object" }, "azure-native:app:GithubActionConfigurationResponse": { "description": "Configuration properties that define the mutable settings of a Container App SourceControl", "properties": { "azureCredentials": { "type": "object", "$ref": "#/types/azure-native:app:AzureCredentialsResponse", "description": "AzureCredentials configurations." }, "buildEnvironmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVariableResponse" }, "description": "List of environment variables to be passed to the build." }, "contextPath": { "type": "string", "description": "Context path" }, "dockerfilePath": { "type": "string", "description": "Dockerfile path" }, "image": { "type": "string", "description": "Image name" }, "os": { "type": "string", "description": "Operation system" }, "publishType": { "type": "string", "description": "Code or Image" }, "registryInfo": { "type": "object", "$ref": "#/types/azure-native:app:RegistryInfoResponse", "description": "Registry configurations." }, "runtimeStack": { "type": "string", "description": "Runtime stack" }, "runtimeVersion": { "type": "string", "description": "Runtime version" } }, "type": "object" }, "azure-native:app:GlobalValidation": { "description": "The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.", "properties": { "excludedPaths": { "type": "array", "items": { "type": "string" }, "description": "The paths for which unauthenticated flow would not be redirected to the login page." }, "redirectToProvider": { "type": "string", "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"." }, "unauthenticatedClientAction": { "$ref": "#/types/azure-native:app:UnauthenticatedClientActionV2", "description": "The action to take when an unauthenticated client attempts to access the app." } }, "type": "object" }, "azure-native:app:GlobalValidationResponse": { "description": "The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization.", "properties": { "excludedPaths": { "type": "array", "items": { "type": "string" }, "description": "The paths for which unauthenticated flow would not be redirected to the login page." }, "redirectToProvider": { "type": "string", "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"." }, "unauthenticatedClientAction": { "type": "string", "description": "The action to take when an unauthenticated client attempts to access the app." } }, "type": "object" }, "azure-native:app:Google": { "description": "The configuration settings of the Google provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Google provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopes", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:ClientRegistration", "description": "The configuration settings of the app registration for the Google provider." }, "validation": { "type": "object", "$ref": "#/types/azure-native:app:AllowedAudiencesValidation", "description": "The configuration settings of the Azure Active Directory token validation flow." } }, "type": "object" }, "azure-native:app:GoogleResponse": { "description": "The configuration settings of the Google provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Google provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "login": { "type": "object", "$ref": "#/types/azure-native:app:LoginScopesResponse", "description": "The configuration settings of the login flow." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:ClientRegistrationResponse", "description": "The configuration settings of the app registration for the Google provider." }, "validation": { "type": "object", "$ref": "#/types/azure-native:app:AllowedAudiencesValidationResponse", "description": "The configuration settings of the Azure Active Directory token validation flow." } }, "type": "object" }, "azure-native:app:Header": { "description": "Header of otlp configuration", "properties": { "key": { "type": "string", "description": "The key of otlp configuration header" }, "value": { "type": "string", "description": "The value of otlp configuration header" } }, "type": "object" }, "azure-native:app:HeaderMatch": { "description": "Conditions required to match a header", "properties": { "exactMatch": { "type": "string", "description": "Exact value of the header" }, "header": { "type": "string", "description": "Name of the header" }, "prefixMatch": { "type": "string", "description": "Prefix value of the header" }, "regexMatch": { "type": "string", "description": "Regex value of the header" }, "suffixMatch": { "type": "string", "description": "Suffix value of the header" } }, "type": "object" }, "azure-native:app:HeaderMatchResponse": { "description": "Conditions required to match a header", "properties": { "exactMatch": { "type": "string", "description": "Exact value of the header" }, "header": { "type": "string", "description": "Name of the header" }, "prefixMatch": { "type": "string", "description": "Prefix value of the header" }, "regexMatch": { "type": "string", "description": "Regex value of the header" }, "suffixMatch": { "type": "string", "description": "Suffix value of the header" } }, "type": "object" }, "azure-native:app:HeaderResponse": { "description": "Header of otlp configuration", "properties": { "key": { "type": "string", "description": "The key of otlp configuration header" }, "value": { "type": "string", "description": "The value of otlp configuration header" } }, "type": "object" }, "azure-native:app:HttpConnectionPool": { "description": "Defines parameters for http connection pooling", "properties": { "http1MaxPendingRequests": { "type": "integer", "description": "Maximum number of pending http1 requests allowed" }, "http2MaxRequests": { "type": "integer", "description": "Maximum number of http2 requests allowed" } }, "type": "object" }, "azure-native:app:HttpConnectionPoolResponse": { "description": "Defines parameters for http connection pooling", "properties": { "http1MaxPendingRequests": { "type": "integer", "description": "Maximum number of pending http1 requests allowed" }, "http2MaxRequests": { "type": "integer", "description": "Maximum number of http2 requests allowed" } }, "type": "object" }, "azure-native:app:HttpGet": { "description": "Model representing a http get request.", "properties": { "fileName": { "type": "string", "description": "Name of the file that the request should be saved to." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "List of headers to send with the request." }, "url": { "type": "string", "description": "URL to make HTTP GET request against." } }, "type": "object", "required": [ "url" ] }, "azure-native:app:HttpGetResponse": { "description": "Model representing a http get request.", "properties": { "fileName": { "type": "string", "description": "Name of the file that the request should be saved to." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "List of headers to send with the request." }, "url": { "type": "string", "description": "URL to make HTTP GET request against." } }, "type": "object", "required": [ "url" ] }, "azure-native:app:HttpRetryPolicy": { "description": "Policy that defines http request retry conditions", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors that can trigger a retry" }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HeaderMatch" }, "description": "Headers that must be present for a request to be retried" }, "httpStatusCodes": { "type": "array", "items": { "type": "integer" }, "description": "Additional http status codes that can trigger a retry" }, "initialDelayInMilliseconds": { "type": "number", "description": "Initial delay, in milliseconds, before retrying a request" }, "maxIntervalInMilliseconds": { "type": "number", "description": "Maximum interval, in milliseconds, between retries" }, "maxRetries": { "type": "integer", "description": "Maximum number of times a request will retry" } }, "type": "object" }, "azure-native:app:HttpRetryPolicyResponse": { "description": "Policy that defines http request retry conditions", "properties": { "errors": { "type": "array", "items": { "type": "string" }, "description": "Errors that can trigger a retry" }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HeaderMatchResponse" }, "description": "Headers that must be present for a request to be retried" }, "httpStatusCodes": { "type": "array", "items": { "type": "integer" }, "description": "Additional http status codes that can trigger a retry" }, "initialDelayInMilliseconds": { "type": "number", "description": "Initial delay, in milliseconds, before retrying a request" }, "maxIntervalInMilliseconds": { "type": "number", "description": "Maximum interval, in milliseconds, between retries" }, "maxRetries": { "type": "integer", "description": "Maximum number of times a request will retry" } }, "type": "object" }, "azure-native:app:HttpRoute": { "description": "Http Routes configuration, including paths to match on and whether or not rewrites are to be done.", "properties": { "action": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteAction", "description": "Once route is matched, what is the desired action" }, "match": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteMatch", "description": "Conditions route will match on" } }, "type": "object" }, "azure-native:app:HttpRouteAction": { "description": "Action to perform once matching of routes is done", "properties": { "prefixRewrite": { "type": "string", "description": "Rewrite prefix, default is no rewrites" } }, "type": "object" }, "azure-native:app:HttpRouteActionResponse": { "description": "Action to perform once matching of routes is done", "properties": { "prefixRewrite": { "type": "string", "description": "Rewrite prefix, default is no rewrites" } }, "type": "object" }, "azure-native:app:HttpRouteConfigProperties": { "description": "Http Route Config properties", "properties": { "customDomains": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:CustomDomain" }, "description": "Custom domain bindings for http Routes' hostnames." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteRule" }, "description": "Routing Rules for http route resource." } }, "type": "object" }, "azure-native:app:HttpRouteConfigResponseProperties": { "description": "Http Route Config properties", "properties": { "customDomains": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:CustomDomainResponse" }, "description": "Custom domain bindings for http Routes' hostnames." }, "fqdn": { "type": "string", "description": "FQDN of the route resource." }, "provisioningErrors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteProvisioningErrorsResponse" }, "description": "List of errors when trying to reconcile http routes" }, "provisioningState": { "type": "string", "description": "The provisioning state of the Http Route Config in cluster" }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteRuleResponse" }, "description": "Routing Rules for http route resource." } }, "type": "object", "required": [ "fqdn", "provisioningErrors", "provisioningState" ] }, "azure-native:app:HttpRouteMatch": { "description": "Criteria to match on", "properties": { "caseSensitive": { "type": "boolean", "description": "path case sensitive, default is true" }, "path": { "type": "string", "description": "match on exact path" }, "pathSeparatedPrefix": { "type": "string", "description": "match on all prefix's. Not exact" }, "prefix": { "type": "string", "description": "match on all prefix's. Not exact" } }, "type": "object" }, "azure-native:app:HttpRouteMatchResponse": { "description": "Criteria to match on", "properties": { "caseSensitive": { "type": "boolean", "description": "path case sensitive, default is true" }, "path": { "type": "string", "description": "match on exact path" }, "pathSeparatedPrefix": { "type": "string", "description": "match on all prefix's. Not exact" }, "prefix": { "type": "string", "description": "match on all prefix's. Not exact" } }, "type": "object" }, "azure-native:app:HttpRouteProvisioningErrorsResponse": { "description": "List of provisioning errors for a http route config object", "properties": { "message": { "type": "string", "description": "Description or error message" }, "timestamp": { "type": "string", "description": "Timestamp error occured at" } }, "type": "object", "required": [ "message", "timestamp" ] }, "azure-native:app:HttpRouteResponse": { "description": "Http Routes configuration, including paths to match on and whether or not rewrites are to be done.", "properties": { "action": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteActionResponse", "description": "Once route is matched, what is the desired action" }, "match": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteMatchResponse", "description": "Conditions route will match on" } }, "type": "object" }, "azure-native:app:HttpRouteRule": { "description": "Http Route rule.", "properties": { "description": { "type": "string", "description": "Description of rule. Optional." }, "routes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRoute" }, "description": "Routing configuration that will allow matches on specific paths/headers." }, "targets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteTarget" }, "description": "Targets- container apps, revisions, labels" } }, "type": "object" }, "azure-native:app:HttpRouteRuleResponse": { "description": "Http Route rule.", "properties": { "description": { "type": "string", "description": "Description of rule. Optional." }, "routes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteResponse" }, "description": "Routing configuration that will allow matches on specific paths/headers." }, "targets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HttpRouteTargetResponse" }, "description": "Targets- container apps, revisions, labels" } }, "type": "object" }, "azure-native:app:HttpRouteTarget": { "description": "Targets - Container App Names, Revision Names, Labels.", "properties": { "containerApp": { "type": "string", "description": "Container App Name to route requests to" }, "label": { "type": "string", "description": "Label/Revision to route requests to" }, "revision": { "type": "string", "description": "Revision to route requests to" }, "weight": { "type": "integer", "description": "Weighted routing" } }, "type": "object", "required": [ "containerApp" ] }, "azure-native:app:HttpRouteTargetResponse": { "description": "Targets - Container App Names, Revision Names, Labels.", "properties": { "containerApp": { "type": "string", "description": "Container App Name to route requests to" }, "label": { "type": "string", "description": "Label/Revision to route requests to" }, "revision": { "type": "string", "description": "Revision to route requests to" }, "weight": { "type": "integer", "description": "Weighted routing" } }, "type": "object", "required": [ "containerApp" ] }, "azure-native:app:HttpScaleRule": { "description": "Container App container Http scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuth" }, "description": "Authentication secrets for the custom scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe http scale rule." } }, "type": "object" }, "azure-native:app:HttpScaleRuleResponse": { "description": "Container App container Http scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the custom scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe http scale rule." } }, "type": "object" }, "azure-native:app:HttpSettings": { "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.", "properties": { "forwardProxy": { "type": "object", "$ref": "#/types/azure-native:app:ForwardProxy", "description": "The configuration settings of a forward proxy used to make the requests." }, "requireHttps": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "routes": { "type": "object", "$ref": "#/types/azure-native:app:HttpSettingsRoutes", "description": "The configuration settings of the paths HTTP requests." } }, "type": "object" }, "azure-native:app:HttpSettingsResponse": { "description": "The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization.", "properties": { "forwardProxy": { "type": "object", "$ref": "#/types/azure-native:app:ForwardProxyResponse", "description": "The configuration settings of a forward proxy used to make the requests." }, "requireHttps": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "routes": { "type": "object", "$ref": "#/types/azure-native:app:HttpSettingsRoutesResponse", "description": "The configuration settings of the paths HTTP requests." } }, "type": "object" }, "azure-native:app:HttpSettingsRoutes": { "description": "The configuration settings of the paths HTTP requests.", "properties": { "apiPrefix": { "type": "string", "description": "The prefix that should precede all the authentication/authorization paths." } }, "type": "object" }, "azure-native:app:HttpSettingsRoutesResponse": { "description": "The configuration settings of the paths HTTP requests.", "properties": { "apiPrefix": { "type": "string", "description": "The prefix that should precede all the authentication/authorization paths." } }, "type": "object" }, "azure-native:app:IdentityProviders": { "description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.", "properties": { "apple": { "type": "object", "$ref": "#/types/azure-native:app:Apple", "description": "The configuration settings of the Apple provider." }, "azureActiveDirectory": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectory", "description": "The configuration settings of the Azure Active directory provider." }, "azureStaticWebApps": { "type": "object", "$ref": "#/types/azure-native:app:AzureStaticWebApps", "description": "The configuration settings of the Azure Static Web Apps provider." }, "customOpenIdConnectProviders": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:app:CustomOpenIdConnectProvider" }, "description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider." }, "facebook": { "type": "object", "$ref": "#/types/azure-native:app:Facebook", "description": "The configuration settings of the Facebook provider." }, "gitHub": { "type": "object", "$ref": "#/types/azure-native:app:GitHub", "description": "The configuration settings of the GitHub provider." }, "google": { "type": "object", "$ref": "#/types/azure-native:app:Google", "description": "The configuration settings of the Google provider." }, "twitter": { "type": "object", "$ref": "#/types/azure-native:app:Twitter", "description": "The configuration settings of the Twitter provider." } }, "type": "object" }, "azure-native:app:IdentityProvidersResponse": { "description": "The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization.", "properties": { "apple": { "type": "object", "$ref": "#/types/azure-native:app:AppleResponse", "description": "The configuration settings of the Apple provider." }, "azureActiveDirectory": { "type": "object", "$ref": "#/types/azure-native:app:AzureActiveDirectoryResponse", "description": "The configuration settings of the Azure Active directory provider." }, "azureStaticWebApps": { "type": "object", "$ref": "#/types/azure-native:app:AzureStaticWebAppsResponse", "description": "The configuration settings of the Azure Static Web Apps provider." }, "customOpenIdConnectProviders": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:app:CustomOpenIdConnectProviderResponse" }, "description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider." }, "facebook": { "type": "object", "$ref": "#/types/azure-native:app:FacebookResponse", "description": "The configuration settings of the Facebook provider." }, "gitHub": { "type": "object", "$ref": "#/types/azure-native:app:GitHubResponse", "description": "The configuration settings of the GitHub provider." }, "google": { "type": "object", "$ref": "#/types/azure-native:app:GoogleResponse", "description": "The configuration settings of the Google provider." }, "twitter": { "type": "object", "$ref": "#/types/azure-native:app:TwitterResponse", "description": "The configuration settings of the Twitter provider." } }, "type": "object" }, "azure-native:app:IdentitySettings": { "description": "Optional settings for a Managed Identity that is assigned to the Container App.", "properties": { "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "lifecycle": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:IdentitySettingsLifeCycle" } ], "description": "Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.", "default": "All" } }, "type": "object", "required": [ "identity" ] }, "azure-native:app:IdentitySettingsLifeCycle": { "description": "Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.", "type": "string", "enum": [ { "value": "Init" }, { "value": "Main" }, { "value": "None" }, { "value": "All" } ] }, "azure-native:app:IdentitySettingsResponse": { "description": "Optional settings for a Managed Identity that is assigned to the Container App.", "properties": { "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "lifecycle": { "type": "string", "description": "Use to select the lifecycle stages of a Container App during which the Managed Identity should be available.", "default": "All" } }, "type": "object", "required": [ "identity" ] }, "azure-native:app:ImageType": { "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image.", "type": "string", "enum": [ { "value": "CloudBuild" }, { "value": "ContainerImage" } ] }, "azure-native:app:IncidentManagementConfiguration": { "description": "Incident Management Configurations", "properties": { "connectionKey": { "type": "string", "description": "The key for the connection" }, "connectionName": { "type": "string", "description": "The name of the connection" }, "connectionUrl": { "type": "string", "description": "The URL of the connection" }, "oboUser": { "type": "string", "description": "The user for the connection" }, "type": { "type": "string", "description": "The type of incident management system" } }, "type": "object" }, "azure-native:app:IncidentManagementConfigurationResponse": { "description": "Incident Management Configurations", "properties": { "connectionKey": { "type": "string", "description": "The key for the connection" }, "connectionName": { "type": "string", "description": "The name of the connection" }, "connectionUrl": { "type": "string", "description": "The URL of the connection" }, "oboUser": { "type": "string", "description": "The user for the connection" }, "type": { "type": "string", "description": "The type of incident management system" } }, "type": "object" }, "azure-native:app:Ingress": { "description": "Container App Ingress configuration.", "properties": { "additionalPortMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IngressPortMapping" }, "description": "Settings to expose additional ports on container app" }, "allowInsecure": { "type": "boolean", "description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections", "default": false }, "clientCertificateMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:IngressClientCertificateMode" } ], "description": "Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate." }, "corsPolicy": { "type": "object", "$ref": "#/types/azure-native:app:CorsPolicy", "description": "CORS policy for container app" }, "customDomains": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:CustomDomain" }, "description": "custom domain bindings for Container Apps' hostnames." }, "exposedPort": { "type": "integer", "description": "Exposed Port in containers for TCP traffic from ingress" }, "external": { "type": "boolean", "description": "Bool indicating if app exposes an external http endpoint", "default": false }, "ipSecurityRestrictions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IpSecurityRestrictionRule" }, "description": "Rules to restrict incoming IP address." }, "stickySessions": { "type": "object", "$ref": "#/types/azure-native:app:IngressStickySessions", "description": "Sticky Sessions for Single Revision Mode" }, "targetPort": { "type": "integer", "description": "Target Port in containers for traffic from ingress" }, "targetPortHttpScheme": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:IngressTargetPortHttpScheme" } ], "description": "Whether an http app listens on http or https" }, "traffic": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:TrafficWeight" }, "description": "Traffic weights for app's revisions" }, "transport": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:IngressTransportMethod" } ], "description": "Ingress transport protocol", "default": "auto" } }, "type": "object" }, "azure-native:app:IngressClientCertificateMode": { "description": "Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate.", "type": "string", "enum": [ { "value": "ignore" }, { "value": "accept" }, { "value": "require" } ] }, "azure-native:app:IngressConfiguration": { "description": "Settings for the ingress component, including workload profile, scaling, and connection handling.", "properties": { "headerCountLimit": { "type": "integer", "description": "Maximum number of headers per request allowed by the ingress. Must be at least 1. Defaults to 100." }, "requestIdleTimeout": { "type": "integer", "description": "Duration (in minutes) before idle requests are timed out. Must be at least 1 minute. Defaults to 4 minutes." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:IngressConfigurationScale", "description": "Scaling configuration for the ingress component. Required." }, "terminationGracePeriodSeconds": { "type": "integer", "description": "Time (in seconds) to allow active connections to complete on termination. Must be between 0 and 3600. Defaults to 480 seconds." }, "workloadProfileName": { "type": "string", "description": "Name of the workload profile used by the ingress component. Required." } }, "type": "object" }, "azure-native:app:IngressConfigurationResponse": { "description": "Settings for the ingress component, including workload profile, scaling, and connection handling.", "properties": { "headerCountLimit": { "type": "integer", "description": "Maximum number of headers per request allowed by the ingress. Must be at least 1. Defaults to 100." }, "requestIdleTimeout": { "type": "integer", "description": "Duration (in minutes) before idle requests are timed out. Must be at least 1 minute. Defaults to 4 minutes." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:IngressConfigurationResponseScale", "description": "Scaling configuration for the ingress component. Required." }, "terminationGracePeriodSeconds": { "type": "integer", "description": "Time (in seconds) to allow active connections to complete on termination. Must be between 0 and 3600. Defaults to 480 seconds." }, "workloadProfileName": { "type": "string", "description": "Name of the workload profile used by the ingress component. Required." } }, "type": "object" }, "azure-native:app:IngressConfigurationResponseScale": { "description": "Scaling configuration for the ingress component. Required.", "properties": { "maxReplicas": { "type": "integer", "description": "Maximum number of ingress replicas. Must be greater than or equal to minReplicas." }, "minReplicas": { "type": "integer", "description": "Minimum number of ingress replicas. Must be at least 2. Required." } }, "type": "object" }, "azure-native:app:IngressConfigurationScale": { "description": "Scaling configuration for the ingress component. Required.", "properties": { "maxReplicas": { "type": "integer", "description": "Maximum number of ingress replicas. Must be greater than or equal to minReplicas." }, "minReplicas": { "type": "integer", "description": "Minimum number of ingress replicas. Must be at least 2. Required." } }, "type": "object" }, "azure-native:app:IngressPortMapping": { "description": "Port mappings of container app ingress", "properties": { "exposedPort": { "type": "integer", "description": "Specifies the exposed port for the target port. If not specified, it defaults to target port" }, "external": { "type": "boolean", "description": "Specifies whether the app port is accessible outside of the environment" }, "targetPort": { "type": "integer", "description": "Specifies the port user's container listens on" } }, "type": "object", "required": [ "external", "targetPort" ] }, "azure-native:app:IngressPortMappingResponse": { "description": "Port mappings of container app ingress", "properties": { "exposedPort": { "type": "integer", "description": "Specifies the exposed port for the target port. If not specified, it defaults to target port" }, "external": { "type": "boolean", "description": "Specifies whether the app port is accessible outside of the environment" }, "targetPort": { "type": "integer", "description": "Specifies the port user's container listens on" } }, "type": "object", "required": [ "external", "targetPort" ] }, "azure-native:app:IngressResponse": { "description": "Container App Ingress configuration.", "properties": { "additionalPortMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IngressPortMappingResponse" }, "description": "Settings to expose additional ports on container app" }, "allowInsecure": { "type": "boolean", "description": "Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections", "default": false }, "clientCertificateMode": { "type": "string", "description": "Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate." }, "corsPolicy": { "type": "object", "$ref": "#/types/azure-native:app:CorsPolicyResponse", "description": "CORS policy for container app" }, "customDomains": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:CustomDomainResponse" }, "description": "custom domain bindings for Container Apps' hostnames." }, "exposedPort": { "type": "integer", "description": "Exposed Port in containers for TCP traffic from ingress" }, "external": { "type": "boolean", "description": "Bool indicating if app exposes an external http endpoint", "default": false }, "fqdn": { "type": "string", "description": "Hostname." }, "ipSecurityRestrictions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IpSecurityRestrictionRuleResponse" }, "description": "Rules to restrict incoming IP address." }, "stickySessions": { "type": "object", "$ref": "#/types/azure-native:app:IngressResponseStickySessions", "description": "Sticky Sessions for Single Revision Mode" }, "targetPort": { "type": "integer", "description": "Target Port in containers for traffic from ingress" }, "targetPortHttpScheme": { "type": "string", "description": "Whether an http app listens on http or https" }, "traffic": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:TrafficWeightResponse" }, "description": "Traffic weights for app's revisions" }, "transport": { "type": "string", "description": "Ingress transport protocol", "default": "auto" } }, "type": "object", "required": [ "fqdn" ] }, "azure-native:app:IngressResponseStickySessions": { "description": "Sticky Sessions for Single Revision Mode", "properties": { "affinity": { "type": "string", "description": "Sticky Session Affinity" } }, "type": "object" }, "azure-native:app:IngressStickySessions": { "description": "Sticky Sessions for Single Revision Mode", "properties": { "affinity": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:Affinity" } ], "description": "Sticky Session Affinity" } }, "type": "object" }, "azure-native:app:IngressTargetPortHttpScheme": { "description": "Whether an http app listens on http or https", "type": "string", "enum": [ { "value": "http" }, { "value": "https" } ] }, "azure-native:app:IngressTransportMethod": { "description": "Ingress transport protocol", "type": "string", "enum": [ { "value": "auto" }, { "value": "http" }, { "value": "http2" }, { "value": "tcp" } ] }, "azure-native:app:InitContainer": { "description": "Container App init container definition", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Container start command arguments." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Container start command." }, "env": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVar" }, "description": "Container environment variables." }, "image": { "type": "string", "description": "Container image tag." }, "imageType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:ImageType" } ], "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image." }, "name": { "type": "string", "description": "Custom container name." }, "resources": { "type": "object", "$ref": "#/types/azure-native:app:ContainerResources", "description": "Container resource requirements." }, "volumeMounts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:VolumeMount" }, "description": "Container volume mounts." } }, "type": "object" }, "azure-native:app:InitContainerResponse": { "description": "Container App init container definition", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Container start command arguments." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Container start command." }, "env": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVarResponse" }, "description": "Container environment variables." }, "image": { "type": "string", "description": "Container image tag." }, "imageType": { "type": "string", "description": "The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image." }, "name": { "type": "string", "description": "Custom container name." }, "resources": { "type": "object", "$ref": "#/types/azure-native:app:ContainerResourcesResponse", "description": "Container resource requirements." }, "volumeMounts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:VolumeMountResponse" }, "description": "Container volume mounts." } }, "type": "object" }, "azure-native:app:IpSecurityRestrictionRule": { "description": "Rule to restrict incoming IP address.", "properties": { "action": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:Action" } ], "description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny" }, "description": { "type": "string", "description": "Describe the IP restriction rule that is being sent to the container-app. This is an optional field." }, "ipAddressRange": { "type": "string", "description": "CIDR notation to match incoming IP address" }, "name": { "type": "string", "description": "Name for the IP restriction rule." } }, "type": "object", "required": [ "action", "ipAddressRange", "name" ] }, "azure-native:app:IpSecurityRestrictionRuleResponse": { "description": "Rule to restrict incoming IP address.", "properties": { "action": { "type": "string", "description": "Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny" }, "description": { "type": "string", "description": "Describe the IP restriction rule that is being sent to the container-app. This is an optional field." }, "ipAddressRange": { "type": "string", "description": "CIDR notation to match incoming IP address" }, "name": { "type": "string", "description": "Name for the IP restriction rule." } }, "type": "object", "required": [ "action", "ipAddressRange", "name" ] }, "azure-native:app:JavaComponentConfigurationProperty": { "description": "Configuration properties for a Java Component", "properties": { "propertyName": { "type": "string", "description": "The name of the property" }, "value": { "type": "string", "description": "The value of the property" } }, "type": "object" }, "azure-native:app:JavaComponentConfigurationPropertyResponse": { "description": "Configuration properties for a Java Component", "properties": { "propertyName": { "type": "string", "description": "The name of the property" }, "value": { "type": "string", "description": "The value of the property" } }, "type": "object" }, "azure-native:app:JavaComponentIngressResponse": { "description": "Container App Ingress configuration.", "properties": { "fqdn": { "type": "string", "description": "Hostname of the Java Component endpoint" } }, "type": "object", "required": [ "fqdn" ] }, "azure-native:app:JavaComponentPropertiesResponseScale": { "description": "Java component scaling configurations", "properties": { "maxReplicas": { "type": "integer", "description": "Optional. Maximum number of Java component replicas" }, "minReplicas": { "type": "integer", "description": "Optional. Minimum number of Java component replicas. Defaults to 1 if not set" } }, "type": "object" }, "azure-native:app:JavaComponentPropertiesScale": { "description": "Java component scaling configurations", "properties": { "maxReplicas": { "type": "integer", "description": "Optional. Maximum number of Java component replicas" }, "minReplicas": { "type": "integer", "description": "Optional. Minimum number of Java component replicas. Defaults to 1 if not set" } }, "type": "object" }, "azure-native:app:JavaComponentServiceBind": { "description": "Configuration to bind a Java Component to another Java Component", "properties": { "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:JavaComponentServiceBindResponse": { "description": "Configuration to bind a Java Component to another Java Component", "properties": { "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:JavaComponentType": { "description": "Type of the Java Component.", "type": "string", "enum": [ { "value": "SpringBootAdmin" }, { "value": "SpringCloudEureka" }, { "value": "SpringCloudConfig" }, { "value": "SpringCloudGateway" }, { "value": "Nacos" } ] }, "azure-native:app:JobConfiguration": { "description": "Non versioned Container Apps Job configuration properties", "properties": { "eventTriggerConfig": { "type": "object", "$ref": "#/types/azure-native:app:JobConfigurationEventTriggerConfig", "description": "Trigger configuration of an event driven job." }, "identitySettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IdentitySettings" }, "description": "Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used." }, "manualTriggerConfig": { "type": "object", "$ref": "#/types/azure-native:app:JobConfigurationManualTriggerConfig", "description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default" }, "registries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:RegistryCredentials" }, "description": "Collection of private container registry credentials used by a Container apps job" }, "replicaRetryLimit": { "type": "integer", "description": "Maximum number of retries before failing the job." }, "replicaTimeout": { "type": "integer", "description": "Maximum number of seconds a replica is allowed to run." }, "scheduleTriggerConfig": { "type": "object", "$ref": "#/types/azure-native:app:JobConfigurationScheduleTriggerConfig", "description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default" }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Secret" }, "description": "Collection of secrets used by a Container Apps Job" }, "triggerType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:TriggerType" } ], "description": "Trigger type of the job", "default": "Manual" } }, "type": "object", "required": [ "replicaTimeout", "triggerType" ] }, "azure-native:app:JobConfigurationEventTriggerConfig": { "description": "Trigger configuration of an event driven job.", "properties": { "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job that can run at a given time." }, "replicaCompletionCount": { "type": "integer", "description": "Minimum number of successful replica completions before overall job completion." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JobScale", "description": "Scaling configurations for event driven jobs." } }, "type": "object" }, "azure-native:app:JobConfigurationManualTriggerConfig": { "description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default", "properties": { "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job that can run at a given time." }, "replicaCompletionCount": { "type": "integer", "description": "Minimum number of successful replica completions before overall job completion." } }, "type": "object" }, "azure-native:app:JobConfigurationResponse": { "description": "Non versioned Container Apps Job configuration properties", "properties": { "eventTriggerConfig": { "type": "object", "$ref": "#/types/azure-native:app:JobConfigurationResponseEventTriggerConfig", "description": "Trigger configuration of an event driven job." }, "identitySettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:IdentitySettingsResponse" }, "description": "Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used." }, "manualTriggerConfig": { "type": "object", "$ref": "#/types/azure-native:app:JobConfigurationResponseManualTriggerConfig", "description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default" }, "registries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:RegistryCredentialsResponse" }, "description": "Collection of private container registry credentials used by a Container apps job" }, "replicaRetryLimit": { "type": "integer", "description": "Maximum number of retries before failing the job." }, "replicaTimeout": { "type": "integer", "description": "Maximum number of seconds a replica is allowed to run." }, "scheduleTriggerConfig": { "type": "object", "$ref": "#/types/azure-native:app:JobConfigurationResponseScheduleTriggerConfig", "description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default" }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SecretResponse" }, "description": "Collection of secrets used by a Container Apps Job" }, "triggerType": { "type": "string", "description": "Trigger type of the job", "default": "Manual" } }, "type": "object", "required": [ "replicaTimeout", "triggerType" ] }, "azure-native:app:JobConfigurationResponseEventTriggerConfig": { "description": "Trigger configuration of an event driven job.", "properties": { "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job that can run at a given time." }, "replicaCompletionCount": { "type": "integer", "description": "Minimum number of successful replica completions before overall job completion." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JobScaleResponse", "description": "Scaling configurations for event driven jobs." } }, "type": "object" }, "azure-native:app:JobConfigurationResponseManualTriggerConfig": { "description": "Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default", "properties": { "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job that can run at a given time." }, "replicaCompletionCount": { "type": "integer", "description": "Minimum number of successful replica completions before overall job completion." } }, "type": "object" }, "azure-native:app:JobConfigurationResponseScheduleTriggerConfig": { "description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default", "properties": { "cronExpression": { "type": "string", "description": "Cron formatted repeating schedule (\"* * * * *\") of a Cron Job." }, "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job that can run at a given time." }, "replicaCompletionCount": { "type": "integer", "description": "Minimum number of successful replica completions before overall job completion." } }, "type": "object", "required": [ "cronExpression" ] }, "azure-native:app:JobConfigurationScheduleTriggerConfig": { "description": "Cron formatted repeating trigger schedule (\"* * * * *\") for cronjobs. Properties completions and parallelism would be set to 1 by default", "properties": { "cronExpression": { "type": "string", "description": "Cron formatted repeating schedule (\"* * * * *\") of a Cron Job." }, "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job that can run at a given time." }, "replicaCompletionCount": { "type": "integer", "description": "Minimum number of successful replica completions before overall job completion." } }, "type": "object", "required": [ "cronExpression" ] }, "azure-native:app:JobScale": { "description": "Scaling configurations for event driven jobs.", "properties": { "maxExecutions": { "type": "integer", "description": "Maximum number of job executions that are created for a trigger, default 100.", "default": 100 }, "minExecutions": { "type": "integer", "description": "Minimum number of job executions that are created for a trigger, default 0", "default": 0 }, "pollingInterval": { "type": "integer", "description": "Interval to check each event source in seconds. Defaults to 30s" }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JobScaleRule" }, "description": "Scaling rules." } }, "type": "object" }, "azure-native:app:JobScaleResponse": { "description": "Scaling configurations for event driven jobs.", "properties": { "maxExecutions": { "type": "integer", "description": "Maximum number of job executions that are created for a trigger, default 100.", "default": 100 }, "minExecutions": { "type": "integer", "description": "Minimum number of job executions that are created for a trigger, default 0", "default": 0 }, "pollingInterval": { "type": "integer", "description": "Interval to check each event source in seconds. Defaults to 30s" }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JobScaleRuleResponse" }, "description": "Scaling rules." } }, "type": "object" }, "azure-native:app:JobScaleRule": { "description": "Scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuth" }, "description": "Authentication secrets for the scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the job, or 'system' for system-assigned identity." }, "metadata": { "$ref": "pulumi.json#/Any", "description": "Metadata properties to describe the scale rule." }, "name": { "type": "string", "description": "Scale Rule Name" }, "type": { "type": "string", "description": "Type of the scale rule\neg: azure-servicebus, redis etc." } }, "type": "object" }, "azure-native:app:JobScaleRuleResponse": { "description": "Scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the job, or 'system' for system-assigned identity." }, "metadata": { "$ref": "pulumi.json#/Any", "description": "Metadata properties to describe the scale rule." }, "name": { "type": "string", "description": "Scale Rule Name" }, "type": { "type": "string", "description": "Type of the scale rule\neg: azure-servicebus, redis etc." } }, "type": "object" }, "azure-native:app:JobTemplate": { "description": "Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created", "properties": { "containers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Container" }, "description": "List of container definitions for the Container App." }, "initContainers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:InitContainer" }, "description": "List of specialized containers that run before app containers." }, "volumes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Volume" }, "description": "List of volume definitions for the Container App." } }, "type": "object" }, "azure-native:app:JobTemplateResponse": { "description": "Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created", "properties": { "containers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ContainerResponse" }, "description": "List of container definitions for the Container App." }, "initContainers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:InitContainerResponse" }, "description": "List of specialized containers that run before app containers." }, "volumes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:VolumeResponse" }, "description": "List of volume definitions for the Container App." } }, "type": "object" }, "azure-native:app:JwtClaimChecks": { "description": "The configuration settings of the checks that should be made while validating the JWT Claims.", "properties": { "allowedClientApplications": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed client applications." }, "allowedGroups": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed groups." } }, "type": "object" }, "azure-native:app:JwtClaimChecksResponse": { "description": "The configuration settings of the checks that should be made while validating the JWT Claims.", "properties": { "allowedClientApplications": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed client applications." }, "allowedGroups": { "type": "array", "items": { "type": "string" }, "description": "The list of the allowed groups." } }, "type": "object" }, "azure-native:app:KedaConfigurationResponse": { "description": "Configuration properties Keda component", "properties": { "version": { "type": "string", "description": "The version of Keda" } }, "type": "object", "required": [ "version" ] }, "azure-native:app:Kind": { "description": "Metadata used to render different experiences for resources of the same type; e.g. WorkflowApp is a kind of Microsoft.App/ContainerApps type. If supported, the resource provider must validate and persist this value.", "type": "string", "enum": [ { "value": "workflowapp" } ] }, "azure-native:app:KnowledgeGraphConfiguration": { "description": "Knowledge graph configuration for agent", "properties": { "identity": { "type": "string", "description": "The identity used to access the knowledge graph" }, "managedResources": { "type": "array", "items": { "type": "string" }, "description": "The list of resources managed by agent" } }, "type": "object" }, "azure-native:app:KnowledgeGraphConfigurationResponse": { "description": "Knowledge graph configuration for agent", "properties": { "identity": { "type": "string", "description": "The identity used to access the knowledge graph" }, "managedResources": { "type": "array", "items": { "type": "string" }, "description": "The list of resources managed by agent" } }, "type": "object" }, "azure-native:app:Level": { "description": "The specified logger's log level.", "type": "string", "enum": [ { "value": "off" }, { "value": "error" }, { "value": "info" }, { "value": "debug" }, { "value": "trace" }, { "value": "warn" } ] }, "azure-native:app:LifecycleConfiguration": { "description": "The lifecycle configuration properties of a session in the dynamic session pool", "properties": { "cooldownPeriodInSeconds": { "type": "integer", "description": "The cooldown period of a session in seconds when the lifecycle type is 'Timed'." }, "lifecycleType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:LifecycleType" } ], "description": "The lifecycle type of the session pool." }, "maxAlivePeriodInSeconds": { "type": "integer", "description": "The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'." } }, "type": "object" }, "azure-native:app:LifecycleConfigurationResponse": { "description": "The lifecycle configuration properties of a session in the dynamic session pool", "properties": { "cooldownPeriodInSeconds": { "type": "integer", "description": "The cooldown period of a session in seconds when the lifecycle type is 'Timed'." }, "lifecycleType": { "type": "string", "description": "The lifecycle type of the session pool." }, "maxAlivePeriodInSeconds": { "type": "integer", "description": "The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'." } }, "type": "object" }, "azure-native:app:LifecycleType": { "description": "The lifecycle type of the session pool.", "type": "string", "enum": [ { "value": "Timed" }, { "value": "OnContainerExit" } ] }, "azure-native:app:LogAnalyticsConfiguration": { "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", "properties": { "customerId": { "type": "string", "description": "Log analytics customer id" }, "dynamicJsonColumns": { "type": "boolean", "description": "Boolean indicating whether to parse json string log into dynamic json columns" }, "sharedKey": { "type": "string", "description": "Log analytics customer key" } }, "type": "object" }, "azure-native:app:LogAnalyticsConfigurationResponse": { "description": "Log Analytics configuration, must only be provided when destination is configured as 'log-analytics'", "properties": { "customerId": { "type": "string", "description": "Log analytics customer id" }, "dynamicJsonColumns": { "type": "boolean", "description": "Boolean indicating whether to parse json string log into dynamic json columns" } }, "type": "object" }, "azure-native:app:LogConfiguration": { "description": "Log Configurations", "properties": { "applicationInsightsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:ApplicationInsightsConfiguration", "description": "Application Insights Configuration" } }, "type": "object" }, "azure-native:app:LogConfigurationResponse": { "description": "Log Configurations", "properties": { "applicationInsightsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:ApplicationInsightsConfigurationResponse", "description": "Application Insights Configuration" } }, "type": "object" }, "azure-native:app:LogLevel": { "description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.", "type": "string", "enum": [ { "value": "info" }, { "value": "debug" }, { "value": "warn" }, { "value": "error" } ] }, "azure-native:app:LoggerSetting": { "description": "Logger settings for java workloads.", "properties": { "level": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:Level" } ], "description": "The specified logger's log level." }, "logger": { "type": "string", "description": "Logger name." } }, "type": "object", "required": [ "level", "logger" ] }, "azure-native:app:LoggerSettingResponse": { "description": "Logger settings for java workloads.", "properties": { "level": { "type": "string", "description": "The specified logger's log level." }, "logger": { "type": "string", "description": "Logger name." } }, "type": "object", "required": [ "level", "logger" ] }, "azure-native:app:Login": { "description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.", "properties": { "allowedExternalRedirectUrls": { "type": "array", "items": { "type": "string" }, "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed." }, "cookieExpiration": { "type": "object", "$ref": "#/types/azure-native:app:CookieExpiration", "description": "The configuration settings of the session cookie's expiration." }, "nonce": { "type": "object", "$ref": "#/types/azure-native:app:Nonce", "description": "The configuration settings of the nonce used in the login flow." }, "preserveUrlFragmentsForLogins": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e if the fragments from the request are preserved after the login request is made; otherwise, \u003ccode\u003efalse\u003c/code\u003e." }, "routes": { "type": "object", "$ref": "#/types/azure-native:app:LoginRoutes", "description": "The routes that specify the endpoints used for login and logout requests." }, "tokenStore": { "type": "object", "$ref": "#/types/azure-native:app:TokenStore", "description": "The configuration settings of the token store." } }, "type": "object" }, "azure-native:app:LoginResponse": { "description": "The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.", "properties": { "allowedExternalRedirectUrls": { "type": "array", "items": { "type": "string" }, "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed." }, "cookieExpiration": { "type": "object", "$ref": "#/types/azure-native:app:CookieExpirationResponse", "description": "The configuration settings of the session cookie's expiration." }, "nonce": { "type": "object", "$ref": "#/types/azure-native:app:NonceResponse", "description": "The configuration settings of the nonce used in the login flow." }, "preserveUrlFragmentsForLogins": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e if the fragments from the request are preserved after the login request is made; otherwise, \u003ccode\u003efalse\u003c/code\u003e." }, "routes": { "type": "object", "$ref": "#/types/azure-native:app:LoginRoutesResponse", "description": "The routes that specify the endpoints used for login and logout requests." }, "tokenStore": { "type": "object", "$ref": "#/types/azure-native:app:TokenStoreResponse", "description": "The configuration settings of the token store." } }, "type": "object" }, "azure-native:app:LoginRoutes": { "description": "The routes that specify the endpoints used for login and logout requests.", "properties": { "logoutEndpoint": { "type": "string", "description": "The endpoint at which a logout request should be made." } }, "type": "object" }, "azure-native:app:LoginRoutesResponse": { "description": "The routes that specify the endpoints used for login and logout requests.", "properties": { "logoutEndpoint": { "type": "string", "description": "The endpoint at which a logout request should be made." } }, "type": "object" }, "azure-native:app:LoginScopes": { "description": "The configuration settings of the login flow, including the scopes that should be requested.", "properties": { "scopes": { "type": "array", "items": { "type": "string" }, "description": "A list of the scopes that should be requested while authenticating." } }, "type": "object" }, "azure-native:app:LoginScopesResponse": { "description": "The configuration settings of the login flow, including the scopes that should be requested.", "properties": { "scopes": { "type": "array", "items": { "type": "string" }, "description": "A list of the scopes that should be requested while authenticating." } }, "type": "object" }, "azure-native:app:LogsConfiguration": { "description": "Configuration of Open Telemetry logs", "properties": { "destinations": { "type": "array", "items": { "type": "string" }, "description": "Open telemetry logs destinations" } }, "type": "object" }, "azure-native:app:LogsConfigurationResponse": { "description": "Configuration of Open Telemetry logs", "properties": { "destinations": { "type": "array", "items": { "type": "string" }, "description": "Open telemetry logs destinations" } }, "type": "object" }, "azure-native:app:ManagedCertificateDomainControlValidation": { "description": "Selected type of domain control validation for managed certificates.", "type": "string", "enum": [ { "value": "CNAME" }, { "value": "HTTP" }, { "value": "TXT" } ] }, "azure-native:app:ManagedCertificateProperties": { "description": "Certificate resource specific properties", "properties": { "domainControlValidation": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:ManagedCertificateDomainControlValidation" } ], "description": "Selected type of domain control validation for managed certificates." }, "subjectName": { "type": "string", "description": "Subject name of the certificate." } }, "type": "object" }, "azure-native:app:ManagedCertificateResponseProperties": { "description": "Certificate resource specific properties", "properties": { "domainControlValidation": { "type": "string", "description": "Selected type of domain control validation for managed certificates." }, "error": { "type": "string", "description": "Any error occurred during the certificate provision." }, "provisioningState": { "type": "string", "description": "Provisioning state of the certificate." }, "subjectName": { "type": "string", "description": "Subject name of the certificate." }, "validationToken": { "type": "string", "description": "A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates." } }, "type": "object", "required": [ "error", "provisioningState", "validationToken" ] }, "azure-native:app:ManagedEnvironmentEncryption": { "description": "Peer traffic encryption settings for the Managed Environment", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating whether the peer traffic encryption is enabled" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentPeerAuthentication": { "description": "Peer authentication settings for the Managed Environment", "properties": { "mtls": { "type": "object", "$ref": "#/types/azure-native:app:Mtls", "description": "Mutual TLS authentication settings for the Managed Environment" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentPeerTrafficConfiguration": { "description": "Peer traffic settings for the Managed Environment", "properties": { "encryption": { "type": "object", "$ref": "#/types/azure-native:app:ManagedEnvironmentEncryption", "description": "Peer traffic encryption settings for the Managed Environment" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentResponseEncryption": { "description": "Peer traffic encryption settings for the Managed Environment", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating whether the peer traffic encryption is enabled" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentResponsePeerAuthentication": { "description": "Peer authentication settings for the Managed Environment", "properties": { "mtls": { "type": "object", "$ref": "#/types/azure-native:app:MtlsResponse", "description": "Mutual TLS authentication settings for the Managed Environment" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentResponsePeerTrafficConfiguration": { "description": "Peer traffic settings for the Managed Environment", "properties": { "encryption": { "type": "object", "$ref": "#/types/azure-native:app:ManagedEnvironmentResponseEncryption", "description": "Peer traffic encryption settings for the Managed Environment" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentStorageProperties": { "description": "Storage properties", "properties": { "azureFile": { "type": "object", "$ref": "#/types/azure-native:app:AzureFileProperties", "description": "Azure file properties" }, "nfsAzureFile": { "type": "object", "$ref": "#/types/azure-native:app:NfsAzureFileProperties", "description": "NFS Azure file properties" } }, "type": "object" }, "azure-native:app:ManagedEnvironmentStorageResponseProperties": { "description": "Storage properties", "properties": { "azureFile": { "type": "object", "$ref": "#/types/azure-native:app:AzureFilePropertiesResponse", "description": "Azure file properties" }, "nfsAzureFile": { "type": "object", "$ref": "#/types/azure-native:app:NfsAzureFilePropertiesResponse", "description": "NFS Azure file properties" } }, "type": "object" }, "azure-native:app:ManagedIdentitySetting": { "description": "Optional settings for a Managed Identity that is assigned to the Session pool.", "properties": { "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity." }, "lifecycle": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:IdentitySettingsLifeCycle" } ], "description": "Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.", "default": "None" } }, "type": "object", "required": [ "identity" ] }, "azure-native:app:ManagedIdentitySettingResponse": { "description": "Optional settings for a Managed Identity that is assigned to the Session pool.", "properties": { "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity." }, "lifecycle": { "type": "string", "description": "Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available.", "default": "None" } }, "type": "object", "required": [ "identity" ] }, "azure-native:app:ManagedServiceIdentity": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:ManagedServiceIdentityType" } ], "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "type" ] }, "azure-native:app:ManagedServiceIdentityResponse": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "principalId": { "type": "string", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "type": "string", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:app:UserAssignedIdentityResponse" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:app:ManagedServiceIdentityType": { "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned,UserAssigned" } ] }, "azure-native:app:MetricsConfiguration": { "description": "Configuration of Open Telemetry metrics", "properties": { "destinations": { "type": "array", "items": { "type": "string" }, "description": "Open telemetry metrics destinations" }, "includeKeda": { "type": "boolean", "description": "Boolean indicating if including keda metrics" } }, "type": "object" }, "azure-native:app:MetricsConfigurationResponse": { "description": "Configuration of Open Telemetry metrics", "properties": { "destinations": { "type": "array", "items": { "type": "string" }, "description": "Open telemetry metrics destinations" }, "includeKeda": { "type": "boolean", "description": "Boolean indicating if including keda metrics" } }, "type": "object" }, "azure-native:app:Mtls": { "description": "Configuration properties for mutual TLS authentication", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating whether the mutual TLS authentication is enabled" } }, "type": "object" }, "azure-native:app:MtlsResponse": { "description": "Configuration properties for mutual TLS authentication", "properties": { "enabled": { "type": "boolean", "description": "Boolean indicating whether the mutual TLS authentication is enabled" } }, "type": "object" }, "azure-native:app:NacosComponent": { "description": "Nacos properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'Nacos'.", "const": "Nacos" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationProperty" }, "description": "List of Java Components configuration properties" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBind" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType" ] }, "azure-native:app:NacosComponentResponse": { "description": "Nacos properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'Nacos'.", "const": "Nacos" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationPropertyResponse" }, "description": "List of Java Components configuration properties" }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentIngressResponse", "description": "Java Component Ingress configurations." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Java Component." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesResponseScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBindResponse" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType", "provisioningState" ] }, "azure-native:app:NfsAzureFileProperties": { "description": "NFS Azure File Properties.", "properties": { "accessMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:AccessMode" } ], "description": "Access mode for storage" }, "server": { "type": "string", "description": "Server for NFS azure file." }, "shareName": { "type": "string", "description": "NFS Azure file share name." } }, "type": "object" }, "azure-native:app:NfsAzureFilePropertiesResponse": { "description": "NFS Azure File Properties.", "properties": { "accessMode": { "type": "string", "description": "Access mode for storage" }, "server": { "type": "string", "description": "Server for NFS azure file." }, "shareName": { "type": "string", "description": "NFS Azure file share name." } }, "type": "object" }, "azure-native:app:Nonce": { "description": "The configuration settings of the nonce used in the login flow.", "properties": { "nonceExpirationInterval": { "type": "string", "description": "The time after the request is made when the nonce should expire." }, "validateNonce": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the nonce should not be validated while completing the login flow; otherwise, \u003ccode\u003etrue\u003c/code\u003e." } }, "type": "object" }, "azure-native:app:NonceResponse": { "description": "The configuration settings of the nonce used in the login flow.", "properties": { "nonceExpirationInterval": { "type": "string", "description": "The time after the request is made when the nonce should expire." }, "validateNonce": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the nonce should not be validated while completing the login flow; otherwise, \u003ccode\u003etrue\u003c/code\u003e." } }, "type": "object" }, "azure-native:app:OpenIdConnectClientCredential": { "description": "The authentication client credentials of the custom Open ID Connect provider.", "properties": { "clientSecretSettingName": { "type": "string", "description": "The app setting that contains the client secret for the custom Open ID Connect provider." }, "method": { "$ref": "#/types/azure-native:app:ClientCredentialMethod", "description": "The method that should be used to authenticate the user." } }, "type": "object" }, "azure-native:app:OpenIdConnectClientCredentialResponse": { "description": "The authentication client credentials of the custom Open ID Connect provider.", "properties": { "clientSecretSettingName": { "type": "string", "description": "The app setting that contains the client secret for the custom Open ID Connect provider." }, "method": { "type": "string", "description": "The method that should be used to authenticate the user." } }, "type": "object" }, "azure-native:app:OpenIdConnectConfig": { "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.", "properties": { "authorizationEndpoint": { "type": "string", "description": "The endpoint to be used to make an authorization request." }, "certificationUri": { "type": "string", "description": "The endpoint that provides the keys necessary to validate the token." }, "issuer": { "type": "string", "description": "The endpoint that issues the token." }, "tokenEndpoint": { "type": "string", "description": "The endpoint to be used to request a token." }, "wellKnownOpenIdConfiguration": { "type": "string", "description": "The endpoint that contains all the configuration endpoints for the provider." } }, "type": "object" }, "azure-native:app:OpenIdConnectConfigResponse": { "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.", "properties": { "authorizationEndpoint": { "type": "string", "description": "The endpoint to be used to make an authorization request." }, "certificationUri": { "type": "string", "description": "The endpoint that provides the keys necessary to validate the token." }, "issuer": { "type": "string", "description": "The endpoint that issues the token." }, "tokenEndpoint": { "type": "string", "description": "The endpoint to be used to request a token." }, "wellKnownOpenIdConfiguration": { "type": "string", "description": "The endpoint that contains all the configuration endpoints for the provider." } }, "type": "object" }, "azure-native:app:OpenIdConnectLogin": { "description": "The configuration settings of the login flow of the custom Open ID Connect provider.", "properties": { "nameClaimType": { "type": "string", "description": "The name of the claim that contains the users name." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "A list of the scopes that should be requested while authenticating." } }, "type": "object" }, "azure-native:app:OpenIdConnectLoginResponse": { "description": "The configuration settings of the login flow of the custom Open ID Connect provider.", "properties": { "nameClaimType": { "type": "string", "description": "The name of the claim that contains the users name." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "A list of the scopes that should be requested while authenticating." } }, "type": "object" }, "azure-native:app:OpenIdConnectRegistration": { "description": "The configuration settings of the app registration for the custom Open ID Connect provider.", "properties": { "clientCredential": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectClientCredential", "description": "The authentication credentials of the custom Open ID Connect provider." }, "clientId": { "type": "string", "description": "The client id of the custom Open ID Connect provider." }, "openIdConnectConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectConfig", "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider." } }, "type": "object" }, "azure-native:app:OpenIdConnectRegistrationResponse": { "description": "The configuration settings of the app registration for the custom Open ID Connect provider.", "properties": { "clientCredential": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectClientCredentialResponse", "description": "The authentication credentials of the custom Open ID Connect provider." }, "clientId": { "type": "string", "description": "The client id of the custom Open ID Connect provider." }, "openIdConnectConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:OpenIdConnectConfigResponse", "description": "The configuration settings of the endpoints used for the custom Open ID Connect provider." } }, "type": "object" }, "azure-native:app:OpenTelemetryConfiguration": { "description": "Configuration of Open Telemetry", "properties": { "destinationsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:DestinationsConfiguration", "description": "Open telemetry destinations configuration" }, "logsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LogsConfiguration", "description": "Open telemetry logs configuration" }, "metricsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:MetricsConfiguration", "description": "Open telemetry metrics configuration" }, "tracesConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:TracesConfiguration", "description": "Open telemetry trace configuration" } }, "type": "object" }, "azure-native:app:OpenTelemetryConfigurationResponse": { "description": "Configuration of Open Telemetry", "properties": { "destinationsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:DestinationsConfigurationResponse", "description": "Open telemetry destinations configuration" }, "logsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:LogsConfigurationResponse", "description": "Open telemetry logs configuration" }, "metricsConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:MetricsConfigurationResponse", "description": "Open telemetry metrics configuration" }, "tracesConfiguration": { "type": "object", "$ref": "#/types/azure-native:app:TracesConfigurationResponse", "description": "Open telemetry trace configuration" } }, "type": "object" }, "azure-native:app:OtlpConfiguration": { "description": "Configuration of otlp ", "properties": { "endpoint": { "type": "string", "description": "The endpoint of otlp configuration" }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Header" }, "description": "Headers of otlp configurations" }, "insecure": { "type": "boolean", "description": "Boolean indicating if otlp configuration is insecure" }, "name": { "type": "string", "description": "The name of otlp configuration" } }, "type": "object" }, "azure-native:app:OtlpConfigurationResponse": { "description": "Configuration of otlp ", "properties": { "endpoint": { "type": "string", "description": "The endpoint of otlp configuration" }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:HeaderResponse" }, "description": "Headers of otlp configurations" }, "insecure": { "type": "boolean", "description": "Boolean indicating if otlp configuration is insecure" }, "name": { "type": "string", "description": "The name of otlp configuration" } }, "type": "object" }, "azure-native:app:PatchingMode": { "description": "Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching.", "type": "string", "enum": [ { "value": "Automatic" }, { "value": "Manual" }, { "value": "Disabled" } ] }, "azure-native:app:PoolManagementType": { "description": "The pool management type of the session pool.", "type": "string", "enum": [ { "value": "Manual" }, { "value": "Dynamic" } ] }, "azure-native:app:PreBuildStep": { "description": "Model representing a pre-build step.", "properties": { "description": { "type": "string", "description": "Description of the pre-build step." }, "httpGet": { "type": "object", "$ref": "#/types/azure-native:app:HttpGet", "description": "Http get request to send before the build." }, "scripts": { "type": "array", "items": { "type": "string" }, "description": "List of custom commands to run." } }, "type": "object" }, "azure-native:app:PreBuildStepResponse": { "description": "Model representing a pre-build step.", "properties": { "description": { "type": "string", "description": "Description of the pre-build step." }, "httpGet": { "type": "object", "$ref": "#/types/azure-native:app:HttpGetResponse", "description": "Http get request to send before the build." }, "scripts": { "type": "array", "items": { "type": "string" }, "description": "List of custom commands to run." } }, "type": "object" }, "azure-native:app:PrivateEndpointConnectionResponse": { "description": "The Private Endpoint Connection resource.", "properties": { "groupIds": { "type": "array", "items": { "type": "string" }, "description": "The group ids for the private endpoint resource." }, "id": { "type": "string", "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" }, "name": { "type": "string", "description": "The name of the resource" }, "privateEndpoint": { "type": "object", "$ref": "#/types/azure-native:app:PrivateEndpointResponse", "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:app:PrivateLinkServiceConnectionStateResponse", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "type": "string", "description": "The provisioning state of the private endpoint connection resource." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:app:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "groupIds", "id", "name", "privateLinkServiceConnectionState", "provisioningState", "systemData", "type" ] }, "azure-native:app:PrivateEndpointResponse": { "description": "The Private Endpoint resource.", "properties": { "id": { "type": "string", "description": "The ARM identifier for Private Endpoint" } }, "type": "object", "required": [ "id" ] }, "azure-native:app:PrivateEndpointServiceConnectionStatus": { "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", "type": "string", "enum": [ { "value": "Pending" }, { "value": "Approved" }, { "value": "Rejected" }, { "value": "Disconnected" } ] }, "azure-native:app:PrivateLinkServiceConnectionState": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:PrivateEndpointServiceConnectionStatus" } ], "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:app:PrivateLinkServiceConnectionStateResponse": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "type": "string", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:app:PublicNetworkAccess": { "description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled'.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:app:QueueScaleRule": { "description": "Container App container Azure Queue based scaling rule.", "properties": { "accountName": { "type": "string", "description": "Storage account name. required if using managed identity to authenticate" }, "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuth" }, "description": "Authentication secrets for the queue scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "queueLength": { "type": "integer", "description": "Queue length." }, "queueName": { "type": "string", "description": "Queue name." } }, "type": "object" }, "azure-native:app:QueueScaleRuleResponse": { "description": "Container App container Azure Queue based scaling rule.", "properties": { "accountName": { "type": "string", "description": "Storage account name. required if using managed identity to authenticate" }, "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the queue scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "queueLength": { "type": "integer", "description": "Queue length." }, "queueName": { "type": "string", "description": "Queue name." } }, "type": "object" }, "azure-native:app:RegistryCredentials": { "description": "Container App Private Registry", "properties": { "identity": { "type": "string", "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'" }, "passwordSecretRef": { "type": "string", "description": "The name of the Secret that contains the registry login password" }, "server": { "type": "string", "description": "Container Registry Server" }, "username": { "type": "string", "description": "Container Registry Username" } }, "type": "object" }, "azure-native:app:RegistryCredentialsResponse": { "description": "Container App Private Registry", "properties": { "identity": { "type": "string", "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'" }, "passwordSecretRef": { "type": "string", "description": "The name of the Secret that contains the registry login password" }, "server": { "type": "string", "description": "Container Registry Server" }, "username": { "type": "string", "description": "Container Registry Username" } }, "type": "object" }, "azure-native:app:RegistryInfo": { "description": "Container App registry information.", "properties": { "registryPassword": { "type": "string", "description": "registry secret." }, "registryUrl": { "type": "string", "description": "registry server Url." }, "registryUserName": { "type": "string", "description": "registry username." } }, "type": "object" }, "azure-native:app:RegistryInfoResponse": { "description": "Container App registry information.", "properties": { "registryUrl": { "type": "string", "description": "registry server Url." }, "registryUserName": { "type": "string", "description": "registry username." } }, "type": "object" }, "azure-native:app:Runtime": { "description": "Container App Runtime configuration.", "properties": { "dotnet": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeDotnet", "description": ".NET app configuration" }, "java": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeJava", "description": "Java app configuration" } }, "type": "object" }, "azure-native:app:RuntimeDotnet": { "description": ".NET app configuration", "properties": { "autoConfigureDataProtection": { "type": "boolean", "description": "Auto configure the ASP.NET Core Data Protection feature" } }, "type": "object" }, "azure-native:app:RuntimeJava": { "description": "Java app configuration", "properties": { "enableMetrics": { "type": "boolean", "description": "Enable jmx core metrics for the java app" }, "javaAgent": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeJavaAgent", "description": "Diagnostic capabilities achieved by java agent" } }, "type": "object" }, "azure-native:app:RuntimeJavaAgent": { "description": "Diagnostic capabilities achieved by java agent", "properties": { "enabled": { "type": "boolean", "description": "Enable java agent injection for the java app." }, "logging": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeLogging", "description": "Capabilities on the java logging scenario." } }, "type": "object" }, "azure-native:app:RuntimeLogging": { "description": "Capabilities on the java logging scenario.", "properties": { "loggerSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:LoggerSetting" }, "description": "Settings of the logger for the java app." } }, "type": "object" }, "azure-native:app:RuntimeResponse": { "description": "Container App Runtime configuration.", "properties": { "dotnet": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeResponseDotnet", "description": ".NET app configuration" }, "java": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeResponseJava", "description": "Java app configuration" } }, "type": "object" }, "azure-native:app:RuntimeResponseDotnet": { "description": ".NET app configuration", "properties": { "autoConfigureDataProtection": { "type": "boolean", "description": "Auto configure the ASP.NET Core Data Protection feature" } }, "type": "object" }, "azure-native:app:RuntimeResponseJava": { "description": "Java app configuration", "properties": { "enableMetrics": { "type": "boolean", "description": "Enable jmx core metrics for the java app" }, "javaAgent": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeResponseJavaAgent", "description": "Diagnostic capabilities achieved by java agent" } }, "type": "object" }, "azure-native:app:RuntimeResponseJavaAgent": { "description": "Diagnostic capabilities achieved by java agent", "properties": { "enabled": { "type": "boolean", "description": "Enable java agent injection for the java app." }, "logging": { "type": "object", "$ref": "#/types/azure-native:app:RuntimeResponseLogging", "description": "Capabilities on the java logging scenario." } }, "type": "object" }, "azure-native:app:RuntimeResponseLogging": { "description": "Capabilities on the java logging scenario.", "properties": { "loggerSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:LoggerSettingResponse" }, "description": "Settings of the logger for the java app." } }, "type": "object" }, "azure-native:app:Scale": { "description": "Container App scaling configurations.", "properties": { "cooldownPeriod": { "type": "integer", "description": "Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set." }, "maxReplicas": { "type": "integer", "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", "default": 10 }, "minReplicas": { "type": "integer", "description": "Optional. Minimum number of container replicas." }, "pollingInterval": { "type": "integer", "description": "Optional. KEDA Polling Interval. Defaults to 30 seconds if not set." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRule" }, "description": "Scaling rules." } }, "type": "object" }, "azure-native:app:ScaleConfiguration": { "description": "Scale configuration.", "properties": { "maxConcurrentSessions": { "type": "integer", "description": "The maximum count of sessions at the same time." }, "readySessionInstances": { "type": "integer", "description": "The minimum count of ready session instances." } }, "type": "object" }, "azure-native:app:ScaleConfigurationResponse": { "description": "Scale configuration.", "properties": { "maxConcurrentSessions": { "type": "integer", "description": "The maximum count of sessions at the same time." }, "readySessionInstances": { "type": "integer", "description": "The minimum count of ready session instances." } }, "type": "object" }, "azure-native:app:ScaleResponse": { "description": "Container App scaling configurations.", "properties": { "cooldownPeriod": { "type": "integer", "description": "Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set." }, "maxReplicas": { "type": "integer", "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", "default": 10 }, "minReplicas": { "type": "integer", "description": "Optional. Minimum number of container replicas." }, "pollingInterval": { "type": "integer", "description": "Optional. KEDA Polling Interval. Defaults to 30 seconds if not set." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleResponse" }, "description": "Scaling rules." } }, "type": "object" }, "azure-native:app:ScaleRule": { "description": "Container App container scaling rule.", "properties": { "azureQueue": { "type": "object", "$ref": "#/types/azure-native:app:QueueScaleRule", "description": "Azure Queue based scaling." }, "custom": { "type": "object", "$ref": "#/types/azure-native:app:CustomScaleRule", "description": "Custom scale rule." }, "http": { "type": "object", "$ref": "#/types/azure-native:app:HttpScaleRule", "description": "HTTP requests based scaling." }, "name": { "type": "string", "description": "Scale Rule Name" }, "tcp": { "type": "object", "$ref": "#/types/azure-native:app:TcpScaleRule", "description": "Tcp requests based scaling." } }, "type": "object" }, "azure-native:app:ScaleRuleAuth": { "description": "Auth Secrets for Scale Rule", "properties": { "secretRef": { "type": "string", "description": "Name of the secret from which to pull the auth params." }, "triggerParameter": { "type": "string", "description": "Trigger Parameter that uses the secret" } }, "type": "object" }, "azure-native:app:ScaleRuleAuthResponse": { "description": "Auth Secrets for Scale Rule", "properties": { "secretRef": { "type": "string", "description": "Name of the secret from which to pull the auth params." }, "triggerParameter": { "type": "string", "description": "Trigger Parameter that uses the secret" } }, "type": "object" }, "azure-native:app:ScaleRuleResponse": { "description": "Container App container scaling rule.", "properties": { "azureQueue": { "type": "object", "$ref": "#/types/azure-native:app:QueueScaleRuleResponse", "description": "Azure Queue based scaling." }, "custom": { "type": "object", "$ref": "#/types/azure-native:app:CustomScaleRuleResponse", "description": "Custom scale rule." }, "http": { "type": "object", "$ref": "#/types/azure-native:app:HttpScaleRuleResponse", "description": "HTTP requests based scaling." }, "name": { "type": "string", "description": "Scale Rule Name" }, "tcp": { "type": "object", "$ref": "#/types/azure-native:app:TcpScaleRuleResponse", "description": "Tcp requests based scaling." } }, "type": "object" }, "azure-native:app:ScgRoute": { "description": "Spring Cloud Gateway route definition", "properties": { "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters of the route" }, "id": { "type": "string", "description": "Id of the route" }, "order": { "type": "number", "description": "Order of the route" }, "predicates": { "type": "array", "items": { "type": "string" }, "description": "Predicates of the route" }, "uri": { "type": "string", "description": "Uri of the route" } }, "type": "object", "required": [ "id", "uri" ] }, "azure-native:app:ScgRouteResponse": { "description": "Spring Cloud Gateway route definition", "properties": { "filters": { "type": "array", "items": { "type": "string" }, "description": "Filters of the route" }, "id": { "type": "string", "description": "Id of the route" }, "order": { "type": "number", "description": "Order of the route" }, "predicates": { "type": "array", "items": { "type": "string" }, "description": "Predicates of the route" }, "uri": { "type": "string", "description": "Uri of the route" } }, "type": "object", "required": [ "id", "uri" ] }, "azure-native:app:ScheduledEntry": { "description": "Maintenance schedule entry for a managed environment.", "properties": { "durationHours": { "type": "integer", "description": "Length of maintenance window range from 8 to 24 hours." }, "startHourUtc": { "type": "integer", "description": "Start hour after which managed environment maintenance can start from 0 to 23 hour." }, "weekDay": { "$ref": "#/types/azure-native:app:WeekDay", "description": "Day of the week when a managed environment can be patched." } }, "type": "object", "required": [ "durationHours", "startHourUtc", "weekDay" ] }, "azure-native:app:ScheduledEntryResponse": { "description": "Maintenance schedule entry for a managed environment.", "properties": { "durationHours": { "type": "integer", "description": "Length of maintenance window range from 8 to 24 hours." }, "startHourUtc": { "type": "integer", "description": "Start hour after which managed environment maintenance can start from 0 to 23 hour." }, "weekDay": { "type": "string", "description": "Day of the week when a managed environment can be patched." } }, "type": "object", "required": [ "durationHours", "startHourUtc", "weekDay" ] }, "azure-native:app:Scheme": { "description": "Scheme to use for connecting to the host. Defaults to HTTP.", "type": "string", "enum": [ { "value": "HTTP" }, { "value": "HTTPS" } ] }, "azure-native:app:Secret": { "description": "Secret definition.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "Azure Key Vault URL pointing to the secret referenced by the container app." }, "name": { "type": "string", "description": "Secret Name." }, "value": { "type": "string", "description": "Secret Value." } }, "type": "object" }, "azure-native:app:SecretKeyVaultProperties": { "description": "Properties for a secret stored in a Key Vault.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "URL pointing to the Azure Key Vault secret." } }, "type": "object" }, "azure-native:app:SecretKeyVaultPropertiesResponse": { "description": "Properties for a secret stored in a Key Vault.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "URL pointing to the Azure Key Vault secret." } }, "type": "object" }, "azure-native:app:SecretResponse": { "description": "Secret definition.", "properties": { "identity": { "type": "string", "description": "Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity." }, "keyVaultUrl": { "type": "string", "description": "Azure Key Vault URL pointing to the secret referenced by the container app." }, "name": { "type": "string", "description": "Secret Name." } }, "type": "object" }, "azure-native:app:SecretVolumeItem": { "description": "Secret to be added to volume.", "properties": { "path": { "type": "string", "description": "Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef." }, "secretRef": { "type": "string", "description": "Name of the Container App secret from which to pull the secret value." } }, "type": "object" }, "azure-native:app:SecretVolumeItemResponse": { "description": "Secret to be added to volume.", "properties": { "path": { "type": "string", "description": "Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef." }, "secretRef": { "type": "string", "description": "Name of the Container App secret from which to pull the secret value." } }, "type": "object" }, "azure-native:app:Service": { "description": "Container App to be a dev service", "properties": { "type": { "type": "string", "description": "Dev ContainerApp service type" } }, "type": "object", "required": [ "type" ] }, "azure-native:app:ServiceBind": { "description": "Configuration to bind a ContainerApp to a dev ContainerApp Service", "properties": { "clientType": { "type": "string", "description": "Type of the client to be used to connect to the service" }, "customizedKeys": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Customized keys for customizing injected values to the app" }, "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:ServiceBindResponse": { "description": "Configuration to bind a ContainerApp to a dev ContainerApp Service", "properties": { "clientType": { "type": "string", "description": "Type of the client to be used to connect to the service" }, "customizedKeys": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Customized keys for customizing injected values to the app" }, "name": { "type": "string", "description": "Name of the service bind" }, "serviceId": { "type": "string", "description": "Resource id of the target service" } }, "type": "object" }, "azure-native:app:ServiceResponse": { "description": "Container App to be a dev service", "properties": { "type": { "type": "string", "description": "Dev ContainerApp service type" } }, "type": "object", "required": [ "type" ] }, "azure-native:app:SessionContainer": { "description": "Container definitions for the sessions of the session pool.", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Container start command arguments." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Container start command." }, "env": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVar" }, "description": "Container environment variables." }, "image": { "type": "string", "description": "Container image tag." }, "name": { "type": "string", "description": "Custom container name." }, "probes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbe" }, "description": "List of probes for the container." }, "resources": { "type": "object", "$ref": "#/types/azure-native:app:SessionContainerResources", "description": "Container resource requirements." } }, "type": "object" }, "azure-native:app:SessionContainerResources": { "description": "Container resource requirements for sessions of the session pool.", "properties": { "cpu": { "type": "number", "description": "Required CPU in cores, e.g. 0.5" }, "memory": { "type": "string", "description": "Required memory, e.g. \"250Mb\"" } }, "type": "object" }, "azure-native:app:SessionContainerResourcesResponse": { "description": "Container resource requirements for sessions of the session pool.", "properties": { "cpu": { "type": "number", "description": "Required CPU in cores, e.g. 0.5" }, "memory": { "type": "string", "description": "Required memory, e.g. \"250Mb\"" } }, "type": "object" }, "azure-native:app:SessionContainerResponse": { "description": "Container definitions for the sessions of the session pool.", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Container start command arguments." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Container start command." }, "env": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:EnvironmentVarResponse" }, "description": "Container environment variables." }, "image": { "type": "string", "description": "Container image tag." }, "name": { "type": "string", "description": "Custom container name." }, "probes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeResponse" }, "description": "List of probes for the container." }, "resources": { "type": "object", "$ref": "#/types/azure-native:app:SessionContainerResourcesResponse", "description": "Container resource requirements." } }, "type": "object" }, "azure-native:app:SessionIngress": { "description": "Session pool ingress configuration.", "properties": { "targetPort": { "type": "integer", "description": "Target port in containers for traffic from ingress" } }, "type": "object" }, "azure-native:app:SessionIngressResponse": { "description": "Session pool ingress configuration.", "properties": { "targetPort": { "type": "integer", "description": "Target port in containers for traffic from ingress" } }, "type": "object" }, "azure-native:app:SessionNetworkConfiguration": { "description": "Session network configuration.", "properties": { "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:SessionNetworkStatus" } ], "description": "Network status for the sessions." } }, "type": "object" }, "azure-native:app:SessionNetworkConfigurationResponse": { "description": "Session network configuration.", "properties": { "status": { "type": "string", "description": "Network status for the sessions." } }, "type": "object" }, "azure-native:app:SessionNetworkStatus": { "description": "Network status for the sessions.", "type": "string", "enum": [ { "value": "EgressEnabled" }, { "value": "EgressDisabled" } ] }, "azure-native:app:SessionPoolSecret": { "description": "Secret definition.", "properties": { "name": { "type": "string", "description": "Secret Name." }, "value": { "type": "string", "description": "Secret Value." } }, "type": "object" }, "azure-native:app:SessionPoolSecretResponse": { "description": "Secret definition.", "properties": { "name": { "type": "string", "description": "Secret Name." } }, "type": "object" }, "azure-native:app:SessionProbe": { "description": "Session probe configuration.", "properties": { "failureThreshold": { "type": "integer", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10." }, "httpGet": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeHttpGet", "description": "HTTPGet specifies the http request to perform." }, "initialDelaySeconds": { "type": "integer", "description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60." }, "periodSeconds": { "type": "integer", "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240." }, "successThreshold": { "type": "integer", "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10." }, "tcpSocket": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeTcpSocket", "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported." }, "terminationGracePeriodSeconds": { "type": "number", "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)" }, "timeoutSeconds": { "type": "integer", "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:SessionProbeType" } ], "description": "Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes)." } }, "type": "object" }, "azure-native:app:SessionProbeHttpGet": { "description": "HTTPGet specifies the http request to perform.", "properties": { "host": { "type": "string", "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." }, "httpHeaders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeHttpHeaders" }, "description": "Custom headers to set in the request. HTTP allows repeated headers." }, "path": { "type": "string", "description": "Path to access on the HTTP server." }, "port": { "type": "integer", "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." }, "scheme": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:Scheme" } ], "description": "Scheme to use for connecting to the host. Defaults to HTTP." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:SessionProbeHttpHeaders": { "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "type": "string", "description": "The header field name" }, "value": { "type": "string", "description": "The header field value" } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:SessionProbeResponse": { "description": "Session probe configuration.", "properties": { "failureThreshold": { "type": "integer", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10." }, "httpGet": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeResponseHttpGet", "description": "HTTPGet specifies the http request to perform." }, "initialDelaySeconds": { "type": "integer", "description": "Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60." }, "periodSeconds": { "type": "integer", "description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240." }, "successThreshold": { "type": "integer", "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10." }, "tcpSocket": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeResponseTcpSocket", "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported." }, "terminationGracePeriodSeconds": { "type": "number", "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour)" }, "timeoutSeconds": { "type": "integer", "description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240." }, "type": { "type": "string", "description": "Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes)." } }, "type": "object" }, "azure-native:app:SessionProbeResponseHttpGet": { "description": "HTTPGet specifies the http request to perform.", "properties": { "host": { "type": "string", "description": "Host name to connect to, defaults to the pod IP. You probably want to set \"Host\" in httpHeaders instead." }, "httpHeaders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SessionProbeResponseHttpHeaders" }, "description": "Custom headers to set in the request. HTTP allows repeated headers." }, "path": { "type": "string", "description": "Path to access on the HTTP server." }, "port": { "type": "integer", "description": "Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." }, "scheme": { "type": "string", "description": "Scheme to use for connecting to the host. Defaults to HTTP." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:SessionProbeResponseHttpHeaders": { "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "type": "string", "description": "The header field name" }, "value": { "type": "string", "description": "The header field value" } }, "type": "object", "required": [ "name", "value" ] }, "azure-native:app:SessionProbeResponseTcpSocket": { "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.", "properties": { "host": { "type": "string", "description": "Optional: Host name to connect to, defaults to the pod IP." }, "port": { "type": "integer", "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:SessionProbeTcpSocket": { "description": "TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported.", "properties": { "host": { "type": "string", "description": "Optional: Host name to connect to, defaults to the pod IP." }, "port": { "type": "integer", "description": "Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME." } }, "type": "object", "required": [ "port" ] }, "azure-native:app:SessionProbeType": { "description": "Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes).", "type": "string", "enum": [ { "value": "Liveness" }, { "value": "Startup" } ] }, "azure-native:app:SessionRegistryCredentials": { "description": "Session pool private registry credentials.", "properties": { "identity": { "type": "string", "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'" }, "passwordSecretRef": { "type": "string", "description": "The name of the secret that contains the registry login password" }, "server": { "type": "string", "description": "Container registry server." }, "username": { "type": "string", "description": "Container registry username." } }, "type": "object" }, "azure-native:app:SessionRegistryCredentialsResponse": { "description": "Session pool private registry credentials.", "properties": { "identity": { "type": "string", "description": "A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'" }, "passwordSecretRef": { "type": "string", "description": "The name of the secret that contains the registry login password" }, "server": { "type": "string", "description": "Container registry server." }, "username": { "type": "string", "description": "Container registry username." } }, "type": "object" }, "azure-native:app:SmbStorage": { "description": "SMB storage properties", "properties": { "accessMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:AccessMode" } ], "description": "Access mode for storage" }, "domain": { "type": "string", "description": "The domain name for the user." }, "host": { "type": "string", "description": "The host name or IP address of the SMB server." }, "password": { "type": "string", "description": "The password for the user." }, "shareName": { "type": "string", "description": "The path to the SMB shared folder." }, "username": { "type": "string", "description": "The user to log on to the SMB server." } }, "type": "object" }, "azure-native:app:SmbStorageResponse": { "description": "SMB storage properties", "properties": { "accessMode": { "type": "string", "description": "Access mode for storage" }, "domain": { "type": "string", "description": "The domain name for the user." }, "host": { "type": "string", "description": "The host name or IP address of the SMB server." }, "password": { "type": "string", "description": "The password for the user." }, "shareName": { "type": "string", "description": "The path to the SMB shared folder." }, "username": { "type": "string", "description": "The user to log on to the SMB server." } }, "type": "object" }, "azure-native:app:SpringBootAdminComponent": { "description": "Spring Boot Admin properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringBootAdmin'.", "const": "SpringBootAdmin" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationProperty" }, "description": "List of Java Components configuration properties" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBind" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType" ] }, "azure-native:app:SpringBootAdminComponentResponse": { "description": "Spring Boot Admin properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringBootAdmin'.", "const": "SpringBootAdmin" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationPropertyResponse" }, "description": "List of Java Components configuration properties" }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentIngressResponse", "description": "Java Component Ingress configurations." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Java Component." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesResponseScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBindResponse" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType", "provisioningState" ] }, "azure-native:app:SpringCloudConfigComponent": { "description": "Spring Cloud Config properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringCloudConfig'.", "const": "SpringCloudConfig" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationProperty" }, "description": "List of Java Components configuration properties" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBind" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType" ] }, "azure-native:app:SpringCloudConfigComponentResponse": { "description": "Spring Cloud Config properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringCloudConfig'.", "const": "SpringCloudConfig" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationPropertyResponse" }, "description": "List of Java Components configuration properties" }, "provisioningState": { "type": "string", "description": "Provisioning state of the Java Component." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesResponseScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBindResponse" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType", "provisioningState" ] }, "azure-native:app:SpringCloudEurekaComponent": { "description": "Spring Cloud Eureka properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringCloudEureka'.", "const": "SpringCloudEureka" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationProperty" }, "description": "List of Java Components configuration properties" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBind" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType" ] }, "azure-native:app:SpringCloudEurekaComponentResponse": { "description": "Spring Cloud Eureka properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringCloudEureka'.", "const": "SpringCloudEureka" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationPropertyResponse" }, "description": "List of Java Components configuration properties" }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentIngressResponse", "description": "Java Component Ingress configurations." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Java Component." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesResponseScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBindResponse" }, "description": "List of Java Components that are bound to the Java component" } }, "type": "object", "required": [ "componentType", "provisioningState" ] }, "azure-native:app:SpringCloudGatewayComponent": { "description": "Spring Cloud Gateway properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringCloudGateway'.", "const": "SpringCloudGateway" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationProperty" }, "description": "List of Java Components configuration properties" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBind" }, "description": "List of Java Components that are bound to the Java component" }, "springCloudGatewayRoutes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScgRoute" }, "description": "Gateway route definition" } }, "type": "object", "required": [ "componentType" ] }, "azure-native:app:SpringCloudGatewayComponentResponse": { "description": "Spring Cloud Gateway properties.", "properties": { "componentType": { "type": "string", "description": "Type of the Java Component.\nExpected value is 'SpringCloudGateway'.", "const": "SpringCloudGateway" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentConfigurationPropertyResponse" }, "description": "List of Java Components configuration properties" }, "ingress": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentIngressResponse", "description": "Java Component Ingress configurations." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Java Component." }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentPropertiesResponseScale", "description": "Java component scaling configurations" }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:JavaComponentServiceBindResponse" }, "description": "List of Java Components that are bound to the Java component" }, "springCloudGatewayRoutes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScgRouteResponse" }, "description": "Gateway route definition" } }, "type": "object", "required": [ "componentType", "provisioningState" ] }, "azure-native:app:StorageType": { "description": "Storage type for the volume. If not provided, use EmptyDir.", "type": "string", "enum": [ { "value": "AzureFile" }, { "value": "EmptyDir" }, { "value": "Secret" }, { "value": "NfsAzureFile" }, { "value": "Smb" } ] }, "azure-native:app:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:app:TcpConnectionPool": { "description": "Defines parameters for tcp connection pooling", "properties": { "maxConnections": { "type": "integer", "description": "Maximum number of tcp connections allowed" } }, "type": "object" }, "azure-native:app:TcpConnectionPoolResponse": { "description": "Defines parameters for tcp connection pooling", "properties": { "maxConnections": { "type": "integer", "description": "Maximum number of tcp connections allowed" } }, "type": "object" }, "azure-native:app:TcpRetryPolicy": { "description": "Policy that defines tcp request retry conditions", "properties": { "maxConnectAttempts": { "type": "integer", "description": "Maximum number of attempts to connect to the tcp service" } }, "type": "object" }, "azure-native:app:TcpRetryPolicyResponse": { "description": "Policy that defines tcp request retry conditions", "properties": { "maxConnectAttempts": { "type": "integer", "description": "Maximum number of attempts to connect to the tcp service" } }, "type": "object" }, "azure-native:app:TcpScaleRule": { "description": "Container App container Tcp scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuth" }, "description": "Authentication secrets for the tcp scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe tcp scale rule." } }, "type": "object" }, "azure-native:app:TcpScaleRuleResponse": { "description": "Container App container Tcp scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the tcp scale rule." }, "identity": { "type": "string", "description": "The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe tcp scale rule." } }, "type": "object" }, "azure-native:app:Template": { "description": "Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created", "properties": { "containers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Container" }, "description": "List of container definitions for the Container App." }, "initContainers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:InitContainer" }, "description": "List of specialized containers that run before app containers." }, "revisionSuffix": { "type": "string", "description": "User friendly suffix that is appended to the revision name" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:Scale", "description": "Scaling properties for the Container App." }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ServiceBind" }, "description": "List of container app services bound to the app" }, "terminationGracePeriodSeconds": { "type": "number", "description": "Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds." }, "volumes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:Volume" }, "description": "List of volume definitions for the Container App." } }, "type": "object" }, "azure-native:app:TemplateResponse": { "description": "Container App versioned application definition.\nDefines the desired state of an immutable revision.\nAny changes to this section Will result in a new revision being created", "properties": { "containers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ContainerResponse" }, "description": "List of container definitions for the Container App." }, "initContainers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:InitContainerResponse" }, "description": "List of specialized containers that run before app containers." }, "revisionSuffix": { "type": "string", "description": "User friendly suffix that is appended to the revision name" }, "scale": { "type": "object", "$ref": "#/types/azure-native:app:ScaleResponse", "description": "Scaling properties for the Container App." }, "serviceBinds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:ServiceBindResponse" }, "description": "List of container app services bound to the app" }, "terminationGracePeriodSeconds": { "type": "number", "description": "Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds." }, "volumes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:VolumeResponse" }, "description": "List of volume definitions for the Container App." } }, "type": "object" }, "azure-native:app:TimeoutPolicy": { "description": "Policy to set request timeouts", "properties": { "connectionTimeoutInSeconds": { "type": "integer", "description": "Timeout, in seconds, for a request to initiate a connection" }, "responseTimeoutInSeconds": { "type": "integer", "description": "Timeout, in seconds, for a request to respond" } }, "type": "object" }, "azure-native:app:TimeoutPolicyResponse": { "description": "Policy to set request timeouts", "properties": { "connectionTimeoutInSeconds": { "type": "integer", "description": "Timeout, in seconds, for a request to initiate a connection" }, "responseTimeoutInSeconds": { "type": "integer", "description": "Timeout, in seconds, for a request to respond" } }, "type": "object" }, "azure-native:app:TokenStore": { "description": "The configuration settings of the token store.", "properties": { "azureBlobStorage": { "type": "object", "$ref": "#/types/azure-native:app:BlobStorageTokenStore", "description": "The configuration settings of the storage of the tokens if blob storage is used." }, "enabled": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e to durably store platform-specific security tokens that are obtained during login flows; otherwise, \u003ccode\u003efalse\u003c/code\u003e.\n The default is \u003ccode\u003efalse\u003c/code\u003e." }, "tokenRefreshExtensionHours": { "type": "number", "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours." } }, "type": "object" }, "azure-native:app:TokenStoreResponse": { "description": "The configuration settings of the token store.", "properties": { "azureBlobStorage": { "type": "object", "$ref": "#/types/azure-native:app:BlobStorageTokenStoreResponse", "description": "The configuration settings of the storage of the tokens if blob storage is used." }, "enabled": { "type": "boolean", "description": "\u003ccode\u003etrue\u003c/code\u003e to durably store platform-specific security tokens that are obtained during login flows; otherwise, \u003ccode\u003efalse\u003c/code\u003e.\n The default is \u003ccode\u003efalse\u003c/code\u003e." }, "tokenRefreshExtensionHours": { "type": "number", "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours." } }, "type": "object" }, "azure-native:app:TracesConfiguration": { "description": "Configuration of Open Telemetry traces", "properties": { "destinations": { "type": "array", "items": { "type": "string" }, "description": "Open telemetry traces destinations" }, "includeDapr": { "type": "boolean", "description": "Boolean indicating if including dapr traces" } }, "type": "object" }, "azure-native:app:TracesConfigurationResponse": { "description": "Configuration of Open Telemetry traces", "properties": { "destinations": { "type": "array", "items": { "type": "string" }, "description": "Open telemetry traces destinations" }, "includeDapr": { "type": "boolean", "description": "Boolean indicating if including dapr traces" } }, "type": "object" }, "azure-native:app:TrafficWeight": { "description": "Traffic weight assigned to a revision", "properties": { "label": { "type": "string", "description": "Associates a traffic label with a revision" }, "latestRevision": { "type": "boolean", "description": "Indicates that the traffic weight belongs to a latest stable revision", "default": false }, "revisionName": { "type": "string", "description": "Name of a revision" }, "weight": { "type": "integer", "description": "Traffic weight assigned to a revision" } }, "type": "object" }, "azure-native:app:TrafficWeightResponse": { "description": "Traffic weight assigned to a revision", "properties": { "label": { "type": "string", "description": "Associates a traffic label with a revision" }, "latestRevision": { "type": "boolean", "description": "Indicates that the traffic weight belongs to a latest stable revision", "default": false }, "revisionName": { "type": "string", "description": "Name of a revision" }, "weight": { "type": "integer", "description": "Traffic weight assigned to a revision" } }, "type": "object" }, "azure-native:app:TriggerType": { "description": "Trigger type of the job", "type": "string", "enum": [ { "value": "Schedule" }, { "value": "Event" }, { "value": "Manual" } ] }, "azure-native:app:Twitter": { "description": "The configuration settings of the Twitter provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Twitter provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:TwitterRegistration", "description": "The configuration settings of the app registration for the Twitter provider." } }, "type": "object" }, "azure-native:app:TwitterRegistration": { "description": "The configuration settings of the app registration for the Twitter provider.", "properties": { "consumerKey": { "type": "string", "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in" }, "consumerSecretSettingName": { "type": "string", "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in." } }, "type": "object" }, "azure-native:app:TwitterRegistrationResponse": { "description": "The configuration settings of the app registration for the Twitter provider.", "properties": { "consumerKey": { "type": "string", "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in" }, "consumerSecretSettingName": { "type": "string", "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in." } }, "type": "object" }, "azure-native:app:TwitterResponse": { "description": "The configuration settings of the Twitter provider.", "properties": { "enabled": { "type": "boolean", "description": "\u003ccode\u003efalse\u003c/code\u003e if the Twitter provider should not be enabled despite the set registration; otherwise, \u003ccode\u003etrue\u003c/code\u003e." }, "registration": { "type": "object", "$ref": "#/types/azure-native:app:TwitterRegistrationResponse", "description": "The configuration settings of the app registration for the Twitter provider." } }, "type": "object" }, "azure-native:app:Type": { "description": "The type of probe.", "type": "string", "enum": [ { "value": "Liveness" }, { "value": "Readiness" }, { "value": "Startup" } ] }, "azure-native:app:UnauthenticatedClientActionV2": { "description": "The action to take when an unauthenticated client attempts to access the app.", "type": "string", "enum": [ { "value": "RedirectToLoginPage" }, { "value": "AllowAnonymous" }, { "value": "Return401" }, { "value": "Return403" } ] }, "azure-native:app:UpgradeChannel": { "description": "The upgrade channel of the agent", "type": "string", "enum": [ { "name": "Preview", "description": "Preview upgrade channel", "value": "Preview" }, { "name": "Stable", "description": "Stable upgrade channel", "value": "Stable" } ] }, "azure-native:app:UserAssignedIdentityResponse": { "description": "User assigned identity properties", "properties": { "clientId": { "type": "string", "description": "The client ID of the assigned identity." }, "principalId": { "type": "string", "description": "The principal ID of the assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:app:VnetConfiguration": { "description": "Configuration properties for apps environment to join a Virtual Network", "properties": { "dockerBridgeCidr": { "type": "string", "description": "CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges." }, "infrastructureSubnetId": { "type": "string", "description": "Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges." }, "internal": { "type": "boolean", "description": "Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property" }, "platformReservedCidr": { "type": "string", "description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges." }, "platformReservedDnsIP": { "type": "string", "description": " An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server." } }, "type": "object" }, "azure-native:app:VnetConfigurationResponse": { "description": "Configuration properties for apps environment to join a Virtual Network", "properties": { "dockerBridgeCidr": { "type": "string", "description": "CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges." }, "infrastructureSubnetId": { "type": "string", "description": "Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges." }, "internal": { "type": "boolean", "description": "Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property" }, "platformReservedCidr": { "type": "string", "description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges." }, "platformReservedDnsIP": { "type": "string", "description": " An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server." } }, "type": "object" }, "azure-native:app:Volume": { "description": "Volume definitions for the Container App.", "properties": { "mountOptions": { "type": "string", "description": "Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string." }, "name": { "type": "string", "description": "Volume name." }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SecretVolumeItem" }, "description": "List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume." }, "storageName": { "type": "string", "description": "Name of storage resource. No need to provide for EmptyDir and Secret." }, "storageType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:app:StorageType" } ], "description": "Storage type for the volume. If not provided, use EmptyDir." } }, "type": "object" }, "azure-native:app:VolumeMount": { "description": "Volume mount for the Container App.", "properties": { "mountPath": { "type": "string", "description": "Path within the container at which the volume should be mounted.Must not contain ':'." }, "subPath": { "type": "string", "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)." }, "volumeName": { "type": "string", "description": "This must match the Name of a Volume." } }, "type": "object" }, "azure-native:app:VolumeMountResponse": { "description": "Volume mount for the Container App.", "properties": { "mountPath": { "type": "string", "description": "Path within the container at which the volume should be mounted.Must not contain ':'." }, "subPath": { "type": "string", "description": "Path within the volume from which the container's volume should be mounted. Defaults to \"\" (volume's root)." }, "volumeName": { "type": "string", "description": "This must match the Name of a Volume." } }, "type": "object" }, "azure-native:app:VolumeResponse": { "description": "Volume definitions for the Container App.", "properties": { "mountOptions": { "type": "string", "description": "Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string." }, "name": { "type": "string", "description": "Volume name." }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:app:SecretVolumeItemResponse" }, "description": "List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume." }, "storageName": { "type": "string", "description": "Name of storage resource. No need to provide for EmptyDir and Secret." }, "storageType": { "type": "string", "description": "Storage type for the volume. If not provided, use EmptyDir." } }, "type": "object" }, "azure-native:app:WeekDay": { "description": "Day of the week when a managed environment can be patched.", "type": "string", "enum": [ { "value": "Monday" }, { "value": "Tuesday" }, { "value": "Wednesday" }, { "value": "Thursday" }, { "value": "Friday" }, { "value": "Saturday" }, { "value": "Sunday" } ] }, "azure-native:app:WorkflowEnvelopeResponseProperties": { "description": "Additional workflow properties.", "properties": { "files": { "$ref": "pulumi.json#/Any", "description": "Gets or sets the files." }, "flowState": { "type": "string", "description": "Gets or sets the state of the workflow." }, "health": { "type": "object", "$ref": "#/types/azure-native:app:WorkflowHealthResponse", "description": "Gets or sets workflow health." } }, "type": "object" }, "azure-native:app:WorkflowHealthResponse": { "description": "Represents the workflow health.", "properties": { "error": { "type": "object", "$ref": "#/types/azure-native:app:ErrorEntityResponse", "description": "Gets or sets the workflow error." }, "state": { "type": "string", "description": "Gets or sets the workflow health state." } }, "type": "object", "required": [ "state" ] }, "azure-native:app:WorkloadProfile": { "description": "Workload profile to scope container app execution.", "properties": { "enableFips": { "type": "boolean", "description": "Whether to use a FIPS-enabled OS. Supported only for dedicated workload profiles.", "default": false }, "maximumCount": { "type": "integer", "description": "The maximum capacity." }, "minimumCount": { "type": "integer", "description": "The minimum capacity." }, "name": { "type": "string", "description": "Workload profile type for the workloads to run on." }, "workloadProfileType": { "type": "string", "description": "Workload profile type for the workloads to run on." } }, "type": "object", "required": [ "name", "workloadProfileType" ] }, "azure-native:app:WorkloadProfileResponse": { "description": "Workload profile to scope container app execution.", "properties": { "enableFips": { "type": "boolean", "description": "Whether to use a FIPS-enabled OS. Supported only for dedicated workload profiles.", "default": false }, "maximumCount": { "type": "integer", "description": "The maximum capacity." }, "minimumCount": { "type": "integer", "description": "The minimum capacity." }, "name": { "type": "string", "description": "Workload profile type for the workloads to run on." }, "workloadProfileType": { "type": "string", "description": "Workload profile type for the workloads to run on." } }, "type": "object", "required": [ "name", "workloadProfileType" ] }, "azure-native:appcomplianceautomation:CertSyncRecordResponse": { "description": "A class represent the certification record synchronized from app compliance.", "properties": { "certificationStatus": { "type": "string", "description": "Indicates the status of certification process." }, "controls": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appcomplianceautomation:ControlSyncRecordResponse" }, "description": "The control records list to be synchronized." }, "ingestionStatus": { "type": "string", "description": "Indicates the status of compliance process." }, "offerGuid": { "type": "string", "description": "The offerGuid which mapping to the reports." } }, "type": "object" }, "azure-native:appcomplianceautomation:ContentType": { "description": "content type", "type": "string", "enum": [ { "name": "ApplicationJson", "description": "The content type is application/json.", "value": "application/json" } ] }, "azure-native:appcomplianceautomation:ControlSyncRecordResponse": { "description": "A class represent the control record synchronized from app compliance.", "properties": { "controlId": { "type": "string", "description": "The Id of the control. e.g. \"Operational_Security_10\"" }, "controlStatus": { "type": "string", "description": "Control status synchronized from app compliance." } }, "type": "object" }, "azure-native:appcomplianceautomation:EnableSslVerification": { "description": "whether to enable ssl verification", "type": "string", "enum": [ { "name": "True", "description": "The ssl verification is enabled.", "value": "true" }, { "name": "False", "description": "The ssl verification is not enabled.", "value": "false" } ] }, "azure-native:appcomplianceautomation:EvidenceType": { "description": "Evidence type.", "type": "string", "enum": [ { "name": "File", "description": "The evidence is a file.", "value": "File" }, { "name": "AutoCollectedEvidence", "description": "The evidence auto collected by App Compliance Automation.", "value": "AutoCollectedEvidence" }, { "name": "Data", "description": "The evidence is data.", "value": "Data" } ] }, "azure-native:appcomplianceautomation:NotificationEvent": { "description": "notification event.", "type": "string", "enum": [ { "name": "generate_snapshot_success", "description": "The subscribed report's snapshot is successfully generated.", "value": "generate_snapshot_success" }, { "name": "generate_snapshot_failed", "description": "The subscribed report's snapshot is failed to generate.", "value": "generate_snapshot_failed" }, { "name": "assessment_failure", "description": "The subscribed report failed while collecting the assessments.", "value": "assessment_failure" }, { "name": "report_configuration_changes", "description": "The subscribed report's configuration is changed.", "value": "report_configuration_changes" }, { "name": "report_deletion", "description": "The subscribed report is deleted.", "value": "report_deletion" } ] }, "azure-native:appcomplianceautomation:OverviewStatusResponse": { "description": "The overview of the compliance result for one report.", "properties": { "failedCount": { "type": "integer", "description": "The count of all failed control." }, "manualCount": { "type": "integer", "description": "The count of all manual control." }, "notApplicableCount": { "type": "integer", "description": "The count of all not applicable control." }, "passedCount": { "type": "integer", "description": "The count of all passed control." }, "pendingCount": { "type": "integer", "description": "The count of all pending for approval control." } }, "type": "object", "required": [ "failedCount", "manualCount", "notApplicableCount", "passedCount", "pendingCount" ] }, "azure-native:appcomplianceautomation:ReportComplianceStatusResponse": { "description": "A list which includes all the compliance result for one report.", "properties": { "m365": { "type": "object", "$ref": "#/types/azure-native:appcomplianceautomation:OverviewStatusResponse", "description": "The Microsoft 365 certification name." } }, "type": "object", "required": [ "m365" ] }, "azure-native:appcomplianceautomation:ResourceMetadata": { "description": "Single resource Id's metadata.", "properties": { "accountId": { "type": "string", "description": "Account Id. For example - the AWS account id." }, "resourceId": { "type": "string", "description": "Resource Id - e.g. \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1\"." }, "resourceKind": { "type": "string", "description": "Resource kind." }, "resourceOrigin": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appcomplianceautomation:ResourceOrigin" } ], "description": "Resource Origin." }, "resourceType": { "type": "string", "description": "Resource type. e.g. \"Microsoft.Compute/virtualMachines\"" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appcomplianceautomation:ResourceMetadataResponse": { "description": "Single resource Id's metadata.", "properties": { "accountId": { "type": "string", "description": "Account Id. For example - the AWS account id." }, "resourceId": { "type": "string", "description": "Resource Id - e.g. \"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1\"." }, "resourceKind": { "type": "string", "description": "Resource kind." }, "resourceOrigin": { "type": "string", "description": "Resource Origin." }, "resourceType": { "type": "string", "description": "Resource type. e.g. \"Microsoft.Compute/virtualMachines\"" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appcomplianceautomation:ResourceOrigin": { "description": "Resource Origin.", "type": "string", "enum": [ { "name": "Azure", "description": "The resource is from Azure.", "value": "Azure" }, { "name": "AWS", "description": "The resource is from AWS.", "value": "AWS" }, { "name": "GCP", "description": "The resource is from GCP.", "value": "GCP" } ] }, "azure-native:appcomplianceautomation:ScopingAnswer": { "description": "Scoping answer.", "properties": { "answers": { "type": "array", "items": { "type": "string" }, "description": "Question answer value list." }, "questionId": { "type": "string", "description": "Question id." } }, "type": "object", "required": [ "answers", "questionId" ] }, "azure-native:appcomplianceautomation:ScopingAnswerResponse": { "description": "Scoping answer.", "properties": { "answers": { "type": "array", "items": { "type": "string" }, "description": "Question answer value list." }, "questionId": { "type": "string", "description": "Question id." } }, "type": "object", "required": [ "answers", "questionId" ] }, "azure-native:appcomplianceautomation:ScopingQuestionResponse": { "description": "The definition of a scoping question.", "properties": { "inputType": { "type": "string", "description": "Input type of the question answer." }, "optionIds": { "type": "array", "items": { "type": "string" }, "description": "Option id list." }, "questionId": { "type": "string", "description": "Question id." }, "rules": { "type": "array", "items": { "type": "string" }, "description": "The rule of the question." }, "showSubQuestionsValue": { "type": "string", "description": "The answer value to show the sub questions." }, "superiorQuestionId": { "type": "string", "description": "Superior question id." } }, "type": "object", "required": [ "inputType", "optionIds", "questionId", "rules", "showSubQuestionsValue", "superiorQuestionId" ] }, "azure-native:appcomplianceautomation:SendAllEvents": { "description": "whether to send notification under any event.", "type": "string", "enum": [ { "name": "True", "description": "Need send notification under any event.", "value": "true" }, { "name": "False", "description": "No need to send notification under any event.", "value": "false" } ] }, "azure-native:appcomplianceautomation:StatusItemResponse": { "description": "Single status.", "properties": { "statusName": { "type": "string", "description": "Status name - e.g. \"Active\", \"Failed\"." }, "statusValue": { "type": "string", "description": "Status value. e.g. \"100\", or \"100%\"." } }, "type": "object" }, "azure-native:appcomplianceautomation:StorageInfo": { "description": "The information of 'bring your own storage' account binding to the report", "properties": { "accountName": { "type": "string", "description": "'bring your own storage' account name" }, "location": { "type": "string", "description": "The region of 'bring your own storage' account" }, "resourceGroup": { "type": "string", "description": "The resourceGroup which 'bring your own storage' account belongs to" }, "subscriptionId": { "type": "string", "description": "The subscription id which 'bring your own storage' account belongs to" } }, "type": "object" }, "azure-native:appcomplianceautomation:StorageInfoResponse": { "description": "The information of 'bring your own storage' account binding to the report", "properties": { "accountName": { "type": "string", "description": "'bring your own storage' account name" }, "location": { "type": "string", "description": "The region of 'bring your own storage' account" }, "resourceGroup": { "type": "string", "description": "The resourceGroup which 'bring your own storage' account belongs to" }, "subscriptionId": { "type": "string", "description": "The subscription id which 'bring your own storage' account belongs to" } }, "type": "object" }, "azure-native:appcomplianceautomation:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:appcomplianceautomation:UpdateWebhookKey": { "description": "whether to update webhookKey.", "type": "string", "enum": [ { "name": "True", "description": "Need update the webhook key.", "value": "true" }, { "name": "False", "description": "No need to update the webhook key.", "value": "false" } ] }, "azure-native:appcomplianceautomation:WebhookStatus": { "description": "Webhook status.", "type": "string", "enum": [ { "name": "Enabled", "description": "The webhook is enabled.", "value": "Enabled" }, { "name": "Disabled", "description": "The webhook is disabled.", "value": "Disabled" } ] }, "azure-native:appconfiguration:ApiKeyResponse": { "description": "An API key used for authenticating with a configuration store endpoint.", "properties": { "connectionString": { "type": "string", "description": "A connection string that can be used by supporting clients for authentication." }, "id": { "type": "string", "description": "The key ID." }, "lastModified": { "type": "string", "description": "The last time any of the key's properties were modified." }, "name": { "type": "string", "description": "A name for the key describing its usage." }, "readOnly": { "type": "boolean", "description": "Whether this key can only be used for read operations." }, "value": { "type": "string", "description": "The value of the key that is used for authentication purposes." } }, "type": "object", "required": [ "connectionString", "id", "lastModified", "name", "readOnly", "value" ] }, "azure-native:appconfiguration:AuthenticationMode": { "description": "The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources.", "type": "string", "enum": [ { "description": "The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled.", "value": "Local" }, { "description": "The pass-through authentication mode. User identity will be passed through from Azure Resource Manager (ARM), requiring user to have data plane action permissions (Available via App Configuration Data Owner/ App Configuration Data Reader).", "value": "Pass-through" } ] }, "azure-native:appconfiguration:ConnectionStatus": { "description": "The private link service connection status.", "type": "string", "enum": [ { "value": "Pending" }, { "value": "Approved" }, { "value": "Rejected" }, { "value": "Disconnected" } ] }, "azure-native:appconfiguration:CreateMode": { "description": "Indicates whether the configuration store need to be recovered.", "type": "string", "enum": [ { "value": "Recover" }, { "value": "Default" } ] }, "azure-native:appconfiguration:DataPlaneProxyProperties": { "description": "The data plane proxy settings for a configuration store.", "properties": { "authenticationMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appconfiguration:AuthenticationMode" } ], "description": "The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources." }, "privateLinkDelegation": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appconfiguration:PrivateLinkDelegation" } ], "description": "The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link." } }, "type": "object" }, "azure-native:appconfiguration:DataPlaneProxyPropertiesResponse": { "description": "The data plane proxy settings for a configuration store.", "properties": { "authenticationMode": { "type": "string", "description": "The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources." }, "privateLinkDelegation": { "type": "string", "description": "The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link." } }, "type": "object" }, "azure-native:appconfiguration:EncryptionProperties": { "description": "The encryption settings for a configuration store.", "properties": { "keyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:appconfiguration:KeyVaultProperties", "description": "Key vault properties." } }, "type": "object" }, "azure-native:appconfiguration:EncryptionPropertiesResponse": { "description": "The encryption settings for a configuration store.", "properties": { "keyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:appconfiguration:KeyVaultPropertiesResponse", "description": "Key vault properties." } }, "type": "object" }, "azure-native:appconfiguration:IdentityType": { "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned, UserAssigned" } ] }, "azure-native:appconfiguration:KeyVaultProperties": { "description": "Settings concerning key vault encryption for a configuration store.", "properties": { "identityClientId": { "type": "string", "description": "The client id of the identity which will be used to access key vault." }, "keyIdentifier": { "type": "string", "description": "The URI of the key vault key used to encrypt data." } }, "type": "object" }, "azure-native:appconfiguration:KeyVaultPropertiesResponse": { "description": "Settings concerning key vault encryption for a configuration store.", "properties": { "identityClientId": { "type": "string", "description": "The client id of the identity which will be used to access key vault." }, "keyIdentifier": { "type": "string", "description": "The URI of the key vault key used to encrypt data." } }, "type": "object" }, "azure-native:appconfiguration:PrivateEndpoint": { "description": "Private endpoint which a connection belongs to.", "properties": { "id": { "type": "string", "description": "The resource Id for private endpoint" } }, "type": "object" }, "azure-native:appconfiguration:PrivateEndpointConnectionReferenceResponse": { "description": "A reference to a related private endpoint connection.", "properties": { "id": { "type": "string", "description": "The resource ID." }, "name": { "type": "string", "description": "The name of the resource." }, "privateEndpoint": { "type": "object", "$ref": "#/types/azure-native:appconfiguration:PrivateEndpointResponse", "description": "The resource of private endpoint." }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:appconfiguration:PrivateLinkServiceConnectionStateResponse", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "type": "string", "description": "The provisioning status of the private endpoint connection." }, "type": { "type": "string", "description": "The type of the resource." } }, "type": "object", "required": [ "id", "name", "privateLinkServiceConnectionState", "provisioningState", "type" ] }, "azure-native:appconfiguration:PrivateEndpointResponse": { "description": "Private endpoint which a connection belongs to.", "properties": { "id": { "type": "string", "description": "The resource Id for private endpoint" } }, "type": "object" }, "azure-native:appconfiguration:PrivateLinkDelegation": { "description": "The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link.", "type": "string", "enum": [ { "description": "Azure Resource Manager (ARM) private endpoint is required if the resource requires private link.", "value": "Enabled" }, { "description": "Request is denied if the resource requires private link.", "value": "Disabled" } ] }, "azure-native:appconfiguration:PrivateLinkServiceConnectionState": { "description": "The state of a private link service connection.", "properties": { "description": { "type": "string", "description": "The private link service connection description." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appconfiguration:ConnectionStatus" } ], "description": "The private link service connection status." } }, "type": "object" }, "azure-native:appconfiguration:PrivateLinkServiceConnectionStateResponse": { "description": "The state of a private link service connection.", "properties": { "actionsRequired": { "type": "string", "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)" }, "description": { "type": "string", "description": "The private link service connection description." }, "status": { "type": "string", "description": "The private link service connection status." } }, "type": "object", "required": [ "actionsRequired" ] }, "azure-native:appconfiguration:PublicNetworkAccess": { "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:appconfiguration:ResourceIdentity": { "description": "An identity that can be associated with a resource.", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appconfiguration:IdentityType" } ], "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object" }, "azure-native:appconfiguration:ResourceIdentityResponse": { "description": "An identity that can be associated with a resource.", "properties": { "principalId": { "type": "string", "description": "The principal id of the identity. This property will only be provided for a system-assigned identity." }, "tenantId": { "type": "string", "description": "The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity." }, "type": { "type": "string", "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:appconfiguration:UserIdentityResponse" }, "description": "The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object", "required": [ "principalId", "tenantId" ] }, "azure-native:appconfiguration:Sku": { "description": "Describes a configuration store SKU.", "properties": { "name": { "type": "string", "description": "The SKU name of the configuration store." } }, "type": "object", "required": [ "name" ] }, "azure-native:appconfiguration:SkuResponse": { "description": "Describes a configuration store SKU.", "properties": { "name": { "type": "string", "description": "The SKU name of the configuration store." } }, "type": "object", "required": [ "name" ] }, "azure-native:appconfiguration:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:appconfiguration:UserIdentityResponse": { "description": "A resource identity that is managed by the user of the service.", "properties": { "clientId": { "type": "string", "description": "The client ID of the user-assigned identity." }, "principalId": { "type": "string", "description": "The principal ID of the user-assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:applicationinsights:ApplicationInsightsComponentAnalyticsItemProperties": { "description": "A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.", "properties": { "functionAlias": { "type": "string", "description": "A function alias, used when the type of the item is Function" } }, "type": "object" }, "azure-native:applicationinsights:ApplicationInsightsComponentAnalyticsItemPropertiesResponse": { "description": "A set of properties that can be defined in the context of a specific item type. Each type may have its own properties.", "properties": { "functionAlias": { "type": "string", "description": "A function alias, used when the type of the item is Function" } }, "type": "object" }, "azure-native:applicationinsights:ApplicationInsightsComponentDataVolumeCap": { "description": "An Application Insights component daily data volume cap", "properties": { "cap": { "type": "number", "description": "Daily data volume cap in GB." }, "stopSendNotificationWhenHitCap": { "type": "boolean", "description": "Do not send a notification email when the daily data volume cap is met." }, "stopSendNotificationWhenHitThreshold": { "type": "boolean", "description": "Reserved, not used for now." }, "warningThreshold": { "type": "integer", "description": "Reserved, not used for now." } }, "type": "object" }, "azure-native:applicationinsights:ApplicationInsightsComponentDataVolumeCapResponse": { "description": "An Application Insights component daily data volume cap", "properties": { "cap": { "type": "number", "description": "Daily data volume cap in GB." }, "maxHistoryCap": { "type": "number", "description": "Maximum daily data volume cap that the user can set for this component." }, "resetTime": { "type": "integer", "description": "Daily data volume cap UTC reset hour." }, "stopSendNotificationWhenHitCap": { "type": "boolean", "description": "Do not send a notification email when the daily data volume cap is met." }, "stopSendNotificationWhenHitThreshold": { "type": "boolean", "description": "Reserved, not used for now." }, "warningThreshold": { "type": "integer", "description": "Reserved, not used for now." } }, "type": "object", "required": [ "maxHistoryCap", "resetTime" ] }, "azure-native:applicationinsights:ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesResponse": { "description": "Properties that define a ProactiveDetection configuration.", "properties": { "customEmails": { "type": "array", "items": { "type": "string" }, "description": "Custom email addresses for this rule notifications" }, "enabled": { "type": "boolean", "description": "A flag that indicates whether this rule is enabled by the user" }, "lastUpdatedTime": { "type": "string", "description": "The last time this rule was updated" }, "name": { "type": "string", "description": "The rule name" }, "ruleDefinitions": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesResponseRuleDefinitions", "description": "Static definitions of the ProactiveDetection configuration rule (same values for all components)." }, "sendEmailsToSubscriptionOwners": { "type": "boolean", "description": "A flag that indicated whether notifications on this rule should be sent to subscription owners" } }, "type": "object", "required": [ "lastUpdatedTime", "name" ] }, "azure-native:applicationinsights:ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesResponseRuleDefinitions": { "description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).", "properties": { "description": { "type": "string", "description": "The rule description" }, "displayName": { "type": "string", "description": "The rule name as it is displayed in UI" }, "helpUrl": { "type": "string", "description": "URL which displays additional info about the proactive detection rule" }, "isEnabledByDefault": { "type": "boolean", "description": "A flag indicating whether the rule is enabled by default" }, "isHidden": { "type": "boolean", "description": "A flag indicating whether the rule is hidden (from the UI)" }, "isInPreview": { "type": "boolean", "description": "A flag indicating whether the rule is in preview" }, "name": { "type": "string", "description": "The rule name" }, "supportsEmailNotifications": { "type": "boolean", "description": "A flag indicating whether email notifications are supported for detections for this rule" } }, "type": "object" }, "azure-native:applicationinsights:ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions": { "description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).", "properties": { "description": { "type": "string", "description": "The rule description" }, "displayName": { "type": "string", "description": "The rule name as it is displayed in UI" }, "helpUrl": { "type": "string", "description": "URL which displays additional info about the proactive detection rule" }, "isEnabledByDefault": { "type": "boolean", "description": "A flag indicating whether the rule is enabled by default" }, "isHidden": { "type": "boolean", "description": "A flag indicating whether the rule is hidden (from the UI)" }, "isInPreview": { "type": "boolean", "description": "A flag indicating whether the rule is in preview" }, "name": { "type": "string", "description": "The rule name" }, "supportsEmailNotifications": { "type": "boolean", "description": "A flag indicating whether email notifications are supported for detections for this rule" } }, "type": "object" }, "azure-native:applicationinsights:ApplicationType": { "description": "Type of application being monitored.", "type": "string", "enum": [ { "name": "web", "description": "web", "value": "web" }, { "name": "other", "description": "other", "value": "other" } ] }, "azure-native:applicationinsights:FavoriteType": { "description": "Enum indicating if this favorite definition is owned by a specific user or is shared between all users with access to the Application Insights component.", "type": "string", "enum": [ { "name": "shared", "description": "shared", "value": "shared" }, { "name": "user", "description": "user", "value": "user" } ] }, "azure-native:applicationinsights:FlowType": { "description": "Used by the Application Insights system to determine what kind of flow this component was created by. This is to be set to 'Bluefield' when creating/updating a component via the REST API.", "type": "string", "enum": [ { "name": "Bluefield", "description": "Bluefield", "value": "Bluefield" } ] }, "azure-native:applicationinsights:HeaderField": { "description": "A header to add to the WebTest.", "properties": { "headerFieldName": { "type": "string", "description": "The name of the header." }, "headerFieldValue": { "type": "string", "description": "The value of the header." } }, "type": "object" }, "azure-native:applicationinsights:HeaderFieldResponse": { "description": "A header to add to the WebTest.", "properties": { "headerFieldName": { "type": "string", "description": "The name of the header." }, "headerFieldValue": { "type": "string", "description": "The value of the header." } }, "type": "object" }, "azure-native:applicationinsights:IngestionMode": { "description": "Indicates the flow of the ingestion.", "type": "string", "enum": [ { "name": "ApplicationInsights", "description": "ApplicationInsights", "value": "ApplicationInsights" }, { "name": "ApplicationInsightsWithDiagnosticSettings", "description": "ApplicationInsightsWithDiagnosticSettings", "value": "ApplicationInsightsWithDiagnosticSettings" }, { "name": "LogAnalytics", "description": "LogAnalytics", "value": "LogAnalytics" } ] }, "azure-native:applicationinsights:ItemScope": { "description": "Enum indicating if this item definition is owned by a specific user or is shared between all users with access to the Application Insights component.", "type": "string", "enum": [ { "name": "shared", "description": "shared", "value": "shared" }, { "name": "user", "description": "user", "value": "user" } ] }, "azure-native:applicationinsights:ItemType": { "description": "Enum indicating the type of the Analytics item.", "type": "string", "enum": [ { "name": "none", "description": "none", "value": "none" }, { "name": "query", "description": "query", "value": "query" }, { "name": "recent", "description": "recent", "value": "recent" }, { "name": "function", "description": "function", "value": "function" } ] }, "azure-native:applicationinsights:Kind": { "description": "The kind of workbook. Choices are user and shared.", "type": "string", "enum": [ { "value": "user" }, { "value": "shared" } ] }, "azure-native:applicationinsights:ManagedServiceIdentityType": { "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned,UserAssigned" } ] }, "azure-native:applicationinsights:MyWorkbookManagedIdentity": { "description": "Customer Managed Identity", "properties": { "type": { "type": "string", "description": "The identity type." } }, "type": "object" }, "azure-native:applicationinsights:MyWorkbookManagedIdentityResponse": { "description": "Customer Managed Identity", "properties": { "type": { "type": "string", "description": "The identity type." }, "userAssignedIdentities": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:MyWorkbookUserAssignedIdentitiesResponse", "description": "Customer Managed Identity" } }, "type": "object" }, "azure-native:applicationinsights:MyWorkbookUserAssignedIdentitiesResponse": { "description": "Customer Managed Identity", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity." }, "tenantId": { "type": "string", "description": "The tenant ID of resource." } }, "type": "object", "required": [ "principalId", "tenantId" ] }, "azure-native:applicationinsights:PrivateLinkScopedResourceResponse": { "description": "The private link scope resource reference.", "properties": { "resourceId": { "type": "string", "description": "The full resource Id of the private link scope resource." }, "scopeId": { "type": "string", "description": "The private link scope unique Identifier." } }, "type": "object" }, "azure-native:applicationinsights:PublicNetworkAccessType": { "description": "The network access type for accessing Application Insights query.", "type": "string", "enum": [ { "name": "Enabled", "description": "Enables connectivity to Application Insights through public DNS.", "value": "Enabled" }, { "name": "Disabled", "description": "Disables public connectivity to Application Insights through public DNS.", "value": "Disabled" } ] }, "azure-native:applicationinsights:RequestSource": { "description": "Describes what tool created this Application Insights component. Customers using this API should set this to the default 'rest'.", "type": "string", "enum": [ { "name": "rest", "description": "rest", "value": "rest" } ] }, "azure-native:applicationinsights:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:applicationinsights:UserAssignedIdentityResponse": { "description": "User assigned identity properties", "properties": { "clientId": { "type": "string", "description": "The client ID of the assigned identity." }, "principalId": { "type": "string", "description": "The principal ID of the assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:applicationinsights:WebTestGeolocation": { "description": "Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.", "properties": { "location": { "type": "string", "description": "Location ID for the WebTest to run from." } }, "type": "object" }, "azure-native:applicationinsights:WebTestGeolocationResponse": { "description": "Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from.", "properties": { "location": { "type": "string", "description": "Location ID for the WebTest to run from." } }, "type": "object" }, "azure-native:applicationinsights:WebTestKind": { "description": "The kind of web test this is, valid choices are ping, multistep and standard.", "type": "string", "enum": [ { "name": "ping", "description": "ping", "value": "ping" }, { "name": "multistep", "description": "multistep", "value": "multistep" }, { "name": "standard", "description": "standard", "value": "standard" } ] }, "azure-native:applicationinsights:WebTestPropertiesConfiguration": { "description": "An XML configuration specification for a WebTest.", "properties": { "webTest": { "type": "string", "description": "The XML specification of a WebTest to run against an application." } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesConfigurationResponse": { "description": "An XML configuration specification for a WebTest.", "properties": { "webTest": { "type": "string", "description": "The XML specification of a WebTest to run against an application." } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesRequest": { "description": "The collection of request properties", "properties": { "followRedirects": { "type": "boolean", "description": "Follow redirects for this web test." }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:HeaderField" }, "description": "List of headers and their values to add to the WebTest call." }, "httpVerb": { "type": "string", "description": "Http verb to use for this web test." }, "parseDependentRequests": { "type": "boolean", "description": "Parse Dependent request for this WebTest." }, "requestBody": { "type": "string", "description": "Base64 encoded string body to send with this web test." }, "requestUrl": { "type": "string", "description": "Url location to test." } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesRequestResponse": { "description": "The collection of request properties", "properties": { "followRedirects": { "type": "boolean", "description": "Follow redirects for this web test." }, "headers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:HeaderFieldResponse" }, "description": "List of headers and their values to add to the WebTest call." }, "httpVerb": { "type": "string", "description": "Http verb to use for this web test." }, "parseDependentRequests": { "type": "boolean", "description": "Parse Dependent request for this WebTest." }, "requestBody": { "type": "string", "description": "Base64 encoded string body to send with this web test." }, "requestUrl": { "type": "string", "description": "Url location to test." } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesValidationRules": { "description": "The collection of validation rule properties", "properties": { "contentValidation": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:WebTestPropertiesValidationRulesContentValidation", "description": "The collection of content validation properties" }, "expectedHttpStatusCode": { "type": "integer", "description": "Validate that the WebTest returns the http status code provided." }, "ignoreHttpStatusCode": { "type": "boolean", "description": "When set, validation will ignore the status code." }, "sSLCertRemainingLifetimeCheck": { "type": "integer", "description": "A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true." }, "sSLCheck": { "type": "boolean", "description": "Checks to see if the SSL cert is still valid." } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesValidationRulesContentValidation": { "description": "The collection of content validation properties", "properties": { "contentMatch": { "type": "string", "description": "Content to look for in the return of the WebTest. Must not be null or empty." }, "ignoreCase": { "type": "boolean", "description": "When set, this value makes the ContentMatch validation case insensitive." }, "passIfTextFound": { "type": "boolean", "description": "When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match" } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesValidationRulesContentValidationResponse": { "description": "The collection of content validation properties", "properties": { "contentMatch": { "type": "string", "description": "Content to look for in the return of the WebTest. Must not be null or empty." }, "ignoreCase": { "type": "boolean", "description": "When set, this value makes the ContentMatch validation case insensitive." }, "passIfTextFound": { "type": "boolean", "description": "When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match" } }, "type": "object" }, "azure-native:applicationinsights:WebTestPropertiesValidationRulesResponse": { "description": "The collection of validation rule properties", "properties": { "contentValidation": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:WebTestPropertiesValidationRulesContentValidationResponse", "description": "The collection of content validation properties" }, "expectedHttpStatusCode": { "type": "integer", "description": "Validate that the WebTest returns the http status code provided." }, "ignoreHttpStatusCode": { "type": "boolean", "description": "When set, validation will ignore the status code." }, "sSLCertRemainingLifetimeCheck": { "type": "integer", "description": "A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true." }, "sSLCheck": { "type": "boolean", "description": "Checks to see if the SSL cert is still valid." } }, "type": "object" }, "azure-native:applicationinsights:WorkbookResourceIdentity": { "description": "Identity used for BYOS", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:applicationinsights:ManagedServiceIdentityType" } ], "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "type" ] }, "azure-native:applicationinsights:WorkbookResourceIdentityResponse": { "description": "Identity used for BYOS", "properties": { "principalId": { "type": "string", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "type": "string", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:UserAssignedIdentityResponse" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:applicationinsights:WorkbookSharedTypeKind": { "description": "The kind of workbook. Only valid value is shared.", "type": "string", "enum": [ { "name": "shared", "description": "shared", "value": "shared" } ] }, "azure-native:applicationinsights:WorkbookTemplateGallery": { "description": "Gallery information for a workbook template.", "properties": { "category": { "type": "string", "description": "Category for the gallery." }, "name": { "type": "string", "description": "Name of the workbook template in the gallery." }, "order": { "type": "integer", "description": "Order of the template within the gallery." }, "resourceType": { "type": "string", "description": "Azure resource type supported by the gallery." }, "type": { "type": "string", "description": "Type of workbook supported by the workbook template." } }, "type": "object" }, "azure-native:applicationinsights:WorkbookTemplateGalleryResponse": { "description": "Gallery information for a workbook template.", "properties": { "category": { "type": "string", "description": "Category for the gallery." }, "name": { "type": "string", "description": "Name of the workbook template in the gallery." }, "order": { "type": "integer", "description": "Order of the template within the gallery." }, "resourceType": { "type": "string", "description": "Azure resource type supported by the gallery." }, "type": { "type": "string", "description": "Type of workbook supported by the workbook template." } }, "type": "object" }, "azure-native:applicationinsights:WorkbookTemplateLocalizedGallery": { "description": "Localized template data and gallery information.", "properties": { "galleries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:WorkbookTemplateGallery" }, "description": "Workbook galleries supported by the template." }, "templateData": { "$ref": "pulumi.json#/Any", "description": "Valid JSON object containing workbook template payload." } }, "type": "object" }, "azure-native:applicationinsights:WorkbookTemplateLocalizedGalleryResponse": { "description": "Localized template data and gallery information.", "properties": { "galleries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:applicationinsights:WorkbookTemplateGalleryResponse" }, "description": "Workbook galleries supported by the template." }, "templateData": { "$ref": "pulumi.json#/Any", "description": "Valid JSON object containing workbook template payload." } }, "type": "object" }, "azure-native:applink:AppLinkMemberProperties": { "description": "AppLink Member properties", "properties": { "clusterType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:applink:ClusterType" } ], "description": "Cluster type" }, "connectivityProfile": { "type": "object", "$ref": "#/types/azure-native:applink:ConnectivityProfile", "description": "Connectivity profile." }, "metadata": { "type": "object", "$ref": "#/types/azure-native:applink:Metadata", "description": "AppLink Member Metadata" }, "upgradeProfile": { "type": "object", "$ref": "#/types/azure-native:applink:UpgradeProfile", "description": "Upgrade profile." } }, "type": "object", "required": [ "metadata" ] }, "azure-native:applink:AppLinkMemberPropertiesResponse": { "description": "AppLink Member properties", "properties": { "clusterType": { "type": "string", "description": "Cluster type" }, "connectivityProfile": { "type": "object", "$ref": "#/types/azure-native:applink:ConnectivityProfileResponse", "description": "Connectivity profile." }, "metadata": { "type": "object", "$ref": "#/types/azure-native:applink:MetadataResponse", "description": "AppLink Member Metadata" }, "observabilityProfile": { "type": "object", "$ref": "#/types/azure-native:applink:ObservabilityProfileResponse", "description": "Observability profile" }, "provisioningState": { "type": "string", "description": "Provisioning state" }, "upgradeProfile": { "type": "object", "$ref": "#/types/azure-native:applink:UpgradeProfileResponse", "description": "Upgrade profile." } }, "type": "object", "required": [ "metadata", "provisioningState" ] }, "azure-native:applink:AppLinkPropertiesResponse": { "description": "AppLink properties", "properties": { "provisioningState": { "type": "string", "description": "Provisioning state" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:applink:ClusterType": { "description": "Cluster type", "type": "string", "enum": [ { "name": "AKS", "description": "Azure Kubernetes Service", "value": "AKS" } ] }, "azure-native:applink:ConnectivityProfile": { "description": "AppLinkMember connectivity profile.", "properties": { "eastWestGateway": { "type": "object", "$ref": "#/types/azure-native:applink:EastWestGatewayProfile", "description": "East-West gateway profile." }, "privateConnect": { "type": "object", "$ref": "#/types/azure-native:applink:PrivateConnectProfile", "description": "Private connect profile." } }, "type": "object" }, "azure-native:applink:ConnectivityProfileResponse": { "description": "AppLinkMember connectivity profile.", "properties": { "eastWestGateway": { "type": "object", "$ref": "#/types/azure-native:applink:EastWestGatewayProfileResponse", "description": "East-West gateway profile." }, "privateConnect": { "type": "object", "$ref": "#/types/azure-native:applink:PrivateConnectProfileResponse", "description": "Private connect profile." } }, "type": "object" }, "azure-native:applink:EastWestGatewayProfile": { "description": "AppLinkMember east-west gateway profile.", "properties": { "visibility": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:applink:EastWestGatewayVisibility" } ], "description": "East-West gateway visibility." } }, "type": "object", "required": [ "visibility" ] }, "azure-native:applink:EastWestGatewayProfileResponse": { "description": "AppLinkMember east-west gateway profile.", "properties": { "visibility": { "type": "string", "description": "East-West gateway visibility." } }, "type": "object", "required": [ "visibility" ] }, "azure-native:applink:EastWestGatewayVisibility": { "description": "East-West gateway visibility.", "type": "string", "enum": [ { "name": "Internal", "description": "Use an internal load balancer for the east-west gateway.", "value": "Internal" }, { "name": "External", "description": "Use an external load balancer for the east-west gateway.", "value": "External" } ] }, "azure-native:applink:FullyManagedUpgradeProfile": { "description": "AppLinkMember fully managed upgrade profile", "properties": { "releaseChannel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:applink:UpgradeReleaseChannel" } ], "description": "Release channel" } }, "type": "object", "required": [ "releaseChannel" ] }, "azure-native:applink:FullyManagedUpgradeProfileResponse": { "description": "AppLinkMember fully managed upgrade profile", "properties": { "releaseChannel": { "type": "string", "description": "Release channel" } }, "type": "object", "required": [ "releaseChannel" ] }, "azure-native:applink:ManagedServiceIdentity": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:applink:ManagedServiceIdentityType" } ], "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "type" ] }, "azure-native:applink:ManagedServiceIdentityResponse": { "description": "Managed service identity (system assigned and/or user assigned identities)", "properties": { "principalId": { "type": "string", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "type": "string", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed)." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:applink:UserAssignedIdentityResponse" }, "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:applink:ManagedServiceIdentityType": { "description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned,UserAssigned" } ] }, "azure-native:applink:Metadata": { "description": "AppLinkMember metadata", "properties": { "resourceId": { "type": "string", "description": "Resource ID" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:applink:MetadataResponse": { "description": "AppLinkMember metadata", "properties": { "resourceId": { "type": "string", "description": "Resource ID" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:applink:MetricsProfileResponse": { "description": "AppLinkMember metrics profile", "properties": { "metricsEndpoint": { "type": "string", "description": "Metrics endpoint URL" } }, "type": "object", "required": [ "metricsEndpoint" ] }, "azure-native:applink:ObservabilityProfileResponse": { "description": "AppLinkMember observability profile", "properties": { "metrics": { "type": "object", "$ref": "#/types/azure-native:applink:MetricsProfileResponse", "description": "Metrics configuration" } }, "type": "object" }, "azure-native:applink:PrivateConnectProfile": { "description": "AppLinkMember private connect profile.", "properties": { "subnetResourceId": { "type": "string", "description": "Delegated Subnet to AppLink." } }, "type": "object", "required": [ "subnetResourceId" ] }, "azure-native:applink:PrivateConnectProfileResponse": { "description": "AppLinkMember private connect profile.", "properties": { "subnetResourceId": { "type": "string", "description": "Delegated Subnet to AppLink." } }, "type": "object", "required": [ "subnetResourceId" ] }, "azure-native:applink:SelfManagedUpgradeProfile": { "description": "AppLinkMember self managed upgrade profile", "properties": { "version": { "type": "string", "description": "Istio version" } }, "type": "object", "required": [ "version" ] }, "azure-native:applink:SelfManagedUpgradeProfileResponse": { "description": "AppLinkMember self managed upgrade profile", "properties": { "version": { "type": "string", "description": "Istio version" } }, "type": "object", "required": [ "version" ] }, "azure-native:applink:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:applink:UpgradeMode": { "description": "Upgrade mode.", "type": "string", "enum": [ { "name": "FullyManaged", "description": "Fully managed upgrade mode", "value": "FullyManaged" }, { "name": "SelfManaged", "description": "Self managed upgrade mode", "value": "SelfManaged" } ] }, "azure-native:applink:UpgradeProfile": { "description": "AppLinkMember upgrade profile.", "properties": { "fullyManagedUpgradeProfile": { "type": "object", "$ref": "#/types/azure-native:applink:FullyManagedUpgradeProfile", "description": "Fully managed upgrade profile." }, "mode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:applink:UpgradeMode" } ], "description": "Upgrade mode." }, "selfManagedUpgradeProfile": { "type": "object", "$ref": "#/types/azure-native:applink:SelfManagedUpgradeProfile", "description": "Self managed upgrade profile." } }, "type": "object", "required": [ "mode" ] }, "azure-native:applink:UpgradeProfileResponse": { "description": "AppLinkMember upgrade profile.", "properties": { "fullyManagedUpgradeProfile": { "type": "object", "$ref": "#/types/azure-native:applink:FullyManagedUpgradeProfileResponse", "description": "Fully managed upgrade profile." }, "mode": { "type": "string", "description": "Upgrade mode." }, "selfManagedUpgradeProfile": { "type": "object", "$ref": "#/types/azure-native:applink:SelfManagedUpgradeProfileResponse", "description": "Self managed upgrade profile." } }, "type": "object", "required": [ "mode" ] }, "azure-native:applink:UpgradeReleaseChannel": { "description": "Release channel", "type": "string", "enum": [ { "name": "Rapid", "description": "Rapid release channel", "value": "Rapid" }, { "name": "Stable", "description": "Stable release channel", "value": "Stable" } ] }, "azure-native:applink:UserAssignedIdentityResponse": { "description": "User assigned identity properties", "properties": { "clientId": { "type": "string", "description": "The client ID of the assigned identity." }, "principalId": { "type": "string", "description": "The principal ID of the assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:appplatform:AcceleratorBasicAuthSetting": { "description": "Auth setting for basic auth.", "properties": { "authType": { "type": "string", "description": "The type of the auth setting.\nExpected value is 'BasicAuth'.", "const": "BasicAuth" }, "caCertResourceId": { "type": "string", "description": "Resource Id of CA certificate for https URL of Git repository." }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "authType", "username" ] }, "azure-native:appplatform:AcceleratorBasicAuthSettingResponse": { "description": "Auth setting for basic auth.", "properties": { "authType": { "type": "string", "description": "The type of the auth setting.\nExpected value is 'BasicAuth'.", "const": "BasicAuth" }, "caCertResourceId": { "type": "string", "description": "Resource Id of CA certificate for https URL of Git repository." }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "authType", "username" ] }, "azure-native:appplatform:AcceleratorGitRepository": { "properties": { "authSetting": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorBasicAuthSetting" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorPublicSetting" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorSshSetting" } ], "discriminator": { "propertyName": "authType", "mapping": { "BasicAuth": "#/types/azure-native:appplatform:AcceleratorBasicAuthSetting", "Public": "#/types/azure-native:appplatform:AcceleratorPublicSetting", "SSH": "#/types/azure-native:appplatform:AcceleratorSshSetting" } }, "description": "Properties of the auth setting payload." }, "branch": { "type": "string", "description": "Git repository branch to be used." }, "commit": { "type": "string", "description": "Git repository commit to be used." }, "gitTag": { "type": "string", "description": "Git repository tag to be used." }, "intervalInSeconds": { "type": "integer", "description": "Interval for checking for updates to Git or image repository." }, "subPath": { "type": "string", "description": "Folder path inside the git repository to consider as the root of the accelerator or fragment." }, "url": { "type": "string", "description": "Git repository URL for the accelerator." } }, "type": "object", "required": [ "authSetting", "url" ] }, "azure-native:appplatform:AcceleratorGitRepositoryResponse": { "properties": { "authSetting": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorBasicAuthSettingResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorPublicSettingResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorSshSettingResponse" } ], "discriminator": { "propertyName": "authType", "mapping": { "BasicAuth": "#/types/azure-native:appplatform:AcceleratorBasicAuthSettingResponse", "Public": "#/types/azure-native:appplatform:AcceleratorPublicSettingResponse", "SSH": "#/types/azure-native:appplatform:AcceleratorSshSettingResponse" } }, "description": "Properties of the auth setting payload." }, "branch": { "type": "string", "description": "Git repository branch to be used." }, "commit": { "type": "string", "description": "Git repository commit to be used." }, "gitTag": { "type": "string", "description": "Git repository tag to be used." }, "intervalInSeconds": { "type": "integer", "description": "Interval for checking for updates to Git or image repository." }, "subPath": { "type": "string", "description": "Folder path inside the git repository to consider as the root of the accelerator or fragment." }, "url": { "type": "string", "description": "Git repository URL for the accelerator." } }, "type": "object", "required": [ "authSetting", "url" ] }, "azure-native:appplatform:AcceleratorPublicSetting": { "description": "Auth setting for public url.", "properties": { "authType": { "type": "string", "description": "The type of the auth setting.\nExpected value is 'Public'.", "const": "Public" }, "caCertResourceId": { "type": "string", "description": "Resource Id of CA certificate for https URL of Git repository." } }, "type": "object", "required": [ "authType" ] }, "azure-native:appplatform:AcceleratorPublicSettingResponse": { "description": "Auth setting for public url.", "properties": { "authType": { "type": "string", "description": "The type of the auth setting.\nExpected value is 'Public'.", "const": "Public" }, "caCertResourceId": { "type": "string", "description": "Resource Id of CA certificate for https URL of Git repository." } }, "type": "object", "required": [ "authType" ] }, "azure-native:appplatform:AcceleratorSshSetting": { "description": "Auth setting for SSH auth.", "properties": { "authType": { "type": "string", "description": "The type of the auth setting.\nExpected value is 'SSH'.", "const": "SSH" }, "hostKey": { "type": "string", "description": "Public SSH Key of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SSH Key algorithm of git repository." }, "privateKey": { "type": "string", "description": "Private SSH Key algorithm of git repository." } }, "type": "object", "required": [ "authType" ] }, "azure-native:appplatform:AcceleratorSshSettingResponse": { "description": "Auth setting for SSH auth.", "properties": { "authType": { "type": "string", "description": "The type of the auth setting.\nExpected value is 'SSH'.", "const": "SSH" } }, "type": "object", "required": [ "authType" ] }, "azure-native:appplatform:ApiPortalApiTryOutEnabledState": { "description": "Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.", "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:appplatform:ApiPortalCustomDomainProperties": { "description": "The properties of custom domain for API portal", "properties": { "thumbprint": { "type": "string", "description": "The thumbprint of bound certificate." } }, "type": "object" }, "azure-native:appplatform:ApiPortalCustomDomainPropertiesResponse": { "description": "The properties of custom domain for API portal", "properties": { "thumbprint": { "type": "string", "description": "The thumbprint of bound certificate." } }, "type": "object" }, "azure-native:appplatform:ApiPortalInstanceResponse": { "description": "Collection of instances belong to the API portal", "properties": { "name": { "type": "string", "description": "Name of the API portal instance" }, "status": { "type": "string", "description": "Status of the API portal instance" } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:ApiPortalProperties": { "description": "API portal properties payload", "properties": { "apiTryOutEnabledState": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:ApiPortalApiTryOutEnabledState" } ], "description": "Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.", "default": "Enabled" }, "gatewayIds": { "type": "array", "items": { "type": "string" }, "description": "The array of resource Ids of gateway to integrate with API portal." }, "httpsOnly": { "type": "boolean", "description": "Indicate if only https is allowed.", "default": false }, "public": { "type": "boolean", "description": "Indicates whether the API portal exposes endpoint.", "default": false }, "sourceUrls": { "type": "array", "items": { "type": "string" }, "description": "Collection of OpenAPI source URL locations." }, "ssoProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:SsoProperties", "description": "Single sign-on related configuration" } }, "type": "object" }, "azure-native:appplatform:ApiPortalPropertiesResponse": { "description": "API portal properties payload", "properties": { "apiTryOutEnabledState": { "type": "string", "description": "Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API.", "default": "Enabled" }, "gatewayIds": { "type": "array", "items": { "type": "string" }, "description": "The array of resource Ids of gateway to integrate with API portal." }, "httpsOnly": { "type": "boolean", "description": "Indicate if only https is allowed.", "default": false }, "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApiPortalInstanceResponse" }, "description": "Collection of instances belong to API portal." }, "provisioningState": { "type": "string", "description": "State of the API portal." }, "public": { "type": "boolean", "description": "Indicates whether the API portal exposes endpoint.", "default": false }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApiPortalResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." }, "sourceUrls": { "type": "array", "items": { "type": "string" }, "description": "Collection of OpenAPI source URL locations." }, "ssoProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:SsoPropertiesResponse", "description": "Single sign-on related configuration" }, "url": { "type": "string", "description": "URL of the API portal, exposed when 'public' is true." } }, "type": "object", "required": [ "instances", "provisioningState", "resourceRequests", "url" ] }, "azure-native:appplatform:ApiPortalResourceRequestsResponse": { "description": "Resource requests of the API portal", "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each API portal instance" }, "memory": { "type": "string", "description": "Memory allocated to each API portal instance" } }, "type": "object", "required": [ "cpu", "memory" ] }, "azure-native:appplatform:ApmProperties": { "description": "Properties of an APM", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive properties for the APM" }, "secrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Sensitive properties for the APM" }, "type": { "type": "string", "description": "APM Type" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:ApmPropertiesResponse": { "description": "Properties of an APM", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive properties for the APM" }, "provisioningState": { "type": "string", "description": "State of the APM." }, "type": { "type": "string", "description": "APM Type" } }, "type": "object", "required": [ "provisioningState", "type" ] }, "azure-native:appplatform:ApmReference": { "description": "A reference to the APM", "properties": { "resourceId": { "type": "string", "description": "Resource Id of the APM" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:ApmReferenceResponse": { "description": "A reference to the APM", "properties": { "resourceId": { "type": "string", "description": "Resource Id of the APM" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:ApmType": { "description": "Type of application performance monitoring", "type": "string", "enum": [ { "value": "ApplicationInsights" }, { "value": "AppDynamics" }, { "value": "Dynatrace" }, { "value": "NewRelic" }, { "value": "ElasticAPM" } ] }, "azure-native:appplatform:AppResourceProperties": { "description": "App resource properties payload", "properties": { "addonConfigs": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "Collection of addons" }, "customPersistentDisks": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomPersistentDiskResource" }, "description": "List of custom persistent disks" }, "enableEndToEndTLS": { "type": "boolean", "description": "Indicate if end to end TLS is enabled.", "default": false }, "httpsOnly": { "type": "boolean", "description": "Indicate if only https is allowed.", "default": false }, "ingressSettings": { "type": "object", "$ref": "#/types/azure-native:appplatform:IngressSettings", "description": "App ingress settings payload." }, "loadedCertificates": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:LoadedCertificate" }, "description": "Collection of loaded certificates" }, "persistentDisk": { "type": "object", "$ref": "#/types/azure-native:appplatform:PersistentDisk", "description": "Persistent disk settings" }, "public": { "type": "boolean", "description": "Indicates whether the App exposes public endpoint" }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:Secret" }, "description": "Collection of auth secrets" }, "temporaryDisk": { "type": "object", "$ref": "#/types/azure-native:appplatform:TemporaryDisk", "description": "Temporary disk settings" }, "testEndpointAuthState": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:TestEndpointAuthState" } ], "description": "State of test endpoint auth.", "default": "Enabled" }, "vnetAddons": { "type": "object", "$ref": "#/types/azure-native:appplatform:AppVNetAddons", "description": "Additional App settings in vnet injection instance" }, "workloadProfileName": { "type": "string", "description": "The workload profile used for this app. Supported for Consumption + Dedicated plan." } }, "type": "object" }, "azure-native:appplatform:AppResourcePropertiesResponse": { "description": "App resource properties payload", "properties": { "addonConfigs": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "Collection of addons" }, "customPersistentDisks": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomPersistentDiskResourceResponse" }, "description": "List of custom persistent disks" }, "enableEndToEndTLS": { "type": "boolean", "description": "Indicate if end to end TLS is enabled.", "default": false }, "fqdn": { "type": "string", "description": "Fully qualified dns Name." }, "httpsOnly": { "type": "boolean", "description": "Indicate if only https is allowed.", "default": false }, "ingressSettings": { "type": "object", "$ref": "#/types/azure-native:appplatform:IngressSettingsResponse", "description": "App ingress settings payload." }, "loadedCertificates": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:LoadedCertificateResponse" }, "description": "Collection of loaded certificates" }, "persistentDisk": { "type": "object", "$ref": "#/types/azure-native:appplatform:PersistentDiskResponse", "description": "Persistent disk settings" }, "provisioningState": { "type": "string", "description": "Provisioning state of the App" }, "public": { "type": "boolean", "description": "Indicates whether the App exposes public endpoint" }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:SecretResponse" }, "description": "Collection of auth secrets" }, "temporaryDisk": { "type": "object", "$ref": "#/types/azure-native:appplatform:TemporaryDiskResponse", "description": "Temporary disk settings" }, "testEndpointAuthState": { "type": "string", "description": "State of test endpoint auth.", "default": "Enabled" }, "url": { "type": "string", "description": "URL of the App" }, "vnetAddons": { "type": "object", "$ref": "#/types/azure-native:appplatform:AppVNetAddonsResponse", "description": "Additional App settings in vnet injection instance" }, "workloadProfileName": { "type": "string", "description": "The workload profile used for this app. Supported for Consumption + Dedicated plan." } }, "type": "object", "required": [ "fqdn", "provisioningState", "url" ] }, "azure-native:appplatform:AppVNetAddons": { "description": "Additional App settings in vnet injection instance", "properties": { "publicEndpoint": { "type": "boolean", "description": "Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.", "default": false } }, "type": "object" }, "azure-native:appplatform:AppVNetAddonsResponse": { "description": "Additional App settings in vnet injection instance", "properties": { "publicEndpoint": { "type": "boolean", "description": "Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet.", "default": false }, "publicEndpointUrl": { "type": "string", "description": "URL of the App in vnet injection instance which could be accessed from internet" } }, "type": "object", "required": [ "publicEndpointUrl" ] }, "azure-native:appplatform:ApplicationAcceleratorComponentResponse": { "properties": { "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationAcceleratorInstanceResponse" } }, "name": { "type": "string" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationAcceleratorResourceRequestsResponse" } }, "type": "object", "required": [ "instances", "name" ] }, "azure-native:appplatform:ApplicationAcceleratorInstanceResponse": { "properties": { "name": { "type": "string", "description": "Name of the Application Accelerator instance." }, "status": { "type": "string", "description": "Status of the Application Accelerator instance. It can be Pending, Running, Succeeded, Failed, Unknown." } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:ApplicationAcceleratorPropertiesResponse": { "description": "Application accelerator properties payload", "properties": { "components": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationAcceleratorComponentResponse" }, "description": "Collection of components belong to application accelerator." }, "provisioningState": { "type": "string", "description": "State of the application accelerator." } }, "type": "object", "required": [ "components", "provisioningState" ] }, "azure-native:appplatform:ApplicationAcceleratorResourceRequestsResponse": { "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each application accelerator component. 1 core can be represented by 1 or 1000m" }, "instanceCount": { "type": "integer", "description": "Instance count of the application accelerator component." }, "memory": { "type": "string", "description": "Memory allocated to each application accelerator component. 1 GB can be represented by 1Gi or 1024Mi." } }, "type": "object", "required": [ "cpu", "instanceCount", "memory" ] }, "azure-native:appplatform:ApplicationInsightsAgentVersionsResponse": { "description": "Application Insights agent versions properties payload", "properties": { "java": { "type": "string", "description": "Indicates the version of application insight java agent" } }, "type": "object", "required": [ "java" ] }, "azure-native:appplatform:ApplicationLiveViewComponentResponse": { "description": "Application Live View properties payload", "properties": { "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationLiveViewInstanceResponse" }, "description": "Collection of instances belong to Application Live View." }, "name": { "$ref": "pulumi.json#/Any", "description": "Name of the component." }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationLiveViewResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." } }, "type": "object", "required": [ "instances", "name", "resourceRequests" ] }, "azure-native:appplatform:ApplicationLiveViewInstanceResponse": { "description": "Collection of instances belong to the Application Live View", "properties": { "name": { "type": "string", "description": "Name of the Application Live View instance." }, "status": { "type": "string", "description": "Status of the Application Live View instance. It can be Pending, Running, Succeeded, Failed, Unknown." } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:ApplicationLiveViewPropertiesResponse": { "description": "Application Live View properties payload", "properties": { "components": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationLiveViewComponentResponse" }, "description": "Component details of Application Live View" }, "provisioningState": { "type": "string", "description": "State of the Application Live View." } }, "type": "object", "required": [ "components", "provisioningState" ] }, "azure-native:appplatform:ApplicationLiveViewResourceRequestsResponse": { "description": "The resource quantity for required CPU and Memory of Application Live View component", "properties": { "cpu": { "type": "string", "description": "Cpu quantity allocated to each Application Live View component instance. 1 core can be represented by 1 or 1000m." }, "instanceCount": { "type": "integer", "description": "Desired instance count of Application Live View component instance." }, "memory": { "type": "string", "description": "Memory quantity allocated to each Application Live View component instance. 1 GB can be represented by 1Gi or 1024Mi." } }, "type": "object", "required": [ "cpu", "instanceCount", "memory" ] }, "azure-native:appplatform:AzureFileVolume": { "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", "properties": { "enableSubPath": { "type": "boolean", "description": "If set to true, it will create and mount a dedicated directory for every individual app instance.", "default": false }, "mountOptions": { "type": "array", "items": { "type": "string" }, "description": "These are the mount options for a persistent disk." }, "mountPath": { "type": "string", "description": "The mount path of the persistent disk." }, "readOnly": { "type": "boolean", "description": "Indicates whether the persistent disk is a readOnly one." }, "shareName": { "type": "string", "description": "The share name of the Azure File share." }, "type": { "type": "string", "description": "The type of the underlying resource to mount as a persistent disk.\nExpected value is 'AzureFileVolume'.", "const": "AzureFileVolume" } }, "type": "object", "required": [ "mountPath", "type" ] }, "azure-native:appplatform:AzureFileVolumeResponse": { "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", "properties": { "enableSubPath": { "type": "boolean", "description": "If set to true, it will create and mount a dedicated directory for every individual app instance.", "default": false }, "mountOptions": { "type": "array", "items": { "type": "string" }, "description": "These are the mount options for a persistent disk." }, "mountPath": { "type": "string", "description": "The mount path of the persistent disk." }, "readOnly": { "type": "boolean", "description": "Indicates whether the persistent disk is a readOnly one." }, "shareName": { "type": "string", "description": "The share name of the Azure File share." }, "type": { "type": "string", "description": "The type of the underlying resource to mount as a persistent disk.\nExpected value is 'AzureFileVolume'.", "const": "AzureFileVolume" } }, "type": "object", "required": [ "mountPath", "type" ] }, "azure-native:appplatform:BackendProtocol": { "description": "How ingress should communicate with this app backend service.", "type": "string", "enum": [ { "value": "GRPC" }, { "value": "Default" } ] }, "azure-native:appplatform:BindingResourceProperties": { "description": "Binding resource properties payload", "properties": { "bindingParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Binding parameters of the Binding resource" }, "key": { "type": "string", "description": "The key of the bound resource" }, "resourceId": { "type": "string", "description": "The Azure resource id of the bound resource" } }, "type": "object" }, "azure-native:appplatform:BindingResourcePropertiesResponse": { "description": "Binding resource properties payload", "properties": { "bindingParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Binding parameters of the Binding resource" }, "createdAt": { "type": "string", "description": "Creation time of the Binding resource" }, "generatedProperties": { "type": "string", "description": "The generated Spring Boot property file for this binding. The secret will be deducted." }, "key": { "type": "string", "description": "The key of the bound resource" }, "resourceId": { "type": "string", "description": "The Azure resource id of the bound resource" }, "resourceName": { "type": "string", "description": "The name of the bound resource" }, "resourceType": { "type": "string", "description": "The standard Azure resource type of the bound resource" }, "updatedAt": { "type": "string", "description": "Update time of the Binding resource" } }, "type": "object", "required": [ "createdAt", "generatedProperties", "resourceName", "resourceType", "updatedAt" ] }, "azure-native:appplatform:BindingType": { "description": "Buildpack Binding Type", "type": "string", "enum": [ { "value": "ApplicationInsights" }, { "value": "ApacheSkyWalking" }, { "value": "AppDynamics" }, { "value": "Dynatrace" }, { "value": "NewRelic" }, { "value": "ElasticAPM" }, { "value": "CACertificates" } ] }, "azure-native:appplatform:BuildProperties": { "description": "Build resource properties payload", "properties": { "agentPool": { "type": "string", "description": "The resource id of agent pool" }, "apms": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApmReference" }, "description": "The APMs for this build" }, "builder": { "type": "string", "description": "The resource id of builder to build the source code" }, "certificates": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:CertificateReference" }, "description": "The CA Certificates for this build" }, "env": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The environment variables for this build" }, "relativePath": { "type": "string", "description": "The relative path of source code" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildResourceRequests", "description": "The customized build resource for this build" } }, "type": "object" }, "azure-native:appplatform:BuildPropertiesResponse": { "description": "Build resource properties payload", "properties": { "agentPool": { "type": "string", "description": "The resource id of agent pool" }, "apms": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApmReferenceResponse" }, "description": "The APMs for this build" }, "builder": { "type": "string", "description": "The resource id of builder to build the source code" }, "certificates": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:CertificateReferenceResponse" }, "description": "The CA Certificates for this build" }, "env": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The environment variables for this build" }, "provisioningState": { "type": "string", "description": "Provisioning state of the KPack build result" }, "relativePath": { "type": "string", "description": "The relative path of source code" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildResourceRequestsResponse", "description": "The customized build resource for this build" }, "triggeredBuildResult": { "type": "object", "$ref": "#/types/azure-native:appplatform:TriggeredBuildResultResponse", "description": " The build result triggered by this build" } }, "type": "object", "required": [ "provisioningState", "triggeredBuildResult" ] }, "azure-native:appplatform:BuildResourceRequests": { "description": "Resource request payload of Build Resource.", "properties": { "cpu": { "type": "string", "description": "Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. \r\nThe default value is 1, this should not exceed build service agent pool cpu size.", "default": "1" }, "memory": { "type": "string", "description": "Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. \r\nThe default value is 2Gi, this should not exceed build service agent pool memory size.", "default": "2Gi" } }, "type": "object" }, "azure-native:appplatform:BuildResourceRequestsResponse": { "description": "Resource request payload of Build Resource.", "properties": { "cpu": { "type": "string", "description": "Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. \r\nThe default value is 1, this should not exceed build service agent pool cpu size.", "default": "1" }, "memory": { "type": "string", "description": "Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. \r\nThe default value is 2Gi, this should not exceed build service agent pool memory size.", "default": "2Gi" } }, "type": "object" }, "azure-native:appplatform:BuildResultUserSourceInfo": { "description": "Reference to a build result", "properties": { "buildResultId": { "type": "string", "description": "Resource id of an existing succeeded build result under the same Spring instance." }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'BuildResult'.", "const": "BuildResult" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:BuildResultUserSourceInfoResponse": { "description": "Reference to a build result", "properties": { "buildResultId": { "type": "string", "description": "Resource id of an existing succeeded build result under the same Spring instance." }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'BuildResult'.", "const": "BuildResult" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:BuildServiceAgentPoolProperties": { "description": "Build service agent pool properties", "properties": { "poolSize": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildServiceAgentPoolSizeProperties", "description": "build service agent pool size properties" } }, "type": "object" }, "azure-native:appplatform:BuildServiceAgentPoolPropertiesResponse": { "description": "Build service agent pool properties", "properties": { "poolSize": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildServiceAgentPoolSizePropertiesResponse", "description": "build service agent pool size properties" }, "provisioningState": { "type": "string", "description": "Provisioning state of the build service agent pool" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:BuildServiceAgentPoolSizeProperties": { "description": "Build service agent pool size properties", "properties": { "name": { "type": "string", "description": "The name of build service agent pool size" } }, "type": "object" }, "azure-native:appplatform:BuildServiceAgentPoolSizePropertiesResponse": { "description": "Build service agent pool size properties", "properties": { "cpu": { "type": "string", "description": "The cpu property of build service agent pool size" }, "memory": { "type": "string", "description": "The memory property of build service agent pool size" }, "name": { "type": "string", "description": "The name of build service agent pool size" } }, "type": "object", "required": [ "cpu", "memory" ] }, "azure-native:appplatform:BuilderProperties": { "description": "KPack Builder properties payload", "properties": { "buildpackGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildpacksGroupProperties" }, "description": "Builder buildpack groups." }, "stack": { "type": "object", "$ref": "#/types/azure-native:appplatform:StackProperties", "description": "Builder cluster stack property." } }, "type": "object" }, "azure-native:appplatform:BuilderPropertiesResponse": { "description": "KPack Builder properties payload", "properties": { "buildpackGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildpacksGroupPropertiesResponse" }, "description": "Builder buildpack groups." }, "provisioningState": { "type": "string", "description": "Builder provision status." }, "stack": { "type": "object", "$ref": "#/types/azure-native:appplatform:StackPropertiesResponse", "description": "Builder cluster stack property." } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:BuildpackBindingLaunchProperties": { "description": "Buildpack Binding Launch Properties", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive properties for launchProperties" }, "secrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Sensitive properties for launchProperties" } }, "type": "object" }, "azure-native:appplatform:BuildpackBindingLaunchPropertiesResponse": { "description": "Buildpack Binding Launch Properties", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive properties for launchProperties" }, "secrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Sensitive properties for launchProperties" } }, "type": "object" }, "azure-native:appplatform:BuildpackBindingProperties": { "description": "Properties of a buildpack binding", "properties": { "bindingType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:BindingType" } ], "description": "Buildpack Binding Type" }, "launchProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildpackBindingLaunchProperties", "description": "The object describes the buildpack binding launch properties" } }, "type": "object" }, "azure-native:appplatform:BuildpackBindingPropertiesResponse": { "description": "Properties of a buildpack binding", "properties": { "bindingType": { "type": "string", "description": "Buildpack Binding Type" }, "launchProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildpackBindingLaunchPropertiesResponse", "description": "The object describes the buildpack binding launch properties" }, "provisioningState": { "type": "string", "description": "State of the Buildpack Binding." } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:BuildpackProperties": { "description": "Buildpack properties payload", "properties": { "id": { "type": "string", "description": "Id of the buildpack" } }, "type": "object" }, "azure-native:appplatform:BuildpackPropertiesResponse": { "description": "Buildpack properties payload", "properties": { "id": { "type": "string", "description": "Id of the buildpack" }, "version": { "type": "string", "description": "Version of the buildpack" } }, "type": "object", "required": [ "version" ] }, "azure-native:appplatform:BuildpacksGroupProperties": { "description": "Buildpack group properties of the Builder", "properties": { "buildpacks": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildpackProperties" }, "description": "Buildpacks in the buildpack group" }, "name": { "type": "string", "description": "Buildpack group name" } }, "type": "object" }, "azure-native:appplatform:BuildpacksGroupPropertiesResponse": { "description": "Buildpack group properties of the Builder", "properties": { "buildpacks": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildpackPropertiesResponse" }, "description": "Buildpacks in the buildpack group" }, "name": { "type": "string", "description": "Buildpack group name" } }, "type": "object" }, "azure-native:appplatform:CertificateReference": { "description": "A reference to the certificate", "properties": { "resourceId": { "type": "string", "description": "Resource Id of the certificate" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:CertificateReferenceResponse": { "description": "A reference to the certificate", "properties": { "resourceId": { "type": "string", "description": "Resource Id of the certificate" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:ClusterResourceProperties": { "description": "Service properties payload", "properties": { "infraResourceGroup": { "type": "string", "description": "The name of the resource group that contains the infrastructure resources" }, "maintenanceScheduleConfiguration": { "type": "object", "$ref": "#/types/azure-native:appplatform:WeeklyMaintenanceScheduleConfiguration", "description": "Additional Service settings for planned maintenance" }, "managedEnvironmentId": { "type": "string", "description": "The resource Id of the Managed Environment that the Spring Apps instance builds on" }, "marketplaceResource": { "type": "object", "$ref": "#/types/azure-native:appplatform:MarketplaceResource", "description": "Purchasing 3rd party product of the Service resource." }, "networkProfile": { "type": "object", "$ref": "#/types/azure-native:appplatform:NetworkProfile", "description": "Network profile of the Service" }, "vnetAddons": { "type": "object", "$ref": "#/types/azure-native:appplatform:ServiceVNetAddons", "description": "Additional Service settings in vnet injection instance" }, "zoneRedundant": { "type": "boolean", "default": false } }, "type": "object" }, "azure-native:appplatform:ClusterResourcePropertiesResponse": { "description": "Service properties payload", "properties": { "fqdn": { "type": "string", "description": "Fully qualified dns name of the service instance" }, "infraResourceGroup": { "type": "string", "description": "The name of the resource group that contains the infrastructure resources" }, "maintenanceScheduleConfiguration": { "type": "object", "$ref": "#/types/azure-native:appplatform:WeeklyMaintenanceScheduleConfigurationResponse", "description": "Additional Service settings for planned maintenance" }, "managedEnvironmentId": { "type": "string", "description": "The resource Id of the Managed Environment that the Spring Apps instance builds on" }, "marketplaceResource": { "type": "object", "$ref": "#/types/azure-native:appplatform:MarketplaceResourceResponse", "description": "Purchasing 3rd party product of the Service resource." }, "networkProfile": { "type": "object", "$ref": "#/types/azure-native:appplatform:NetworkProfileResponse", "description": "Network profile of the Service" }, "powerState": { "type": "string", "description": "Power state of the Service" }, "provisioningState": { "type": "string", "description": "Provisioning state of the Service" }, "serviceId": { "type": "string", "description": "ServiceInstanceEntity Id which uniquely identifies a created resource" }, "version": { "type": "integer", "description": "Version of the Service" }, "vnetAddons": { "type": "object", "$ref": "#/types/azure-native:appplatform:ServiceVNetAddonsResponse", "description": "Additional Service settings in vnet injection instance" }, "zoneRedundant": { "type": "boolean", "default": false } }, "type": "object", "required": [ "fqdn", "powerState", "provisioningState", "serviceId", "version" ] }, "azure-native:appplatform:ConfigServerEnabledState": { "description": "Enabled state of the config server. This is only used in Consumption tier.", "type": "string", "enum": [ { "description": "Enable the config server.", "value": "Enabled" }, { "description": "Disable the config server.", "value": "Disabled" } ] }, "azure-native:appplatform:ConfigServerGitProperty": { "description": "Property of git.", "properties": { "hostKey": { "type": "string", "description": "Public sshKey of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SshKey algorithm of git repository." }, "label": { "type": "string", "description": "Label of the repository" }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "privateKey": { "type": "string", "description": "Private sshKey algorithm of git repository." }, "repositories": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:GitPatternRepository" }, "description": "Repositories of git." }, "searchPaths": { "type": "array", "items": { "type": "string" }, "description": "Searching path of the repository" }, "strictHostKeyChecking": { "type": "boolean", "description": "Strict host key checking or not." }, "uri": { "type": "string", "description": "URI of the repository" }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "uri" ] }, "azure-native:appplatform:ConfigServerGitPropertyResponse": { "description": "Property of git.", "properties": { "hostKey": { "type": "string", "description": "Public sshKey of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SshKey algorithm of git repository." }, "label": { "type": "string", "description": "Label of the repository" }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "privateKey": { "type": "string", "description": "Private sshKey algorithm of git repository." }, "repositories": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:GitPatternRepositoryResponse" }, "description": "Repositories of git." }, "searchPaths": { "type": "array", "items": { "type": "string" }, "description": "Searching path of the repository" }, "strictHostKeyChecking": { "type": "boolean", "description": "Strict host key checking or not." }, "uri": { "type": "string", "description": "URI of the repository" }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "uri" ] }, "azure-native:appplatform:ConfigServerProperties": { "description": "Config server git properties payload", "properties": { "configServer": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigServerSettings", "description": "Settings of config server." }, "enabledState": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:ConfigServerEnabledState" } ], "description": "Enabled state of the config server. This is only used in Consumption tier." }, "error": { "type": "object", "$ref": "#/types/azure-native:appplatform:Error", "description": "Error when apply config server settings." } }, "type": "object" }, "azure-native:appplatform:ConfigServerPropertiesResponse": { "description": "Config server git properties payload", "properties": { "configServer": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigServerSettingsResponse", "description": "Settings of config server." }, "enabledState": { "type": "string", "description": "Enabled state of the config server. This is only used in Consumption tier." }, "error": { "type": "object", "$ref": "#/types/azure-native:appplatform:ErrorResponse", "description": "Error when apply config server settings." }, "provisioningState": { "type": "string", "description": "State of the config server." } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:ConfigServerSettings": { "description": "The settings of config server.", "properties": { "gitProperty": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigServerGitProperty", "description": "Property of git environment." } }, "type": "object" }, "azure-native:appplatform:ConfigServerSettingsResponse": { "description": "The settings of config server.", "properties": { "gitProperty": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigServerGitPropertyResponse", "description": "Property of git environment." } }, "type": "object" }, "azure-native:appplatform:ConfigurationServiceGeneration": { "description": "The generation of the Application Configuration Service.", "type": "string", "enum": [ { "value": "Gen1" }, { "value": "Gen2" } ] }, "azure-native:appplatform:ConfigurationServiceGitProperty": { "description": "Property of git environment.", "properties": { "repositories": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceGitRepository" }, "description": "Repositories of Application Configuration Service git property." } }, "type": "object" }, "azure-native:appplatform:ConfigurationServiceGitPropertyResponse": { "description": "Property of git environment.", "properties": { "repositories": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceGitRepositoryResponse" }, "description": "Repositories of Application Configuration Service git property." } }, "type": "object" }, "azure-native:appplatform:ConfigurationServiceGitRepository": { "description": "Git repository property payload for Application Configuration Service", "properties": { "caCertResourceId": { "type": "string", "description": "Resource Id of CA certificate for https URL of Git repository." }, "gitImplementation": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:GitImplementation" } ], "description": "Git libraries used to support various repository providers" }, "hostKey": { "type": "string", "description": "Public sshKey of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SshKey algorithm of git repository." }, "label": { "type": "string", "description": "Label of the repository" }, "name": { "type": "string", "description": "Name of the repository" }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "patterns": { "type": "array", "items": { "type": "string" }, "description": "Collection of patterns of the repository" }, "privateKey": { "type": "string", "description": "Private sshKey algorithm of git repository." }, "searchPaths": { "type": "array", "items": { "type": "string" }, "description": "Searching path of the repository" }, "strictHostKeyChecking": { "type": "boolean", "description": "Strict host key checking or not." }, "uri": { "type": "string", "description": "URI of the repository" }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "label", "name", "patterns", "uri" ] }, "azure-native:appplatform:ConfigurationServiceGitRepositoryResponse": { "description": "Git repository property payload for Application Configuration Service", "properties": { "caCertResourceId": { "type": "string", "description": "Resource Id of CA certificate for https URL of Git repository." }, "gitImplementation": { "type": "string", "description": "Git libraries used to support various repository providers" }, "hostKey": { "type": "string", "description": "Public sshKey of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SshKey algorithm of git repository." }, "label": { "type": "string", "description": "Label of the repository" }, "name": { "type": "string", "description": "Name of the repository" }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "patterns": { "type": "array", "items": { "type": "string" }, "description": "Collection of patterns of the repository" }, "privateKey": { "type": "string", "description": "Private sshKey algorithm of git repository." }, "searchPaths": { "type": "array", "items": { "type": "string" }, "description": "Searching path of the repository" }, "strictHostKeyChecking": { "type": "boolean", "description": "Strict host key checking or not." }, "uri": { "type": "string", "description": "URI of the repository" }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "label", "name", "patterns", "uri" ] }, "azure-native:appplatform:ConfigurationServiceInstanceResponse": { "description": "Collection of instances belong to the Application Configuration Service", "properties": { "name": { "type": "string", "description": "Name of the Application Configuration Service instance" }, "status": { "type": "string", "description": "Status of the Application Configuration Service instance" } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:ConfigurationServiceProperties": { "description": "Application Configuration Service properties payload", "properties": { "generation": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:ConfigurationServiceGeneration" } ], "description": "The generation of the Application Configuration Service.", "default": "Gen1" }, "settings": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceSettings", "description": "The settings of Application Configuration Service." } }, "type": "object" }, "azure-native:appplatform:ConfigurationServicePropertiesResponse": { "description": "Application Configuration Service properties payload", "properties": { "generation": { "type": "string", "description": "The generation of the Application Configuration Service.", "default": "Gen1" }, "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceInstanceResponse" }, "description": "Collection of instances belong to Application Configuration Service." }, "provisioningState": { "type": "string", "description": "State of the Application Configuration Service." }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." }, "settings": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceSettingsResponse", "description": "The settings of Application Configuration Service." } }, "type": "object", "required": [ "instances", "provisioningState", "resourceRequests" ] }, "azure-native:appplatform:ConfigurationServiceResourceRequestsResponse": { "description": "Resource request payload of Application Configuration Service", "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each Application Configuration Service instance" }, "instanceCount": { "type": "integer", "description": "Instance count of the Application Configuration Service" }, "memory": { "type": "string", "description": "Memory allocated to each Application Configuration Service instance" } }, "type": "object", "required": [ "cpu", "instanceCount", "memory" ] }, "azure-native:appplatform:ConfigurationServiceSettings": { "description": "The settings of Application Configuration Service.", "properties": { "gitProperty": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceGitProperty", "description": "Property of git environment." }, "refreshIntervalInSeconds": { "type": "integer", "description": "How often (in seconds) to check repository updates. Minimum value is 0." } }, "type": "object" }, "azure-native:appplatform:ConfigurationServiceSettingsResponse": { "description": "The settings of Application Configuration Service.", "properties": { "gitProperty": { "type": "object", "$ref": "#/types/azure-native:appplatform:ConfigurationServiceGitPropertyResponse", "description": "Property of git environment." }, "refreshIntervalInSeconds": { "type": "integer", "description": "How often (in seconds) to check repository updates. Minimum value is 0." } }, "type": "object" }, "azure-native:appplatform:ContainerProbeSettings": { "description": "Container liveness and readiness probe settings", "properties": { "disableProbe": { "type": "boolean", "description": "Indicates whether disable the liveness and readiness probe" } }, "type": "object" }, "azure-native:appplatform:ContainerProbeSettingsResponse": { "description": "Container liveness and readiness probe settings", "properties": { "disableProbe": { "type": "boolean", "description": "Indicates whether disable the liveness and readiness probe" } }, "type": "object" }, "azure-native:appplatform:ContainerRegistryBasicCredentials": { "description": "The basic authentication properties for the container registry resource.", "properties": { "password": { "type": "string", "description": "The password of the Container Registry." }, "server": { "type": "string", "description": "The login server of the Container Registry." }, "type": { "type": "string", "description": "The credential type of the container registry credentials.\nExpected value is 'BasicAuth'.", "const": "BasicAuth" }, "username": { "type": "string", "description": "The username of the Container Registry." } }, "type": "object", "required": [ "password", "server", "type", "username" ] }, "azure-native:appplatform:ContainerRegistryBasicCredentialsResponse": { "description": "The basic authentication properties for the container registry resource.", "properties": { "server": { "type": "string", "description": "The login server of the Container Registry." }, "type": { "type": "string", "description": "The credential type of the container registry credentials.\nExpected value is 'BasicAuth'.", "const": "BasicAuth" }, "username": { "type": "string", "description": "The username of the Container Registry." } }, "type": "object", "required": [ "server", "type", "username" ] }, "azure-native:appplatform:ContainerRegistryProperties": { "description": "Container registry resource payload.", "properties": { "credentials": { "type": "object", "$ref": "#/types/azure-native:appplatform:ContainerRegistryBasicCredentials", "description": "The credentials of the container registry resource." } }, "type": "object", "required": [ "credentials" ] }, "azure-native:appplatform:ContainerRegistryPropertiesResponse": { "description": "Container registry resource payload.", "properties": { "credentials": { "type": "object", "$ref": "#/types/azure-native:appplatform:ContainerRegistryBasicCredentialsResponse", "description": "The credentials of the container registry resource." }, "provisioningState": { "type": "string", "description": "State of the Container Registry." } }, "type": "object", "required": [ "credentials", "provisioningState" ] }, "azure-native:appplatform:ContentCertificateProperties": { "description": "Properties of certificate imported from key vault.", "properties": { "content": { "type": "string", "description": "The content of uploaded certificate." }, "type": { "type": "string", "description": "The type of the certificate source.\nExpected value is 'ContentCertificate'.", "const": "ContentCertificate" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:ContentCertificatePropertiesResponse": { "description": "Properties of certificate imported from key vault.", "properties": { "activateDate": { "type": "string", "description": "The activate date of certificate." }, "dnsNames": { "type": "array", "items": { "type": "string" }, "description": "The domain list of certificate." }, "expirationDate": { "type": "string", "description": "The expiration date of certificate." }, "issuedDate": { "type": "string", "description": "The issue date of certificate." }, "issuer": { "type": "string", "description": "The issuer of certificate." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Certificate" }, "subjectName": { "type": "string", "description": "The subject name of certificate." }, "thumbprint": { "type": "string", "description": "The thumbprint of certificate." }, "type": { "type": "string", "description": "The type of the certificate source.\nExpected value is 'ContentCertificate'.", "const": "ContentCertificate" } }, "type": "object", "required": [ "activateDate", "dnsNames", "expirationDate", "issuedDate", "issuer", "provisioningState", "subjectName", "thumbprint", "type" ] }, "azure-native:appplatform:CustomContainer": { "description": "Custom container payload", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided." }, "containerImage": { "type": "string", "description": "Container image of the custom container. This should be in the form of \u003crepository\u003e:\u003ctag\u003e without the server name of the registry" }, "imageRegistryCredential": { "type": "object", "$ref": "#/types/azure-native:appplatform:ImageRegistryCredential", "description": "Credential of the image registry" }, "languageFramework": { "type": "string", "description": "Language framework of the container image uploaded. Supported values: \"springboot\", \"\", null." }, "server": { "type": "string", "description": "The name of the registry that contains the container image" } }, "type": "object" }, "azure-native:appplatform:CustomContainerResponse": { "description": "Custom container payload", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Arguments to the entrypoint. The docker image's CMD is used if this is not provided." }, "command": { "type": "array", "items": { "type": "string" }, "description": "Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided." }, "containerImage": { "type": "string", "description": "Container image of the custom container. This should be in the form of \u003crepository\u003e:\u003ctag\u003e without the server name of the registry" }, "imageRegistryCredential": { "type": "object", "$ref": "#/types/azure-native:appplatform:ImageRegistryCredentialResponse", "description": "Credential of the image registry" }, "languageFramework": { "type": "string", "description": "Language framework of the container image uploaded. Supported values: \"springboot\", \"\", null." }, "server": { "type": "string", "description": "The name of the registry that contains the container image" } }, "type": "object" }, "azure-native:appplatform:CustomContainerUserSourceInfo": { "description": "Custom container user source info", "properties": { "customContainer": { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomContainer", "description": "Custom container payload" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'Container'.", "const": "Container" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:CustomContainerUserSourceInfoResponse": { "description": "Custom container user source info", "properties": { "customContainer": { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomContainerResponse", "description": "Custom container payload" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'Container'.", "const": "Container" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:CustomDomainProperties": { "description": "Custom domain of app resource payload.", "properties": { "certName": { "type": "string", "description": "The bound certificate name of domain." }, "thumbprint": { "type": "string", "description": "The thumbprint of bound certificate." } }, "type": "object" }, "azure-native:appplatform:CustomDomainPropertiesResponse": { "description": "Custom domain of app resource payload.", "properties": { "appName": { "type": "string", "description": "The app name of domain." }, "certName": { "type": "string", "description": "The bound certificate name of domain." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Domain" }, "thumbprint": { "type": "string", "description": "The thumbprint of bound certificate." } }, "type": "object", "required": [ "appName", "provisioningState" ] }, "azure-native:appplatform:CustomPersistentDiskResource": { "description": "Custom persistent disk resource payload.", "properties": { "customPersistentDiskProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:AzureFileVolume", "description": "Properties of the custom persistent disk resource payload." }, "storageId": { "type": "string", "description": "The resource id of Azure Spring Apps Storage resource." } }, "type": "object", "required": [ "storageId" ] }, "azure-native:appplatform:CustomPersistentDiskResourceResponse": { "description": "Custom persistent disk resource payload.", "properties": { "customPersistentDiskProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:AzureFileVolumeResponse", "description": "Properties of the custom persistent disk resource payload." }, "storageId": { "type": "string", "description": "The resource id of Azure Spring Apps Storage resource." } }, "type": "object", "required": [ "storageId" ] }, "azure-native:appplatform:CustomScaleRule": { "description": "Azure Spring Apps App Instance Custom scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuth" }, "description": "Authentication secrets for the custom scale rule." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe custom scale rule." }, "type": { "type": "string", "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc." } }, "type": "object" }, "azure-native:appplatform:CustomScaleRuleResponse": { "description": "Azure Spring Apps App Instance Custom scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the custom scale rule." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe custom scale rule." }, "type": { "type": "string", "description": "Type of the custom scale rule\neg: azure-servicebus, redis etc." } }, "type": "object" }, "azure-native:appplatform:CustomizedAcceleratorProperties": { "description": "Customized accelerator properties payload", "properties": { "acceleratorTags": { "type": "array", "items": { "type": "string" } }, "acceleratorType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:CustomizedAcceleratorType" } ], "description": "Type of the customized accelerator." }, "description": { "type": "string" }, "displayName": { "type": "string" }, "gitRepository": { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorGitRepository" }, "iconUrl": { "type": "string" } }, "type": "object", "required": [ "gitRepository" ] }, "azure-native:appplatform:CustomizedAcceleratorPropertiesResponse": { "description": "Customized accelerator properties payload", "properties": { "acceleratorTags": { "type": "array", "items": { "type": "string" } }, "acceleratorType": { "type": "string", "description": "Type of the customized accelerator." }, "description": { "type": "string" }, "displayName": { "type": "string" }, "gitRepository": { "type": "object", "$ref": "#/types/azure-native:appplatform:AcceleratorGitRepositoryResponse" }, "iconUrl": { "type": "string" }, "imports": { "type": "array", "items": { "type": "string" }, "description": "Imports references all imports that this accelerator/fragment depends upon." }, "provisioningState": { "type": "string", "description": "State of the customized accelerator." } }, "type": "object", "required": [ "gitRepository", "imports", "provisioningState" ] }, "azure-native:appplatform:CustomizedAcceleratorType": { "description": "Type of the customized accelerator.", "type": "string", "enum": [ { "value": "Accelerator" }, { "value": "Fragment" } ] }, "azure-native:appplatform:DeploymentInstanceResponse": { "description": "Deployment instance payload", "properties": { "discoveryStatus": { "type": "string", "description": "Discovery status of the deployment instance" }, "name": { "type": "string", "description": "Name of the deployment instance" }, "reason": { "type": "string", "description": "Failed reason of the deployment instance" }, "startTime": { "type": "string", "description": "Start time of the deployment instance" }, "status": { "type": "string", "description": "Status of the deployment instance" }, "zone": { "type": "string", "description": "Availability zone information of the deployment instance" } }, "type": "object", "required": [ "discoveryStatus", "name", "reason", "startTime", "status", "zone" ] }, "azure-native:appplatform:DeploymentResourceProperties": { "description": "Deployment resource properties payload", "properties": { "active": { "type": "boolean", "description": "Indicates whether the Deployment is active" }, "deploymentSettings": { "type": "object", "$ref": "#/types/azure-native:appplatform:DeploymentSettings", "description": "Deployment settings of the Deployment" }, "source": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildResultUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomContainerUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:JarUploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:UploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:WarUploadedUserSourceInfo" } ], "discriminator": { "propertyName": "type", "mapping": { "BuildResult": "#/types/azure-native:appplatform:BuildResultUserSourceInfo", "Container": "#/types/azure-native:appplatform:CustomContainerUserSourceInfo", "Jar": "#/types/azure-native:appplatform:JarUploadedUserSourceInfo", "NetCoreZip": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfo", "Source": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfo", "UploadedUserSourceInfo": "#/types/azure-native:appplatform:UploadedUserSourceInfo", "War": "#/types/azure-native:appplatform:WarUploadedUserSourceInfo" } }, "description": "Uploaded source information of the deployment." } }, "type": "object" }, "azure-native:appplatform:DeploymentResourcePropertiesResponse": { "description": "Deployment resource properties payload", "properties": { "active": { "type": "boolean", "description": "Indicates whether the Deployment is active" }, "deploymentSettings": { "type": "object", "$ref": "#/types/azure-native:appplatform:DeploymentSettingsResponse", "description": "Deployment settings of the Deployment" }, "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:DeploymentInstanceResponse" }, "description": "Collection of instances belong to the Deployment" }, "provisioningState": { "type": "string", "description": "Provisioning state of the Deployment" }, "source": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildResultUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomContainerUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:JarUploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:UploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:WarUploadedUserSourceInfoResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "BuildResult": "#/types/azure-native:appplatform:BuildResultUserSourceInfoResponse", "Container": "#/types/azure-native:appplatform:CustomContainerUserSourceInfoResponse", "Jar": "#/types/azure-native:appplatform:JarUploadedUserSourceInfoResponse", "NetCoreZip": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfoResponse", "Source": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfoResponse", "UploadedUserSourceInfo": "#/types/azure-native:appplatform:UploadedUserSourceInfoResponse", "War": "#/types/azure-native:appplatform:WarUploadedUserSourceInfoResponse" } }, "description": "Uploaded source information of the deployment." }, "status": { "type": "string", "description": "Status of the Deployment" } }, "type": "object", "required": [ "instances", "provisioningState", "status" ] }, "azure-native:appplatform:DeploymentSettings": { "description": "Deployment settings payload", "properties": { "addonConfigs": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "Collection of addons" }, "apms": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApmReference" }, "description": "Collection of ApmReferences" }, "containerProbeSettings": { "type": "object", "$ref": "#/types/azure-native:appplatform:ContainerProbeSettings", "description": "Container liveness and readiness probe settings" }, "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Collection of environment variables" }, "livenessProbe": { "type": "object", "$ref": "#/types/azure-native:appplatform:Probe", "description": "Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "readinessProbe": { "type": "object", "$ref": "#/types/azure-native:appplatform:Probe", "description": "Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ResourceRequests", "description": "The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later." }, "scale": { "type": "object", "$ref": "#/types/azure-native:appplatform:Scale", "description": "Scaling properties for the Azure Spring Apps App Instance." }, "startupProbe": { "type": "object", "$ref": "#/types/azure-native:appplatform:Probe", "description": "StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "terminationGracePeriodSeconds": { "type": "integer", "description": "Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.", "default": 90 } }, "type": "object" }, "azure-native:appplatform:DeploymentSettingsResponse": { "description": "Deployment settings payload", "properties": { "addonConfigs": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "Collection of addons" }, "apms": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApmReferenceResponse" }, "description": "Collection of ApmReferences" }, "containerProbeSettings": { "type": "object", "$ref": "#/types/azure-native:appplatform:ContainerProbeSettingsResponse", "description": "Container liveness and readiness probe settings" }, "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Collection of environment variables" }, "livenessProbe": { "type": "object", "$ref": "#/types/azure-native:appplatform:ProbeResponse", "description": "Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "readinessProbe": { "type": "object", "$ref": "#/types/azure-native:appplatform:ProbeResponse", "description": "Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later." }, "scale": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleResponse", "description": "Scaling properties for the Azure Spring Apps App Instance." }, "startupProbe": { "type": "object", "$ref": "#/types/azure-native:appplatform:ProbeResponse", "description": "StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "terminationGracePeriodSeconds": { "type": "integer", "description": "Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds.", "default": 90 } }, "type": "object" }, "azure-native:appplatform:DevToolPortalComponentResponse": { "properties": { "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalInstanceResponse" }, "description": "Collection of instances belong to Dev Tool Portal." }, "name": { "type": "string" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." } }, "type": "object", "required": [ "instances", "name", "resourceRequests" ] }, "azure-native:appplatform:DevToolPortalFeatureDetail": { "description": "Detail settings for Dev Tool Portal feature", "properties": { "state": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureState" } ], "description": "State of the plugin", "default": "Enabled" } }, "type": "object" }, "azure-native:appplatform:DevToolPortalFeatureDetailResponse": { "description": "Detail settings for Dev Tool Portal feature", "properties": { "route": { "type": "string", "description": "Route path to visit the plugin" }, "state": { "type": "string", "description": "State of the plugin", "default": "Enabled" } }, "type": "object", "required": [ "route" ] }, "azure-native:appplatform:DevToolPortalFeatureSettings": { "description": "Settings for Dev Tool Portal", "properties": { "applicationAccelerator": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureDetail", "description": "Detail of Accelerator plugin" }, "applicationLiveView": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureDetail", "description": "Detail of App Live View plugin" } }, "type": "object" }, "azure-native:appplatform:DevToolPortalFeatureSettingsResponse": { "description": "Settings for Dev Tool Portal", "properties": { "applicationAccelerator": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureDetailResponse", "description": "Detail of Accelerator plugin" }, "applicationLiveView": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureDetailResponse", "description": "Detail of App Live View plugin" } }, "type": "object" }, "azure-native:appplatform:DevToolPortalFeatureState": { "description": "State of the plugin", "type": "string", "enum": [ { "description": "Enable the plugin in Dev Tool Portal.", "value": "Enabled" }, { "description": "Disable the plugin in Dev Tool Portal.", "value": "Disabled" } ] }, "azure-native:appplatform:DevToolPortalInstanceResponse": { "description": "Collection of instances belong to the Dev Tool Portal.", "properties": { "name": { "type": "string", "description": "Name of the Dev Tool Portal instance." }, "status": { "type": "string", "description": "Status of the Dev Tool Portal instance. It can be Pending, Running, Succeeded, Failed, Unknown." } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:DevToolPortalProperties": { "description": "Dev Tool Portal properties payload", "properties": { "features": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureSettings", "description": "Settings for Dev Tool Portal" }, "public": { "type": "boolean", "description": "Indicates whether the resource exposes public endpoint", "default": false }, "ssoProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalSsoProperties", "description": "Single sign-on related configuration" } }, "type": "object" }, "azure-native:appplatform:DevToolPortalPropertiesResponse": { "description": "Dev Tool Portal properties payload", "properties": { "components": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalComponentResponse" }, "description": "Collection of components belong to Dev Tool Portal." }, "features": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalFeatureSettingsResponse", "description": "Settings for Dev Tool Portal" }, "provisioningState": { "type": "string", "description": "State of the Dev Tool Portal." }, "public": { "type": "boolean", "description": "Indicates whether the resource exposes public endpoint", "default": false }, "ssoProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:DevToolPortalSsoPropertiesResponse", "description": "Single sign-on related configuration" }, "url": { "type": "string", "description": "URL of the resource, exposed when 'public' is true." } }, "type": "object", "required": [ "components", "provisioningState", "url" ] }, "azure-native:appplatform:DevToolPortalResourceRequestsResponse": { "description": "The resource quantity for required CPU and Memory of Dev Tool Portal", "properties": { "cpu": { "type": "string", "description": "Cpu quantity allocated to each Dev Tool Portal instance. 1 core can be represented by 1 or 1000m" }, "instanceCount": { "type": "integer", "description": "Desired instance count of Dev Tool Portal." }, "memory": { "type": "string", "description": "Memory quantity allocated to each Dev Tool Portal instance. 1 GB can be represented by 1Gi or 1024Mi." } }, "type": "object", "required": [ "cpu", "instanceCount", "memory" ] }, "azure-native:appplatform:DevToolPortalSsoProperties": { "description": "Single sign-on related configuration", "properties": { "clientId": { "type": "string", "description": "The public identifier for the application" }, "clientSecret": { "type": "string", "description": "The secret known only to the application and the authorization server" }, "metadataUrl": { "type": "string", "description": "The URI of a JSON file with generic OIDC provider configuration." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "It defines the specific actions applications can be allowed to do on a user's behalf" } }, "type": "object" }, "azure-native:appplatform:DevToolPortalSsoPropertiesResponse": { "description": "Single sign-on related configuration", "properties": { "clientId": { "type": "string", "description": "The public identifier for the application" }, "clientSecret": { "type": "string", "description": "The secret known only to the application and the authorization server" }, "metadataUrl": { "type": "string", "description": "The URI of a JSON file with generic OIDC provider configuration." }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "It defines the specific actions applications can be allowed to do on a user's behalf" } }, "type": "object" }, "azure-native:appplatform:EnvVar": { "description": "Azure Spring Apps components' environment variable.", "properties": { "name": { "type": "string", "description": "Environment variable name." }, "secretValue": { "type": "string", "description": "secret environment variable value." }, "value": { "type": "string", "description": "Non-secret environment variable value." } }, "type": "object" }, "azure-native:appplatform:EnvVarResponse": { "description": "Azure Spring Apps components' environment variable.", "properties": { "name": { "type": "string", "description": "Environment variable name." }, "secretValue": { "type": "string", "description": "secret environment variable value." }, "value": { "type": "string", "description": "Non-secret environment variable value." } }, "type": "object" }, "azure-native:appplatform:Error": { "description": "The error code compose of code and message.", "properties": { "code": { "type": "string", "description": "The code of error." }, "message": { "type": "string", "description": "The message of error." } }, "type": "object" }, "azure-native:appplatform:ErrorResponse": { "description": "The error code compose of code and message.", "properties": { "code": { "type": "string", "description": "The code of error." }, "message": { "type": "string", "description": "The message of error." } }, "type": "object" }, "azure-native:appplatform:ExecAction": { "description": "ExecAction describes a \"run in container\" action.", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." }, "type": { "type": "string", "description": "The type of the action to take to perform the health check.\nExpected value is 'ExecAction'.", "const": "ExecAction" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:ExecActionResponse": { "description": "ExecAction describes a \"run in container\" action.", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy." }, "type": { "type": "string", "description": "The type of the action to take to perform the health check.\nExpected value is 'ExecAction'.", "const": "ExecAction" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:Frequency": { "description": "The frequency to run the maintenance job", "type": "string", "enum": [ { "value": "Weekly" } ] }, "azure-native:appplatform:GatewayApiMetadataProperties": { "description": "API metadata property for Spring Cloud Gateway", "properties": { "description": { "type": "string", "description": "Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`)" }, "documentation": { "type": "string", "description": "Location of additional documentation for the APIs available on the Gateway instance" }, "serverUrl": { "type": "string", "description": "Base URL that API consumers will use to access APIs on the Gateway instance." }, "title": { "type": "string", "description": "Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`)" }, "version": { "type": "string", "description": "Version of APIs available on this Gateway instance (default: `unspecified`)." } }, "type": "object" }, "azure-native:appplatform:GatewayApiMetadataPropertiesResponse": { "description": "API metadata property for Spring Cloud Gateway", "properties": { "description": { "type": "string", "description": "Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`)" }, "documentation": { "type": "string", "description": "Location of additional documentation for the APIs available on the Gateway instance" }, "serverUrl": { "type": "string", "description": "Base URL that API consumers will use to access APIs on the Gateway instance." }, "title": { "type": "string", "description": "Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`)" }, "version": { "type": "string", "description": "Version of APIs available on this Gateway instance (default: `unspecified`)." } }, "type": "object" }, "azure-native:appplatform:GatewayApiRoute": { "description": "API route config of the Spring Cloud Gateway", "properties": { "description": { "type": "string", "description": "A description, will be applied to methods in the generated OpenAPI documentation." }, "filters": { "type": "array", "items": { "type": "string" }, "description": "To modify the request before sending it to the target endpoint, or the received response." }, "order": { "type": "integer", "description": "Route processing order." }, "predicates": { "type": "array", "items": { "type": "string" }, "description": "A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request." }, "ssoEnabled": { "type": "boolean", "description": "Enable sso validation." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Classification tags, will be applied to methods in the generated OpenAPI documentation." }, "title": { "type": "string", "description": "A title, will be applied to methods in the generated OpenAPI documentation." }, "tokenRelay": { "type": "boolean", "description": "Pass currently-authenticated user's identity token to application service, default is 'false'" }, "uri": { "type": "string", "description": "Full uri, will override `appName`." } }, "type": "object" }, "azure-native:appplatform:GatewayApiRouteResponse": { "description": "API route config of the Spring Cloud Gateway", "properties": { "description": { "type": "string", "description": "A description, will be applied to methods in the generated OpenAPI documentation." }, "filters": { "type": "array", "items": { "type": "string" }, "description": "To modify the request before sending it to the target endpoint, or the received response." }, "order": { "type": "integer", "description": "Route processing order." }, "predicates": { "type": "array", "items": { "type": "string" }, "description": "A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request." }, "ssoEnabled": { "type": "boolean", "description": "Enable sso validation." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "Classification tags, will be applied to methods in the generated OpenAPI documentation." }, "title": { "type": "string", "description": "A title, will be applied to methods in the generated OpenAPI documentation." }, "tokenRelay": { "type": "boolean", "description": "Pass currently-authenticated user's identity token to application service, default is 'false'" }, "uri": { "type": "string", "description": "Full uri, will override `appName`." } }, "type": "object" }, "azure-native:appplatform:GatewayCertificateVerification": { "description": "Whether to enable certificate verification or not", "type": "string", "enum": [ { "description": "Enable certificate verification in Spring Cloud Gateway.", "value": "Enabled" }, { "description": "Disable certificate verification in Spring Cloud Gateway.", "value": "Disabled" } ] }, "azure-native:appplatform:GatewayCorsProperties": { "description": "Cross-Origin Resource Sharing property", "properties": { "allowCredentials": { "type": "boolean", "description": "Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`." }, "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "Allowed headers in cross-site requests. The special value `*` allows actual requests to send any header." }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "Allowed HTTP methods on cross-site requests. The special value `*` allows all methods. If not set, `GET` and `HEAD` are allowed by default." }, "allowedOriginPatterns": { "type": "array", "items": { "type": "string" }, "description": "Allowed origin patterns to make cross-site requests." }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins to make cross-site requests. The special value `*` allows all domains." }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "HTTP response headers to expose for cross-site requests." }, "maxAge": { "type": "integer", "description": "How long, in seconds, the response from a pre-flight request can be cached by clients." } }, "type": "object" }, "azure-native:appplatform:GatewayCorsPropertiesResponse": { "description": "Cross-Origin Resource Sharing property", "properties": { "allowCredentials": { "type": "boolean", "description": "Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`." }, "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "Allowed headers in cross-site requests. The special value `*` allows actual requests to send any header." }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "Allowed HTTP methods on cross-site requests. The special value `*` allows all methods. If not set, `GET` and `HEAD` are allowed by default." }, "allowedOriginPatterns": { "type": "array", "items": { "type": "string" }, "description": "Allowed origin patterns to make cross-site requests." }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "Allowed origins to make cross-site requests. The special value `*` allows all domains." }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "HTTP response headers to expose for cross-site requests." }, "maxAge": { "type": "integer", "description": "How long, in seconds, the response from a pre-flight request can be cached by clients." } }, "type": "object" }, "azure-native:appplatform:GatewayCustomDomainProperties": { "description": "The properties of custom domain for Spring Cloud Gateway", "properties": { "thumbprint": { "type": "string", "description": "The thumbprint of bound certificate." } }, "type": "object" }, "azure-native:appplatform:GatewayCustomDomainPropertiesResponse": { "description": "The properties of custom domain for Spring Cloud Gateway", "properties": { "thumbprint": { "type": "string", "description": "The thumbprint of bound certificate." } }, "type": "object" }, "azure-native:appplatform:GatewayInstanceResponse": { "description": "Collection of instances belong to the Spring Cloud Gateway", "properties": { "name": { "type": "string", "description": "Name of the Spring Cloud Gateway instance" }, "status": { "type": "string", "description": "Status of the Spring Cloud Gateway instance" } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:GatewayLocalResponseCachePerInstanceProperties": { "description": "Spring Cloud Gateway local response cache per instance properties.", "properties": { "responseCacheType": { "type": "string", "description": "The type of the response cache.\nExpected value is 'LocalCachePerInstance'.", "const": "LocalCachePerInstance" }, "size": { "type": "string", "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries" }, "timeToLive": { "type": "string", "description": "Time before a cached entry is expired (300s, 5m, 1h...)" } }, "type": "object", "required": [ "responseCacheType" ] }, "azure-native:appplatform:GatewayLocalResponseCachePerInstancePropertiesResponse": { "description": "Spring Cloud Gateway local response cache per instance properties.", "properties": { "responseCacheType": { "type": "string", "description": "The type of the response cache.\nExpected value is 'LocalCachePerInstance'.", "const": "LocalCachePerInstance" }, "size": { "type": "string", "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries" }, "timeToLive": { "type": "string", "description": "Time before a cached entry is expired (300s, 5m, 1h...)" } }, "type": "object", "required": [ "responseCacheType" ] }, "azure-native:appplatform:GatewayLocalResponseCachePerRouteProperties": { "description": "Spring Cloud Gateway local response cache per route properties.", "properties": { "responseCacheType": { "type": "string", "description": "The type of the response cache.\nExpected value is 'LocalCachePerRoute'.", "const": "LocalCachePerRoute" }, "size": { "type": "string", "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries." }, "timeToLive": { "type": "string", "description": "Time before a cached entry is expired (300s, 5m, 1h...)" } }, "type": "object", "required": [ "responseCacheType" ] }, "azure-native:appplatform:GatewayLocalResponseCachePerRoutePropertiesResponse": { "description": "Spring Cloud Gateway local response cache per route properties.", "properties": { "responseCacheType": { "type": "string", "description": "The type of the response cache.\nExpected value is 'LocalCachePerRoute'.", "const": "LocalCachePerRoute" }, "size": { "type": "string", "description": "Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries." }, "timeToLive": { "type": "string", "description": "Time before a cached entry is expired (300s, 5m, 1h...)" } }, "type": "object", "required": [ "responseCacheType" ] }, "azure-native:appplatform:GatewayOperatorPropertiesResponse": { "description": "Properties of the Spring Cloud Gateway Operator.", "properties": { "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayInstanceResponse" }, "description": "Collection of instances belong to Spring Cloud Gateway operator." }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayOperatorResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." } }, "type": "object", "required": [ "instances", "resourceRequests" ] }, "azure-native:appplatform:GatewayOperatorResourceRequestsResponse": { "description": "Properties of the Spring Cloud Gateway Operator.", "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each Spring Cloud Gateway Operator instance." }, "instanceCount": { "type": "integer", "description": "Instance count of the Spring Cloud Gateway Operator." }, "memory": { "type": "string", "description": "Memory allocated to each Spring Cloud Gateway Operator instance." } }, "type": "object", "required": [ "cpu", "instanceCount", "memory" ] }, "azure-native:appplatform:GatewayProperties": { "description": "Spring Cloud Gateway properties payload", "properties": { "addonConfigs": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "Collection of addons for Spring Cloud Gateway" }, "apiMetadataProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayApiMetadataProperties", "description": "API metadata property for Spring Cloud Gateway" }, "apmTypes": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:ApmType" } ] }, "description": "Collection of APM type used in Spring Cloud Gateway" }, "apms": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApmReference" }, "description": "Collection of ApmReferences in service level" }, "clientAuth": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayPropertiesClientAuth", "description": "Client-Certification Authentication." }, "corsProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayCorsProperties", "description": "Cross-Origin Resource Sharing property" }, "environmentVariables": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayPropertiesEnvironmentVariables", "description": "Environment variables of Spring Cloud Gateway" }, "httpsOnly": { "type": "boolean", "description": "Indicate if only https is allowed.", "default": false }, "public": { "type": "boolean", "description": "Indicates whether the Spring Cloud Gateway exposes endpoint.", "default": false }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayResourceRequests", "description": "The requested resource quantity for required CPU and Memory." }, "responseCacheProperties": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerInstanceProperties" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerRouteProperties" } ], "discriminator": { "propertyName": "responseCacheType", "mapping": { "LocalCachePerInstance": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerInstanceProperties", "LocalCachePerRoute": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerRouteProperties" } }, "description": "The properties to configure different types of response cache for Spring Cloud Gateway." }, "ssoProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:SsoProperties", "description": "Single sign-on related configuration" } }, "type": "object" }, "azure-native:appplatform:GatewayPropertiesClientAuth": { "description": "Client-Certification Authentication.", "properties": { "certificateVerification": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:GatewayCertificateVerification" } ], "description": "Whether to enable certificate verification or not", "default": "Disabled" }, "certificates": { "type": "array", "items": { "type": "string" }, "description": "Collection of certificate resource Ids in Azure Spring Apps." } }, "type": "object" }, "azure-native:appplatform:GatewayPropertiesEnvironmentVariables": { "description": "Environment variables of Spring Cloud Gateway", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive properties" }, "secrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Sensitive properties" } }, "type": "object" }, "azure-native:appplatform:GatewayPropertiesResponse": { "description": "Spring Cloud Gateway properties payload", "properties": { "addonConfigs": { "type": "object", "additionalProperties": { "$ref": "pulumi.json#/Any" }, "description": "Collection of addons for Spring Cloud Gateway" }, "apiMetadataProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayApiMetadataPropertiesResponse", "description": "API metadata property for Spring Cloud Gateway" }, "apmTypes": { "type": "array", "items": { "type": "string" }, "description": "Collection of APM type used in Spring Cloud Gateway" }, "apms": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApmReferenceResponse" }, "description": "Collection of ApmReferences in service level" }, "clientAuth": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayPropertiesResponseClientAuth", "description": "Client-Certification Authentication." }, "corsProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayCorsPropertiesResponse", "description": "Cross-Origin Resource Sharing property" }, "environmentVariables": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayPropertiesResponseEnvironmentVariables", "description": "Environment variables of Spring Cloud Gateway" }, "httpsOnly": { "type": "boolean", "description": "Indicate if only https is allowed.", "default": false }, "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayInstanceResponse" }, "description": "Collection of instances belong to Spring Cloud Gateway." }, "operatorProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayOperatorPropertiesResponse", "description": "Properties of the Spring Cloud Gateway Operator." }, "provisioningState": { "type": "string", "description": "State of the Spring Cloud Gateway." }, "public": { "type": "boolean", "description": "Indicates whether the Spring Cloud Gateway exposes endpoint.", "default": false }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." }, "responseCacheProperties": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerInstancePropertiesResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerRoutePropertiesResponse" } ], "discriminator": { "propertyName": "responseCacheType", "mapping": { "LocalCachePerInstance": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerInstancePropertiesResponse", "LocalCachePerRoute": "#/types/azure-native:appplatform:GatewayLocalResponseCachePerRoutePropertiesResponse" } }, "description": "The properties to configure different types of response cache for Spring Cloud Gateway." }, "ssoProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:SsoPropertiesResponse", "description": "Single sign-on related configuration" }, "url": { "type": "string", "description": "URL of the Spring Cloud Gateway, exposed when 'public' is true." } }, "type": "object", "required": [ "instances", "operatorProperties", "provisioningState", "url" ] }, "azure-native:appplatform:GatewayPropertiesResponseClientAuth": { "description": "Client-Certification Authentication.", "properties": { "certificateVerification": { "type": "string", "description": "Whether to enable certificate verification or not", "default": "Disabled" }, "certificates": { "type": "array", "items": { "type": "string" }, "description": "Collection of certificate resource Ids in Azure Spring Apps." } }, "type": "object" }, "azure-native:appplatform:GatewayPropertiesResponseEnvironmentVariables": { "description": "Environment variables of Spring Cloud Gateway", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Non-sensitive properties" }, "secrets": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Sensitive properties" } }, "type": "object" }, "azure-native:appplatform:GatewayResourceRequests": { "description": "Resource request payload of Spring Cloud Gateway.", "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each Spring Cloud Gateway instance.", "default": "1" }, "memory": { "type": "string", "description": "Memory allocated to each Spring Cloud Gateway instance.", "default": "2Gi" } }, "type": "object" }, "azure-native:appplatform:GatewayResourceRequestsResponse": { "description": "Resource request payload of Spring Cloud Gateway.", "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each Spring Cloud Gateway instance.", "default": "1" }, "memory": { "type": "string", "description": "Memory allocated to each Spring Cloud Gateway instance.", "default": "2Gi" } }, "type": "object" }, "azure-native:appplatform:GatewayRouteConfigOpenApiProperties": { "description": "OpenAPI properties of Spring Cloud Gateway route config.", "properties": { "uri": { "type": "string", "description": "The URI of OpenAPI specification." } }, "type": "object" }, "azure-native:appplatform:GatewayRouteConfigOpenApiPropertiesResponse": { "description": "OpenAPI properties of Spring Cloud Gateway route config.", "properties": { "uri": { "type": "string", "description": "The URI of OpenAPI specification." } }, "type": "object" }, "azure-native:appplatform:GatewayRouteConfigProperties": { "description": "API route config of the Spring Cloud Gateway", "properties": { "appResourceId": { "type": "string", "description": "The resource Id of the Azure Spring Apps app, required unless route defines `uri`." }, "filters": { "type": "array", "items": { "type": "string" }, "description": "To modify the request before sending it to the target endpoint, or the received response in app level." }, "openApi": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayRouteConfigOpenApiProperties", "description": "OpenAPI properties of Spring Cloud Gateway route config." }, "predicates": { "type": "array", "items": { "type": "string" }, "description": "A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request." }, "protocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:GatewayRouteConfigProtocol" } ], "description": "Protocol of routed Azure Spring Apps applications.", "default": "HTTP" }, "routes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayApiRoute" }, "description": "Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`." }, "ssoEnabled": { "type": "boolean", "description": "Enable Single Sign-On in app level." } }, "type": "object" }, "azure-native:appplatform:GatewayRouteConfigPropertiesResponse": { "description": "API route config of the Spring Cloud Gateway", "properties": { "appResourceId": { "type": "string", "description": "The resource Id of the Azure Spring Apps app, required unless route defines `uri`." }, "filters": { "type": "array", "items": { "type": "string" }, "description": "To modify the request before sending it to the target endpoint, or the received response in app level." }, "openApi": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayRouteConfigOpenApiPropertiesResponse", "description": "OpenAPI properties of Spring Cloud Gateway route config." }, "predicates": { "type": "array", "items": { "type": "string" }, "description": "A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request." }, "protocol": { "type": "string", "description": "Protocol of routed Azure Spring Apps applications.", "default": "HTTP" }, "provisioningState": { "type": "string", "description": "State of the Spring Cloud Gateway route config." }, "routes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:GatewayApiRouteResponse" }, "description": "Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`." }, "ssoEnabled": { "type": "boolean", "description": "Enable Single Sign-On in app level." } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:GatewayRouteConfigProtocol": { "description": "Protocol of routed Azure Spring Apps applications.", "type": "string", "enum": [ { "value": "HTTP" }, { "value": "HTTPS" } ] }, "azure-native:appplatform:GitImplementation": { "description": "Git libraries used to support various repository providers", "type": "string", "enum": [ { "value": "go-git" }, { "value": "libgit2" } ] }, "azure-native:appplatform:GitPatternRepository": { "description": "Git repository property payload for config server", "properties": { "hostKey": { "type": "string", "description": "Public sshKey of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SshKey algorithm of git repository." }, "label": { "type": "string", "description": "Label of the repository" }, "name": { "type": "string", "description": "Name of the repository" }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "pattern": { "type": "array", "items": { "type": "string" }, "description": "Collection of pattern of the repository" }, "privateKey": { "type": "string", "description": "Private sshKey algorithm of git repository." }, "searchPaths": { "type": "array", "items": { "type": "string" }, "description": "Searching path of the repository" }, "strictHostKeyChecking": { "type": "boolean", "description": "Strict host key checking or not." }, "uri": { "type": "string", "description": "URI of the repository" }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "name", "uri" ] }, "azure-native:appplatform:GitPatternRepositoryResponse": { "description": "Git repository property payload for config server", "properties": { "hostKey": { "type": "string", "description": "Public sshKey of git repository." }, "hostKeyAlgorithm": { "type": "string", "description": "SshKey algorithm of git repository." }, "label": { "type": "string", "description": "Label of the repository" }, "name": { "type": "string", "description": "Name of the repository" }, "password": { "type": "string", "description": "Password of git repository basic auth." }, "pattern": { "type": "array", "items": { "type": "string" }, "description": "Collection of pattern of the repository" }, "privateKey": { "type": "string", "description": "Private sshKey algorithm of git repository." }, "searchPaths": { "type": "array", "items": { "type": "string" }, "description": "Searching path of the repository" }, "strictHostKeyChecking": { "type": "boolean", "description": "Strict host key checking or not." }, "uri": { "type": "string", "description": "URI of the repository" }, "username": { "type": "string", "description": "Username of git repository basic auth." } }, "type": "object", "required": [ "name", "uri" ] }, "azure-native:appplatform:HTTPGetAction": { "description": "HTTPGetAction describes an action based on HTTP Get requests.", "properties": { "path": { "type": "string", "description": "Path to access on the HTTP server." }, "scheme": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:HTTPSchemeType" } ], "description": "Scheme to use for connecting to the host. Defaults to HTTP.\n\nPossible enum values:\n - `\"HTTP\"` means that the scheme used will be http://\n - `\"HTTPS\"` means that the scheme used will be https://" }, "type": { "type": "string", "description": "The type of the action to take to perform the health check.\nExpected value is 'HTTPGetAction'.", "const": "HTTPGetAction" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:HTTPGetActionResponse": { "description": "HTTPGetAction describes an action based on HTTP Get requests.", "properties": { "path": { "type": "string", "description": "Path to access on the HTTP server." }, "scheme": { "type": "string", "description": "Scheme to use for connecting to the host. Defaults to HTTP.\n\nPossible enum values:\n - `\"HTTP\"` means that the scheme used will be http://\n - `\"HTTPS\"` means that the scheme used will be https://" }, "type": { "type": "string", "description": "The type of the action to take to perform the health check.\nExpected value is 'HTTPGetAction'.", "const": "HTTPGetAction" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:HTTPSchemeType": { "description": "Scheme to use for connecting to the host. Defaults to HTTP.\n\nPossible enum values:\n - `\"HTTP\"` means that the scheme used will be http://\n - `\"HTTPS\"` means that the scheme used will be https://", "type": "string", "enum": [ { "value": "HTTP" }, { "value": "HTTPS" } ] }, "azure-native:appplatform:HttpScaleRule": { "description": "Azure Spring Apps App Instance Http scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuth" }, "description": "Authentication secrets for the custom scale rule." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe http scale rule." } }, "type": "object" }, "azure-native:appplatform:HttpScaleRuleResponse": { "description": "Azure Spring Apps App Instance Http scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the custom scale rule." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe http scale rule." } }, "type": "object" }, "azure-native:appplatform:ImageRegistryCredential": { "description": "Credential of the image registry", "properties": { "password": { "type": "string", "description": "The password of the image registry credential" }, "username": { "type": "string", "description": "The username of the image registry credential" } }, "type": "object" }, "azure-native:appplatform:ImageRegistryCredentialResponse": { "description": "Credential of the image registry", "properties": { "password": { "type": "string", "description": "The password of the image registry credential" }, "username": { "type": "string", "description": "The username of the image registry credential" } }, "type": "object" }, "azure-native:appplatform:IngressConfig": { "description": "Ingress configuration payload for Azure Spring Apps resource.", "properties": { "readTimeoutInSeconds": { "type": "integer", "description": "Ingress read time out in seconds." } }, "type": "object" }, "azure-native:appplatform:IngressConfigResponse": { "description": "Ingress configuration payload for Azure Spring Apps resource.", "properties": { "readTimeoutInSeconds": { "type": "integer", "description": "Ingress read time out in seconds." } }, "type": "object" }, "azure-native:appplatform:IngressSettings": { "description": "App ingress settings payload.", "properties": { "backendProtocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:BackendProtocol" } ], "description": "How ingress should communicate with this app backend service." }, "clientAuth": { "type": "object", "$ref": "#/types/azure-native:appplatform:IngressSettingsClientAuth", "description": "Client-Certification Authentication." }, "readTimeoutInSeconds": { "type": "integer", "description": "Ingress read time out in seconds." }, "sendTimeoutInSeconds": { "type": "integer", "description": "Ingress send time out in seconds." }, "sessionAffinity": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:SessionAffinity" } ], "description": "Type of the affinity, set this to Cookie to enable session affinity." }, "sessionCookieMaxAge": { "type": "integer", "description": "Time in seconds until the cookie expires." } }, "type": "object" }, "azure-native:appplatform:IngressSettingsClientAuth": { "description": "Client-Certification Authentication.", "properties": { "certificates": { "type": "array", "items": { "type": "string" }, "description": "Collection of certificate resource id." } }, "type": "object" }, "azure-native:appplatform:IngressSettingsResponse": { "description": "App ingress settings payload.", "properties": { "backendProtocol": { "type": "string", "description": "How ingress should communicate with this app backend service." }, "clientAuth": { "type": "object", "$ref": "#/types/azure-native:appplatform:IngressSettingsResponseClientAuth", "description": "Client-Certification Authentication." }, "readTimeoutInSeconds": { "type": "integer", "description": "Ingress read time out in seconds." }, "sendTimeoutInSeconds": { "type": "integer", "description": "Ingress send time out in seconds." }, "sessionAffinity": { "type": "string", "description": "Type of the affinity, set this to Cookie to enable session affinity." }, "sessionCookieMaxAge": { "type": "integer", "description": "Time in seconds until the cookie expires." } }, "type": "object" }, "azure-native:appplatform:IngressSettingsResponseClientAuth": { "description": "Client-Certification Authentication.", "properties": { "certificates": { "type": "array", "items": { "type": "string" }, "description": "Collection of certificate resource id." } }, "type": "object" }, "azure-native:appplatform:JarUploadedUserSourceInfo": { "description": "Uploaded Jar binary for a deployment", "properties": { "jvmOptions": { "type": "string", "description": "JVM parameter" }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the Jar file" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'Jar'.", "const": "Jar" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:JarUploadedUserSourceInfoResponse": { "description": "Uploaded Jar binary for a deployment", "properties": { "jvmOptions": { "type": "string", "description": "JVM parameter" }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the Jar file" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'Jar'.", "const": "Jar" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:JobExecutionTemplate": { "description": "Job's execution template, containing configuration for an execution", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Arguments for the Job execution." }, "environmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:EnvVar" }, "description": "Environment variables of Job execution" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:JobResourceRequests", "description": "The requested resource quantity for required CPU and Memory." } }, "type": "object" }, "azure-native:appplatform:JobExecutionTemplateResponse": { "description": "Job's execution template, containing configuration for an execution", "properties": { "args": { "type": "array", "items": { "type": "string" }, "description": "Arguments for the Job execution." }, "environmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:EnvVarResponse" }, "description": "Environment variables of Job execution" }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:JobResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." } }, "type": "object" }, "azure-native:appplatform:JobResourceProperties": { "description": "Job resource properties payload", "properties": { "managedComponentReferences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ManagedComponentReference" }, "description": "Referenced managed components collection" }, "source": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildResultUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomContainerUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:JarUploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:UploadedUserSourceInfo" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:WarUploadedUserSourceInfo" } ], "discriminator": { "propertyName": "type", "mapping": { "BuildResult": "#/types/azure-native:appplatform:BuildResultUserSourceInfo", "Container": "#/types/azure-native:appplatform:CustomContainerUserSourceInfo", "Jar": "#/types/azure-native:appplatform:JarUploadedUserSourceInfo", "NetCoreZip": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfo", "Source": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfo", "UploadedUserSourceInfo": "#/types/azure-native:appplatform:UploadedUserSourceInfo", "War": "#/types/azure-native:appplatform:WarUploadedUserSourceInfo" } }, "description": "Uploaded source information of the Job." }, "template": { "type": "object", "$ref": "#/types/azure-native:appplatform:JobExecutionTemplate", "description": "The template which is applied for all executions of the Job." }, "triggerConfig": { "type": "object", "$ref": "#/types/azure-native:appplatform:ManualJobTriggerConfig", "description": "The Job trigger related configuration." } }, "type": "object" }, "azure-native:appplatform:JobResourcePropertiesResponse": { "description": "Job resource properties payload", "properties": { "managedComponentReferences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ManagedComponentReferenceResponse" }, "description": "Referenced managed components collection" }, "provisioningState": { "type": "string", "description": "Provisioning state of the Job" }, "source": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:BuildResultUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomContainerUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:JarUploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:UploadedUserSourceInfoResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:WarUploadedUserSourceInfoResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "BuildResult": "#/types/azure-native:appplatform:BuildResultUserSourceInfoResponse", "Container": "#/types/azure-native:appplatform:CustomContainerUserSourceInfoResponse", "Jar": "#/types/azure-native:appplatform:JarUploadedUserSourceInfoResponse", "NetCoreZip": "#/types/azure-native:appplatform:NetCoreZipUploadedUserSourceInfoResponse", "Source": "#/types/azure-native:appplatform:SourceUploadedUserSourceInfoResponse", "UploadedUserSourceInfo": "#/types/azure-native:appplatform:UploadedUserSourceInfoResponse", "War": "#/types/azure-native:appplatform:WarUploadedUserSourceInfoResponse" } }, "description": "Uploaded source information of the Job." }, "template": { "type": "object", "$ref": "#/types/azure-native:appplatform:JobExecutionTemplateResponse", "description": "The template which is applied for all executions of the Job." }, "triggerConfig": { "type": "object", "$ref": "#/types/azure-native:appplatform:ManualJobTriggerConfigResponse", "description": "The Job trigger related configuration." } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:JobResourceRequests": { "description": "Job resource request payload", "properties": { "cpu": { "type": "string", "description": "CPU allocated to each job execution instance.", "default": "1" }, "memory": { "type": "string", "description": "Memory allocated to each job execution instance.", "default": "2Gi" } }, "type": "object" }, "azure-native:appplatform:JobResourceRequestsResponse": { "description": "Job resource request payload", "properties": { "cpu": { "type": "string", "description": "CPU allocated to each job execution instance.", "default": "1" }, "memory": { "type": "string", "description": "Memory allocated to each job execution instance.", "default": "2Gi" } }, "type": "object" }, "azure-native:appplatform:KeyVaultCertificateAutoSync": { "description": "Indicates whether to automatically synchronize certificate from key vault or not.", "type": "string", "enum": [ { "value": "Disabled" }, { "value": "Enabled" } ] }, "azure-native:appplatform:KeyVaultCertificateProperties": { "description": "Properties of certificate imported from key vault.", "properties": { "autoSync": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:KeyVaultCertificateAutoSync" } ], "description": "Indicates whether to automatically synchronize certificate from key vault or not.", "default": "Disabled" }, "certVersion": { "type": "string", "description": "The certificate version of key vault." }, "excludePrivateKey": { "type": "boolean", "description": "Optional. If set to true, it will not import private key from key vault.", "default": false }, "keyVaultCertName": { "type": "string", "description": "The certificate name of key vault." }, "type": { "type": "string", "description": "The type of the certificate source.\nExpected value is 'KeyVaultCertificate'.", "const": "KeyVaultCertificate" }, "vaultUri": { "type": "string", "description": "The vault uri of user key vault." } }, "type": "object", "required": [ "keyVaultCertName", "type", "vaultUri" ] }, "azure-native:appplatform:KeyVaultCertificatePropertiesResponse": { "description": "Properties of certificate imported from key vault.", "properties": { "activateDate": { "type": "string", "description": "The activate date of certificate." }, "autoSync": { "type": "string", "description": "Indicates whether to automatically synchronize certificate from key vault or not.", "default": "Disabled" }, "certVersion": { "type": "string", "description": "The certificate version of key vault." }, "dnsNames": { "type": "array", "items": { "type": "string" }, "description": "The domain list of certificate." }, "excludePrivateKey": { "type": "boolean", "description": "Optional. If set to true, it will not import private key from key vault.", "default": false }, "expirationDate": { "type": "string", "description": "The expiration date of certificate." }, "issuedDate": { "type": "string", "description": "The issue date of certificate." }, "issuer": { "type": "string", "description": "The issuer of certificate." }, "keyVaultCertName": { "type": "string", "description": "The certificate name of key vault." }, "provisioningState": { "type": "string", "description": "Provisioning state of the Certificate" }, "subjectName": { "type": "string", "description": "The subject name of certificate." }, "thumbprint": { "type": "string", "description": "The thumbprint of certificate." }, "type": { "type": "string", "description": "The type of the certificate source.\nExpected value is 'KeyVaultCertificate'.", "const": "KeyVaultCertificate" }, "vaultUri": { "type": "string", "description": "The vault uri of user key vault." } }, "type": "object", "required": [ "activateDate", "dnsNames", "expirationDate", "issuedDate", "issuer", "keyVaultCertName", "provisioningState", "subjectName", "thumbprint", "type", "vaultUri" ] }, "azure-native:appplatform:LoadedCertificate": { "description": "Loaded certificate payload", "properties": { "loadTrustStore": { "type": "boolean", "description": "Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.", "default": false }, "resourceId": { "type": "string", "description": "Resource Id of loaded certificate" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:LoadedCertificateResponse": { "description": "Loaded certificate payload", "properties": { "loadTrustStore": { "type": "boolean", "description": "Indicate whether the certificate will be loaded into default trust store, only work for Java runtime.", "default": false }, "resourceId": { "type": "string", "description": "Resource Id of loaded certificate" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:ManagedComponentReference": { "description": "A reference to the managed component like Config Server.", "properties": { "resourceId": { "type": "string", "description": "Resource Id of the managed component" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:ManagedComponentReferenceResponse": { "description": "A reference to the managed component like Config Server.", "properties": { "resourceId": { "type": "string", "description": "Resource Id of the managed component" } }, "type": "object", "required": [ "resourceId" ] }, "azure-native:appplatform:ManagedIdentityProperties": { "description": "Managed identity properties retrieved from ARM request headers.", "properties": { "principalId": { "type": "string", "description": "Principal Id of system-assigned managed identity." }, "tenantId": { "type": "string", "description": "Tenant Id of system-assigned managed identity." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:ManagedIdentityType" } ], "description": "Type of the managed identity" }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "Properties of user-assigned managed identities" } }, "type": "object" }, "azure-native:appplatform:ManagedIdentityPropertiesResponse": { "description": "Managed identity properties retrieved from ARM request headers.", "properties": { "principalId": { "type": "string", "description": "Principal Id of system-assigned managed identity." }, "tenantId": { "type": "string", "description": "Tenant Id of system-assigned managed identity." }, "type": { "type": "string", "description": "Type of the managed identity" }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:appplatform:UserAssignedManagedIdentityResponse" }, "description": "Properties of user-assigned managed identities" } }, "type": "object" }, "azure-native:appplatform:ManagedIdentityType": { "description": "Type of the managed identity", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" }, { "value": "UserAssigned" }, { "value": "SystemAssigned,UserAssigned" } ] }, "azure-native:appplatform:ManualJobTriggerConfig": { "description": "Configuration for manual triggered job", "properties": { "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job execution can run." }, "retryLimit": { "type": "integer", "description": "Maximum number of retries before failing the job." }, "timeoutInSeconds": { "type": "integer", "description": "Maximum number of seconds an execution is allowed to run." }, "triggerType": { "type": "string", "description": "Type of job trigger\nExpected value is 'Manual'.", "const": "Manual", "default": "Manual" } }, "type": "object", "required": [ "triggerType" ] }, "azure-native:appplatform:ManualJobTriggerConfigResponse": { "description": "Configuration for manual triggered job", "properties": { "parallelism": { "type": "integer", "description": "Number of parallel replicas of a job execution can run." }, "retryLimit": { "type": "integer", "description": "Maximum number of retries before failing the job." }, "timeoutInSeconds": { "type": "integer", "description": "Maximum number of seconds an execution is allowed to run." }, "triggerType": { "type": "string", "description": "Type of job trigger\nExpected value is 'Manual'.", "const": "Manual", "default": "Manual" } }, "type": "object", "required": [ "triggerType" ] }, "azure-native:appplatform:MarketplaceResource": { "description": "Purchasing 3rd Party product for one Azure Spring Apps instance", "properties": { "plan": { "type": "string", "description": "The plan id of the 3rd Party Artifact that is being procured." }, "product": { "type": "string", "description": "The 3rd Party artifact that is being procured." }, "publisher": { "type": "string", "description": "The publisher id of the 3rd Party Artifact that is being bought." } }, "type": "object" }, "azure-native:appplatform:MarketplaceResourceResponse": { "description": "Purchasing 3rd Party product for one Azure Spring Apps instance", "properties": { "plan": { "type": "string", "description": "The plan id of the 3rd Party Artifact that is being procured." }, "product": { "type": "string", "description": "The 3rd Party artifact that is being procured." }, "publisher": { "type": "string", "description": "The publisher id of the 3rd Party Artifact that is being bought." } }, "type": "object" }, "azure-native:appplatform:MonitoringSettingProperties": { "description": "Monitoring Setting properties payload", "properties": { "appInsightsInstrumentationKey": { "type": "string", "description": "Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings" }, "appInsightsSamplingRate": { "type": "number", "description": "Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]" }, "error": { "type": "object", "$ref": "#/types/azure-native:appplatform:Error", "description": "Error when apply Monitoring Setting changes." }, "traceEnabled": { "type": "boolean", "description": "Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not" } }, "type": "object" }, "azure-native:appplatform:MonitoringSettingPropertiesResponse": { "description": "Monitoring Setting properties payload", "properties": { "appInsightsAgentVersions": { "type": "object", "$ref": "#/types/azure-native:appplatform:ApplicationInsightsAgentVersionsResponse", "description": "Indicates the versions of application insight agent" }, "appInsightsInstrumentationKey": { "type": "string", "description": "Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings" }, "appInsightsSamplingRate": { "type": "number", "description": "Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0]" }, "error": { "type": "object", "$ref": "#/types/azure-native:appplatform:ErrorResponse", "description": "Error when apply Monitoring Setting changes." }, "provisioningState": { "type": "string", "description": "State of the Monitoring Setting." }, "traceEnabled": { "type": "boolean", "description": "Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:NetCoreZipUploadedUserSourceInfo": { "description": "Uploaded Jar binary for a deployment", "properties": { "netCoreMainEntryPath": { "type": "string", "description": "The path to the .NET executable relative to zip root" }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the .Net file" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'NetCoreZip'.", "const": "NetCoreZip" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:NetCoreZipUploadedUserSourceInfoResponse": { "description": "Uploaded Jar binary for a deployment", "properties": { "netCoreMainEntryPath": { "type": "string", "description": "The path to the .NET executable relative to zip root" }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the .Net file" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'NetCoreZip'.", "const": "NetCoreZip" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:NetworkProfile": { "description": "Service network profile payload", "properties": { "appNetworkResourceGroup": { "type": "string", "description": "Name of the resource group containing network resources for customer apps in Azure Spring Apps" }, "appSubnetId": { "type": "string", "description": "Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps" }, "ingressConfig": { "type": "object", "$ref": "#/types/azure-native:appplatform:IngressConfig", "description": "Ingress configuration payload for Azure Spring Apps resource." }, "outboundType": { "type": "string", "description": "The egress traffic type of Azure Spring Apps VNet instances." }, "serviceCidr": { "type": "string", "description": "Azure Spring Apps service reserved CIDR" }, "serviceRuntimeNetworkResourceGroup": { "type": "string", "description": "Name of the resource group containing network resources of Azure Spring Apps Service Runtime" }, "serviceRuntimeSubnetId": { "type": "string", "description": "Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime" } }, "type": "object" }, "azure-native:appplatform:NetworkProfileResponse": { "description": "Service network profile payload", "properties": { "appNetworkResourceGroup": { "type": "string", "description": "Name of the resource group containing network resources for customer apps in Azure Spring Apps" }, "appSubnetId": { "type": "string", "description": "Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps" }, "ingressConfig": { "type": "object", "$ref": "#/types/azure-native:appplatform:IngressConfigResponse", "description": "Ingress configuration payload for Azure Spring Apps resource." }, "outboundIPs": { "type": "object", "$ref": "#/types/azure-native:appplatform:NetworkProfileResponseOutboundIPs", "description": "Desired outbound IP resources for Azure Spring Apps resource." }, "outboundType": { "type": "string", "description": "The egress traffic type of Azure Spring Apps VNet instances." }, "requiredTraffics": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:RequiredTrafficResponse" }, "description": "Required inbound or outbound traffics for Azure Spring Apps resource." }, "serviceCidr": { "type": "string", "description": "Azure Spring Apps service reserved CIDR" }, "serviceRuntimeNetworkResourceGroup": { "type": "string", "description": "Name of the resource group containing network resources of Azure Spring Apps Service Runtime" }, "serviceRuntimeSubnetId": { "type": "string", "description": "Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime" } }, "type": "object", "required": [ "outboundIPs", "requiredTraffics" ] }, "azure-native:appplatform:NetworkProfileResponseOutboundIPs": { "description": "Desired outbound IP resources for Azure Spring Apps resource.", "properties": { "publicIPs": { "type": "array", "items": { "type": "string" }, "description": "A list of public IP addresses." } }, "type": "object", "required": [ "publicIPs" ] }, "azure-native:appplatform:PersistentDisk": { "description": "Persistent disk payload", "properties": { "mountPath": { "type": "string", "description": "Mount path of the persistent disk" }, "sizeInGB": { "type": "integer", "description": "Size of the persistent disk in GB" } }, "type": "object" }, "azure-native:appplatform:PersistentDiskResponse": { "description": "Persistent disk payload", "properties": { "mountPath": { "type": "string", "description": "Mount path of the persistent disk" }, "sizeInGB": { "type": "integer", "description": "Size of the persistent disk in GB" }, "usedInGB": { "type": "integer", "description": "Size of the used persistent disk in GB" } }, "type": "object", "required": [ "usedInGB" ] }, "azure-native:appplatform:Probe": { "description": "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.", "properties": { "disableProbe": { "type": "boolean", "description": "Indicate whether the probe is disabled.", "default": false }, "failureThreshold": { "type": "integer", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1." }, "initialDelaySeconds": { "type": "integer", "description": "Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "periodSeconds": { "type": "integer", "description": "How often (in seconds) to perform the probe. Minimum value is 1." }, "probeAction": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:ExecAction" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:HTTPGetAction" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:TCPSocketAction" } ], "discriminator": { "propertyName": "type", "mapping": { "ExecAction": "#/types/azure-native:appplatform:ExecAction", "HTTPGetAction": "#/types/azure-native:appplatform:HTTPGetAction", "TCPSocketAction": "#/types/azure-native:appplatform:TCPSocketAction" } }, "description": "The action of the probe." }, "successThreshold": { "type": "integer", "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1." }, "timeoutSeconds": { "type": "integer", "description": "Number of seconds after which the probe times out. Minimum value is 1." } }, "type": "object", "required": [ "disableProbe" ] }, "azure-native:appplatform:ProbeActionType": { "description": "The type of the action to take to perform the health check.", "type": "string", "enum": [ { "value": "HTTPGetAction" }, { "value": "TCPSocketAction" }, { "value": "ExecAction" } ] }, "azure-native:appplatform:ProbeResponse": { "description": "Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic.", "properties": { "disableProbe": { "type": "boolean", "description": "Indicate whether the probe is disabled.", "default": false }, "failureThreshold": { "type": "integer", "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1." }, "initialDelaySeconds": { "type": "integer", "description": "Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" }, "periodSeconds": { "type": "integer", "description": "How often (in seconds) to perform the probe. Minimum value is 1." }, "probeAction": { "oneOf": [ { "type": "object", "$ref": "#/types/azure-native:appplatform:ExecActionResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:HTTPGetActionResponse" }, { "type": "object", "$ref": "#/types/azure-native:appplatform:TCPSocketActionResponse" } ], "discriminator": { "propertyName": "type", "mapping": { "ExecAction": "#/types/azure-native:appplatform:ExecActionResponse", "HTTPGetAction": "#/types/azure-native:appplatform:HTTPGetActionResponse", "TCPSocketAction": "#/types/azure-native:appplatform:TCPSocketActionResponse" } }, "description": "The action of the probe." }, "successThreshold": { "type": "integer", "description": "Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1." }, "timeoutSeconds": { "type": "integer", "description": "Number of seconds after which the probe times out. Minimum value is 1." } }, "type": "object", "required": [ "disableProbe" ] }, "azure-native:appplatform:QueueScaleRule": { "description": "Azure Spring Apps App Instance Azure Queue based scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuth" }, "description": "Authentication secrets for the queue scale rule." }, "queueLength": { "type": "integer", "description": "Queue length." }, "queueName": { "type": "string", "description": "Queue name." } }, "type": "object" }, "azure-native:appplatform:QueueScaleRuleResponse": { "description": "Azure Spring Apps App Instance Azure Queue based scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the queue scale rule." }, "queueLength": { "type": "integer", "description": "Queue length." }, "queueName": { "type": "string", "description": "Queue name." } }, "type": "object" }, "azure-native:appplatform:RequiredTrafficResponse": { "description": "Required inbound or outbound traffic for Azure Spring Apps resource.", "properties": { "direction": { "type": "string", "description": "The direction of required traffic" }, "fqdns": { "type": "array", "items": { "type": "string" }, "description": "The FQDN list of required traffic" }, "ips": { "type": "array", "items": { "type": "string" }, "description": "The ip list of required traffic" }, "port": { "type": "integer", "description": "The port of required traffic" }, "protocol": { "type": "string", "description": "The protocol of required traffic" } }, "type": "object", "required": [ "direction", "fqdns", "ips", "port", "protocol" ] }, "azure-native:appplatform:ResourceRequests": { "description": "Deployment resource request payload", "properties": { "cpu": { "type": "string", "description": "Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier." }, "memory": { "type": "string", "description": "Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier." } }, "type": "object" }, "azure-native:appplatform:ResourceRequestsResponse": { "description": "Deployment resource request payload", "properties": { "cpu": { "type": "string", "description": "Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier." }, "memory": { "type": "string", "description": "Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier." } }, "type": "object" }, "azure-native:appplatform:Scale": { "description": "Azure Spring Apps scaling configurations.", "properties": { "maxReplicas": { "type": "integer", "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", "default": 10 }, "minReplicas": { "type": "integer", "description": "Optional. Minimum number of container replicas." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRule" }, "description": "Scaling rules." } }, "type": "object" }, "azure-native:appplatform:ScaleResponse": { "description": "Azure Spring Apps scaling configurations.", "properties": { "maxReplicas": { "type": "integer", "description": "Optional. Maximum number of container replicas. Defaults to 10 if not set.", "default": 10 }, "minReplicas": { "type": "integer", "description": "Optional. Minimum number of container replicas." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleResponse" }, "description": "Scaling rules." } }, "type": "object" }, "azure-native:appplatform:ScaleRule": { "description": "Azure Spring Apps App Instance scaling rule.", "properties": { "azureQueue": { "type": "object", "$ref": "#/types/azure-native:appplatform:QueueScaleRule", "description": "Azure Queue based scaling." }, "custom": { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomScaleRule", "description": "Custom scale rule." }, "http": { "type": "object", "$ref": "#/types/azure-native:appplatform:HttpScaleRule", "description": "HTTP requests based scaling." }, "name": { "type": "string", "description": "Scale Rule Name" }, "tcp": { "type": "object", "$ref": "#/types/azure-native:appplatform:TcpScaleRule", "description": "Tcp requests based scaling." } }, "type": "object" }, "azure-native:appplatform:ScaleRuleAuth": { "description": "Auth Secrets for Azure Spring Apps App Instance Scale Rule", "properties": { "secretRef": { "type": "string", "description": "Name of the Azure Spring Apps App Instance secret from which to pull the auth params." }, "triggerParameter": { "type": "string", "description": "Trigger Parameter that uses the secret" } }, "type": "object" }, "azure-native:appplatform:ScaleRuleAuthResponse": { "description": "Auth Secrets for Azure Spring Apps App Instance Scale Rule", "properties": { "secretRef": { "type": "string", "description": "Name of the Azure Spring Apps App Instance secret from which to pull the auth params." }, "triggerParameter": { "type": "string", "description": "Trigger Parameter that uses the secret" } }, "type": "object" }, "azure-native:appplatform:ScaleRuleResponse": { "description": "Azure Spring Apps App Instance scaling rule.", "properties": { "azureQueue": { "type": "object", "$ref": "#/types/azure-native:appplatform:QueueScaleRuleResponse", "description": "Azure Queue based scaling." }, "custom": { "type": "object", "$ref": "#/types/azure-native:appplatform:CustomScaleRuleResponse", "description": "Custom scale rule." }, "http": { "type": "object", "$ref": "#/types/azure-native:appplatform:HttpScaleRuleResponse", "description": "HTTP requests based scaling." }, "name": { "type": "string", "description": "Scale Rule Name" }, "tcp": { "type": "object", "$ref": "#/types/azure-native:appplatform:TcpScaleRuleResponse", "description": "Tcp requests based scaling." } }, "type": "object" }, "azure-native:appplatform:Secret": { "description": "Secret definition.", "properties": { "name": { "type": "string", "description": "Secret Name." }, "value": { "type": "string", "description": "Secret Value." } }, "type": "object" }, "azure-native:appplatform:SecretResponse": { "description": "Secret definition.", "properties": { "name": { "type": "string", "description": "Secret Name." } }, "type": "object" }, "azure-native:appplatform:ServiceRegistryInstanceResponse": { "description": "Collection of instances belong to the Service Registry", "properties": { "name": { "type": "string", "description": "Name of the Service Registry instance" }, "status": { "type": "string", "description": "Status of the Service Registry instance" } }, "type": "object", "required": [ "name", "status" ] }, "azure-native:appplatform:ServiceRegistryPropertiesResponse": { "description": "Service Registry properties payload", "properties": { "instances": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ServiceRegistryInstanceResponse" }, "description": "Collection of instances belong to Service Registry." }, "provisioningState": { "type": "string", "description": "State of the Service Registry." }, "resourceRequests": { "type": "object", "$ref": "#/types/azure-native:appplatform:ServiceRegistryResourceRequestsResponse", "description": "The requested resource quantity for required CPU and Memory." } }, "type": "object", "required": [ "instances", "provisioningState", "resourceRequests" ] }, "azure-native:appplatform:ServiceRegistryResourceRequestsResponse": { "description": "Resource request payload of Service Registry", "properties": { "cpu": { "type": "string", "description": "Cpu allocated to each Service Registry instance" }, "instanceCount": { "type": "integer", "description": "Instance count of the Service Registry" }, "memory": { "type": "string", "description": "Memory allocated to each Service Registry instance" } }, "type": "object", "required": [ "cpu", "instanceCount", "memory" ] }, "azure-native:appplatform:ServiceVNetAddons": { "description": "Additional Service settings in vnet injection instance", "properties": { "dataPlanePublicEndpoint": { "type": "boolean", "description": "Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.", "default": false }, "logStreamPublicEndpoint": { "type": "boolean", "description": "Indicates whether the log stream in vnet injection instance could be accessed from internet.", "default": false } }, "type": "object" }, "azure-native:appplatform:ServiceVNetAddonsResponse": { "description": "Additional Service settings in vnet injection instance", "properties": { "dataPlanePublicEndpoint": { "type": "boolean", "description": "Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet.", "default": false }, "logStreamPublicEndpoint": { "type": "boolean", "description": "Indicates whether the log stream in vnet injection instance could be accessed from internet.", "default": false } }, "type": "object" }, "azure-native:appplatform:SessionAffinity": { "description": "Type of the affinity, set this to Cookie to enable session affinity.", "type": "string", "enum": [ { "value": "Cookie" }, { "value": "None" } ] }, "azure-native:appplatform:Sku": { "description": "Sku of Azure Spring Apps", "properties": { "capacity": { "type": "integer", "description": "Current capacity of the target resource" }, "name": { "type": "string", "description": "Name of the Sku", "default": "S0" }, "tier": { "type": "string", "description": "Tier of the Sku", "default": "Standard" } }, "type": "object" }, "azure-native:appplatform:SkuResponse": { "description": "Sku of Azure Spring Apps", "properties": { "capacity": { "type": "integer", "description": "Current capacity of the target resource" }, "name": { "type": "string", "description": "Name of the Sku", "default": "S0" }, "tier": { "type": "string", "description": "Tier of the Sku", "default": "Standard" } }, "type": "object" }, "azure-native:appplatform:SourceUploadedUserSourceInfo": { "description": "Uploaded Java source code binary for a deployment", "properties": { "artifactSelector": { "type": "string", "description": "Selector for the artifact to be used for the deployment for multi-module projects. This should be\r\nthe relative path to the target module/project." }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the source file" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'Source'.", "const": "Source" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:SourceUploadedUserSourceInfoResponse": { "description": "Uploaded Java source code binary for a deployment", "properties": { "artifactSelector": { "type": "string", "description": "Selector for the artifact to be used for the deployment for multi-module projects. This should be\r\nthe relative path to the target module/project." }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the source file" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'Source'.", "const": "Source" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:SsoProperties": { "description": "Single sign-on related configuration", "properties": { "clientId": { "type": "string", "description": "The public identifier for the application" }, "clientSecret": { "type": "string", "description": "The secret known only to the application and the authorization server" }, "issuerUri": { "type": "string", "description": "The URI of Issuer Identifier" }, "scope": { "type": "array", "items": { "type": "string" }, "description": "It defines the specific actions applications can be allowed to do on a user's behalf" } }, "type": "object" }, "azure-native:appplatform:SsoPropertiesResponse": { "description": "Single sign-on related configuration", "properties": { "clientId": { "type": "string", "description": "The public identifier for the application" }, "clientSecret": { "type": "string", "description": "The secret known only to the application and the authorization server" }, "issuerUri": { "type": "string", "description": "The URI of Issuer Identifier" }, "scope": { "type": "array", "items": { "type": "string" }, "description": "It defines the specific actions applications can be allowed to do on a user's behalf" } }, "type": "object" }, "azure-native:appplatform:StackProperties": { "description": "KPack ClusterStack properties payload", "properties": { "id": { "type": "string", "description": "Id of the ClusterStack." }, "version": { "type": "string", "description": "Version of the ClusterStack" } }, "type": "object" }, "azure-native:appplatform:StackPropertiesResponse": { "description": "KPack ClusterStack properties payload", "properties": { "id": { "type": "string", "description": "Id of the ClusterStack." }, "version": { "type": "string", "description": "Version of the ClusterStack" } }, "type": "object" }, "azure-native:appplatform:StorageAccount": { "description": "storage resource of type Azure Storage Account.", "properties": { "accountKey": { "type": "string", "description": "The account key of the Azure Storage Account." }, "accountName": { "type": "string", "description": "The account name of the Azure Storage Account." }, "storageType": { "type": "string", "description": "The type of the storage.\nExpected value is 'StorageAccount'.", "const": "StorageAccount" } }, "type": "object", "required": [ "accountKey", "accountName", "storageType" ] }, "azure-native:appplatform:StorageAccountResponse": { "description": "storage resource of type Azure Storage Account.", "properties": { "accountName": { "type": "string", "description": "The account name of the Azure Storage Account." }, "storageType": { "type": "string", "description": "The type of the storage.\nExpected value is 'StorageAccount'.", "const": "StorageAccount" } }, "type": "object", "required": [ "accountName", "storageType" ] }, "azure-native:appplatform:StorageType": { "description": "The type of the storage.", "type": "string", "enum": [ { "value": "StorageAccount" } ] }, "azure-native:appplatform:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource modification (UTC)." }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:appplatform:TCPSocketAction": { "description": "TCPSocketAction describes an action based on opening a socket", "properties": { "type": { "type": "string", "description": "The type of the action to take to perform the health check.\nExpected value is 'TCPSocketAction'.", "const": "TCPSocketAction" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:TCPSocketActionResponse": { "description": "TCPSocketAction describes an action based on opening a socket", "properties": { "type": { "type": "string", "description": "The type of the action to take to perform the health check.\nExpected value is 'TCPSocketAction'.", "const": "TCPSocketAction" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:TcpScaleRule": { "description": "Azure Spring Apps App Instance Tcp scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuth" }, "description": "Authentication secrets for the tcp scale rule." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe tcp scale rule." } }, "type": "object" }, "azure-native:appplatform:TcpScaleRuleResponse": { "description": "Azure Spring Apps App Instance Tcp scaling rule.", "properties": { "auth": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:appplatform:ScaleRuleAuthResponse" }, "description": "Authentication secrets for the tcp scale rule." }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Metadata properties to describe tcp scale rule." } }, "type": "object" }, "azure-native:appplatform:TemporaryDisk": { "description": "Temporary disk payload", "properties": { "mountPath": { "type": "string", "description": "Mount path of the temporary disk", "default": "/tmp" }, "sizeInGB": { "type": "integer", "description": "Size of the temporary disk in GB" } }, "type": "object" }, "azure-native:appplatform:TemporaryDiskResponse": { "description": "Temporary disk payload", "properties": { "mountPath": { "type": "string", "description": "Mount path of the temporary disk", "default": "/tmp" }, "sizeInGB": { "type": "integer", "description": "Size of the temporary disk in GB" } }, "type": "object" }, "azure-native:appplatform:TestEndpointAuthState": { "description": "State of test endpoint auth.", "type": "string", "enum": [ { "description": "Enable test endpoint auth.", "value": "Enabled" }, { "description": "Disable test endpoint auth", "value": "Disabled" } ] }, "azure-native:appplatform:TriggerType": { "description": "Type of job trigger", "type": "string", "enum": [ { "value": "Manual" } ] }, "azure-native:appplatform:TriggeredBuildResultResponse": { "description": "The build result triggered by a build", "properties": { "id": { "type": "string", "description": "The unique build id of this build result" }, "image": { "type": "string", "description": "The container image of this build result" }, "lastTransitionReason": { "type": "string", "description": "The last transition reason of this build result" }, "lastTransitionStatus": { "type": "string", "description": "The last transition status of this build result" }, "lastTransitionTime": { "type": "string", "description": "The last transition time of this build result" }, "provisioningState": { "type": "string", "description": "The provisioning state of this build result" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:appplatform:Type": { "description": "The type of the underlying resource to mount as a persistent disk.", "type": "string", "enum": [ { "value": "AzureFileVolume" } ] }, "azure-native:appplatform:UploadedUserSourceInfo": { "description": "Source with uploaded location", "properties": { "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'UploadedUserSourceInfo'.", "const": "UploadedUserSourceInfo" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:UploadedUserSourceInfoResponse": { "description": "Source with uploaded location", "properties": { "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'UploadedUserSourceInfo'.", "const": "UploadedUserSourceInfo" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:UserAssignedManagedIdentityResponse": { "description": "The details of the user-assigned managed identity assigned to an App.", "properties": { "clientId": { "type": "string", "description": "Client Id of user-assigned managed identity." }, "principalId": { "type": "string", "description": "Principal Id of user-assigned managed identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:appplatform:WarUploadedUserSourceInfo": { "description": "Uploaded War binary for a deployment", "properties": { "jvmOptions": { "type": "string", "description": "JVM parameter" }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the war file" }, "serverVersion": { "type": "string", "description": "Server version, currently only Apache Tomcat is supported" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'War'.", "const": "War" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:WarUploadedUserSourceInfoResponse": { "description": "Uploaded War binary for a deployment", "properties": { "jvmOptions": { "type": "string", "description": "JVM parameter" }, "relativePath": { "type": "string", "description": "Relative path of the storage which stores the source" }, "runtimeVersion": { "type": "string", "description": "Runtime version of the war file" }, "serverVersion": { "type": "string", "description": "Server version, currently only Apache Tomcat is supported" }, "type": { "type": "string", "description": "Type of the source uploaded\nExpected value is 'War'.", "const": "War" }, "version": { "type": "string", "description": "Version of the source" } }, "type": "object", "required": [ "type" ] }, "azure-native:appplatform:WeekDay": { "description": "The day to run the maintenance job", "type": "string", "enum": [ { "value": "Monday" }, { "value": "Tuesday" }, { "value": "Wednesday" }, { "value": "Thursday" }, { "value": "Friday" }, { "value": "Saturday" }, { "value": "Sunday" } ] }, "azure-native:appplatform:WeeklyMaintenanceScheduleConfiguration": { "description": "Weekly planned maintenance", "properties": { "day": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:appplatform:WeekDay" } ], "description": "The day to run the maintenance job" }, "frequency": { "type": "string", "description": "The frequency to run the maintenance job\nExpected value is 'Weekly'.", "const": "Weekly" }, "hour": { "type": "integer", "description": "The hour to run the maintenance job" } }, "type": "object", "required": [ "day", "frequency", "hour" ] }, "azure-native:appplatform:WeeklyMaintenanceScheduleConfigurationResponse": { "description": "Weekly planned maintenance", "properties": { "day": { "type": "string", "description": "The day to run the maintenance job" }, "duration": { "type": "string", "description": "The duration time to run the maintenance job, specified in ISO8601 format, e.g. PT8H" }, "frequency": { "type": "string", "description": "The frequency to run the maintenance job\nExpected value is 'Weekly'.", "const": "Weekly" }, "hour": { "type": "integer", "description": "The hour to run the maintenance job" } }, "type": "object", "required": [ "day", "duration", "frequency", "hour" ] }, "azure-native:attestation:AttestationServiceCreationSpecificParams": { "description": "Client supplied parameters used to create a new attestation provider.", "properties": { "policySigningCertificates": { "type": "object", "$ref": "#/types/azure-native:attestation:JsonWebKeySet", "description": "JSON Web Key Set defining a set of X.509 Certificates that will represent the parent certificate for the signing certificate used for policy operations" }, "publicNetworkAccess": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:attestation:PublicNetworkAccessType" } ], "description": "Controls whether traffic from the public network is allowed to access the Attestation Provider APIs.", "default": "Enabled" }, "tpmAttestationAuthentication": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:attestation:TpmAttestationAuthenticationType" } ], "description": "The setting that controls whether authentication is enabled or disabled for TPM Attestation REST APIs.", "default": "Enabled" } }, "type": "object" }, "azure-native:attestation:JsonWebKey": { "properties": { "alg": { "type": "string", "description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name." }, "crv": { "type": "string", "description": "The \"crv\" (curve) parameter identifies the curve type" }, "d": { "type": "string", "description": "RSA private exponent or ECC private key" }, "dp": { "type": "string", "description": "RSA Private Key Parameter" }, "dq": { "type": "string", "description": "RSA Private Key Parameter" }, "e": { "type": "string", "description": "RSA public exponent, in Base64" }, "k": { "type": "string", "description": "Symmetric key" }, "kid": { "type": "string", "description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string." }, "kty": { "type": "string", "description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string." }, "n": { "type": "string", "description": "RSA modulus, in Base64" }, "p": { "type": "string", "description": "RSA secret prime" }, "q": { "type": "string", "description": "RSA secret prime, with p \u003c q" }, "qi": { "type": "string", "description": "RSA Private Key Parameter" }, "use": { "type": "string", "description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption)." }, "x": { "type": "string", "description": "X coordinate for the Elliptic Curve point" }, "x5C": { "type": "array", "items": { "type": "string" }, "description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate." }, "y": { "type": "string", "description": "Y coordinate for the Elliptic Curve point" } }, "type": "object", "required": [ "kty" ] }, "azure-native:attestation:JsonWebKeySet": { "properties": { "keys": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:attestation:JsonWebKey" }, "description": "The value of the \"keys\" parameter is an array of JWK values. By\ndefault, the order of the JWK values within the array does not imply\nan order of preference among them, although applications of JWK Sets\ncan choose to assign a meaning to the order for their purposes, if\ndesired." } }, "type": "object" }, "azure-native:attestation:PrivateEndpointConnectionResponse": { "description": "The Private Endpoint Connection resource.", "properties": { "id": { "type": "string", "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" }, "name": { "type": "string", "description": "The name of the resource" }, "privateEndpoint": { "type": "object", "$ref": "#/types/azure-native:attestation:PrivateEndpointResponse", "description": "The resource of private end point." }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:attestation:PrivateLinkServiceConnectionStateResponse", "description": "A collection of information about the state of the connection between service consumer and provider." }, "provisioningState": { "type": "string", "description": "The provisioning state of the private endpoint connection resource." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:attestation:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "id", "name", "privateLinkServiceConnectionState", "provisioningState", "systemData", "type" ] }, "azure-native:attestation:PrivateEndpointResponse": { "description": "The Private Endpoint resource.", "properties": { "id": { "type": "string", "description": "The ARM identifier for Private Endpoint" } }, "type": "object", "required": [ "id" ] }, "azure-native:attestation:PrivateEndpointServiceConnectionStatus": { "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", "type": "string", "enum": [ { "value": "Pending" }, { "value": "Approved" }, { "value": "Rejected" } ] }, "azure-native:attestation:PrivateLinkServiceConnectionState": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:attestation:PrivateEndpointServiceConnectionStatus" } ], "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:attestation:PrivateLinkServiceConnectionStateResponse": { "description": "A collection of information about the state of the connection between service consumer and provider.", "properties": { "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." }, "description": { "type": "string", "description": "The reason for approval/rejection of the connection." }, "status": { "type": "string", "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." } }, "type": "object" }, "azure-native:attestation:PublicNetworkAccessType": { "description": "Controls whether traffic from the public network is allowed to access the Attestation Provider APIs.", "type": "string", "enum": [ { "name": "Enabled", "description": "Enables public network connectivity to the Attestation Provider REST APIs.", "value": "Enabled" }, { "name": "Disabled", "description": "Disables public network connectivity to the Attestation Provider REST APIs.", "value": "Disabled" } ] }, "azure-native:attestation:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:attestation:TpmAttestationAuthenticationType": { "description": "The setting that controls whether authentication is enabled or disabled for TPM Attestation REST APIs.", "type": "string", "enum": [ { "name": "Enabled", "description": "Enables the requirement of authentication for TPM Attestation REST APIs.", "value": "Enabled" }, { "name": "Disabled", "description": "Disables the requirement of authentication for TPM Attestation REST APIs.", "value": "Disabled" } ] }, "azure-native:authorization:AccessReviewHistoryInstance": { "description": "Access Review History Definition Instance.", "properties": { "displayName": { "type": "string", "description": "The display name for the parent history definition." }, "expiration": { "type": "string", "description": "Date time when history data report expires and the associated data is deleted." }, "fulfilledDateTime": { "type": "string", "description": "Date time when the history data report is scheduled to be generated." }, "reviewHistoryPeriodEndDateTime": { "type": "string", "description": "Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports." }, "reviewHistoryPeriodStartDateTime": { "type": "string", "description": "Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports." }, "runDateTime": { "type": "string", "description": "Date time when the history data report is scheduled to be generated." } }, "type": "object" }, "azure-native:authorization:AccessReviewHistoryInstanceResponse": { "description": "Access Review History Definition Instance.", "properties": { "displayName": { "type": "string", "description": "The display name for the parent history definition." }, "downloadUri": { "type": "string", "description": "Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri." }, "expiration": { "type": "string", "description": "Date time when history data report expires and the associated data is deleted." }, "fulfilledDateTime": { "type": "string", "description": "Date time when the history data report is scheduled to be generated." }, "id": { "type": "string", "description": "The access review history definition instance id." }, "name": { "type": "string", "description": "The access review history definition instance unique id." }, "reviewHistoryPeriodEndDateTime": { "type": "string", "description": "Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports." }, "reviewHistoryPeriodStartDateTime": { "type": "string", "description": "Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports." }, "runDateTime": { "type": "string", "description": "Date time when the history data report is scheduled to be generated." }, "status": { "type": "string", "description": "Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -\u003e InProgress -\u003e Done -\u003e Expired" }, "type": { "type": "string", "description": "The resource type." } }, "type": "object", "required": [ "downloadUri", "id", "name", "status", "type" ] }, "azure-native:authorization:AccessReviewInstance": { "description": "Access Review Instance.", "properties": { "backupReviewers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:AccessReviewReviewer" }, "description": "This is the collection of backup reviewers." }, "endDateTime": { "type": "string", "description": "The DateTime when the review instance is scheduled to end." }, "reviewers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:AccessReviewReviewer" }, "description": "This is the collection of reviewers." }, "startDateTime": { "type": "string", "description": "The DateTime when the review instance is scheduled to be start." } }, "type": "object" }, "azure-native:authorization:AccessReviewInstanceResponse": { "description": "Access Review Instance.", "properties": { "backupReviewers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:AccessReviewReviewerResponse" }, "description": "This is the collection of backup reviewers." }, "endDateTime": { "type": "string", "description": "The DateTime when the review instance is scheduled to end." }, "id": { "type": "string", "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" }, "name": { "type": "string", "description": "The name of the resource" }, "reviewers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:AccessReviewReviewerResponse" }, "description": "This is the collection of reviewers." }, "reviewersType": { "type": "string", "description": "This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review." }, "startDateTime": { "type": "string", "description": "The DateTime when the review instance is scheduled to be start." }, "status": { "type": "string", "description": "This read-only field specifies the status of an access review instance." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:authorization:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "id", "name", "reviewersType", "status", "systemData", "type" ] }, "azure-native:authorization:AccessReviewRecurrencePatternType": { "description": "The recurrence type : weekly, monthly, etc.", "type": "string", "enum": [ { "name": "weekly", "description": "weekly", "value": "weekly" }, { "name": "absoluteMonthly", "description": "absoluteMonthly", "value": "absoluteMonthly" } ] }, "azure-native:authorization:AccessReviewRecurrenceRange": { "description": "Recurrence Range of an Access Review Schedule Definition.", "properties": { "endDate": { "type": "string", "description": "The DateTime when the review is scheduled to end. Required if type is endDate" }, "numberOfOccurrences": { "type": "integer", "description": "The number of times to repeat the access review. Required and must be positive if type is numbered." }, "startDate": { "type": "string", "description": "The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:AccessReviewRecurrenceRangeType" } ], "description": "The recurrence range type. The possible values are: endDate, noEnd, numbered." } }, "type": "object" }, "azure-native:authorization:AccessReviewRecurrenceRangeResponse": { "description": "Recurrence Range of an Access Review Schedule Definition.", "properties": { "endDate": { "type": "string", "description": "The DateTime when the review is scheduled to end. Required if type is endDate" }, "numberOfOccurrences": { "type": "integer", "description": "The number of times to repeat the access review. Required and must be positive if type is numbered." }, "startDate": { "type": "string", "description": "The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create." }, "type": { "type": "string", "description": "The recurrence range type. The possible values are: endDate, noEnd, numbered." } }, "type": "object" }, "azure-native:authorization:AccessReviewRecurrenceRangeType": { "description": "The recurrence range type. The possible values are: endDate, noEnd, numbered.", "type": "string", "enum": [ { "name": "endDate", "description": "endDate", "value": "endDate" }, { "name": "noEnd", "description": "noEnd", "value": "noEnd" }, { "name": "numbered", "description": "numbered", "value": "numbered" } ] }, "azure-native:authorization:AccessReviewResult": { "description": "Represents a reviewer's decision for a given review", "type": "string", "enum": [ { "name": "Approve", "description": "Approve", "value": "Approve" }, { "name": "Deny", "description": "Deny", "value": "Deny" }, { "name": "NotReviewed", "description": "NotReviewed", "value": "NotReviewed" }, { "name": "DontKnow", "description": "DontKnow", "value": "DontKnow" }, { "name": "NotNotified", "description": "NotNotified", "value": "NotNotified" } ] }, "azure-native:authorization:AccessReviewReviewer": { "description": "Descriptor for what needs to be reviewed", "properties": { "principalId": { "type": "string", "description": "The id of the reviewer(user/servicePrincipal)" } }, "type": "object" }, "azure-native:authorization:AccessReviewReviewerResponse": { "description": "Descriptor for what needs to be reviewed", "properties": { "principalId": { "type": "string", "description": "The id of the reviewer(user/servicePrincipal)" }, "principalType": { "type": "string", "description": "The identity type : user/servicePrincipal" } }, "type": "object", "required": [ "principalType" ] }, "azure-native:authorization:AccessReviewScope": { "description": "Descriptor for what needs to be reviewed", "properties": { "excludeResourceId": { "type": "string", "description": "This is used to indicate the resource id(s) to exclude" }, "excludeRoleDefinitionId": { "type": "string", "description": "This is used to indicate the role definition id(s) to exclude" }, "expandNestedMemberships": { "type": "boolean", "description": "Flag to indicate whether to expand nested memberships or not." }, "inactiveDuration": { "type": "string", "description": "Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, "includeAccessBelowResource": { "type": "boolean", "description": "Flag to indicate whether to expand nested memberships or not." }, "includeInheritedAccess": { "type": "boolean", "description": "Flag to indicate whether to expand nested memberships or not." } }, "type": "object" }, "azure-native:authorization:AccessReviewScopeResponse": { "description": "Descriptor for what needs to be reviewed", "properties": { "assignmentState": { "type": "string", "description": "The role assignment state eligible/active to review" }, "excludeResourceId": { "type": "string", "description": "This is used to indicate the resource id(s) to exclude" }, "excludeRoleDefinitionId": { "type": "string", "description": "This is used to indicate the role definition id(s) to exclude" }, "expandNestedMemberships": { "type": "boolean", "description": "Flag to indicate whether to expand nested memberships or not." }, "inactiveDuration": { "type": "string", "description": "Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds))" }, "includeAccessBelowResource": { "type": "boolean", "description": "Flag to indicate whether to expand nested memberships or not." }, "includeInheritedAccess": { "type": "boolean", "description": "Flag to indicate whether to expand nested memberships or not." }, "principalType": { "type": "string", "description": "The identity type user/servicePrincipal to review" }, "resourceId": { "type": "string", "description": "ResourceId in which this review is getting created" }, "roleDefinitionId": { "type": "string", "description": "This is used to indicate the role being reviewed" } }, "type": "object", "required": [ "assignmentState", "principalType", "resourceId", "roleDefinitionId" ] }, "azure-native:authorization:ApprovalMode": { "description": "The type of rule", "type": "string", "enum": [ { "name": "SingleStage", "description": "SingleStage", "value": "SingleStage" }, { "name": "Serial", "description": "Serial", "value": "Serial" }, { "name": "Parallel", "description": "Parallel", "value": "Parallel" }, { "name": "NoApproval", "description": "NoApproval", "value": "NoApproval" } ] }, "azure-native:authorization:ApprovalSettings": { "description": "The approval settings.", "properties": { "approvalMode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:ApprovalMode" } ], "description": "The type of rule" }, "approvalStages": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:ApprovalStage" }, "description": "The approval stages of the request." }, "isApprovalRequired": { "type": "boolean", "description": "Determines whether approval is required or not." }, "isApprovalRequiredForExtension": { "type": "boolean", "description": "Determines whether approval is required for assignment extension." }, "isRequestorJustificationRequired": { "type": "boolean", "description": "Determine whether requestor justification is required." } }, "type": "object" }, "azure-native:authorization:ApprovalSettingsResponse": { "description": "The approval settings.", "properties": { "approvalMode": { "type": "string", "description": "The type of rule" }, "approvalStages": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:ApprovalStageResponse" }, "description": "The approval stages of the request." }, "isApprovalRequired": { "type": "boolean", "description": "Determines whether approval is required or not." }, "isApprovalRequiredForExtension": { "type": "boolean", "description": "Determines whether approval is required for assignment extension." }, "isRequestorJustificationRequired": { "type": "boolean", "description": "Determine whether requestor justification is required." } }, "type": "object" }, "azure-native:authorization:ApprovalStage": { "description": "The approval stage.", "properties": { "approvalStageTimeOutInDays": { "type": "integer", "description": "The time in days when approval request would be timed out" }, "escalationApprovers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UserSet" }, "description": "The escalation approver of the request." }, "escalationTimeInMinutes": { "type": "integer", "description": "The time in minutes when the approval request would be escalated if the primary approver does not approve" }, "isApproverJustificationRequired": { "type": "boolean", "description": "Determines whether approver need to provide justification for his decision." }, "isEscalationEnabled": { "type": "boolean", "description": "The value determine whether escalation feature is enabled." }, "primaryApprovers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UserSet" }, "description": "The primary approver of the request." } }, "type": "object" }, "azure-native:authorization:ApprovalStageResponse": { "description": "The approval stage.", "properties": { "approvalStageTimeOutInDays": { "type": "integer", "description": "The time in days when approval request would be timed out" }, "escalationApprovers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UserSetResponse" }, "description": "The escalation approver of the request." }, "escalationTimeInMinutes": { "type": "integer", "description": "The time in minutes when the approval request would be escalated if the primary approver does not approve" }, "isApproverJustificationRequired": { "type": "boolean", "description": "Determines whether approver need to provide justification for his decision." }, "isEscalationEnabled": { "type": "boolean", "description": "The value determine whether escalation feature is enabled." }, "primaryApprovers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UserSetResponse" }, "description": "The primary approver of the request." } }, "type": "object" }, "azure-native:authorization:AssignmentScopeValidation": { "description": "The option whether validate the exemption is at or under the assignment scope.", "type": "string", "enum": [ { "description": "This option will validate the exemption is at or under the assignment scope.", "value": "Default" }, { "description": "This option will bypass the validation the exemption scope is at or under the policy assignment scope.", "value": "DoNotValidate" } ] }, "azure-native:authorization:AssignmentType": { "description": "The type of policy assignment. Possible values are NotSpecified, System, SystemHidden, and Custom. Immutable.", "type": "string", "enum": [ { "value": "NotSpecified" }, { "value": "System" }, { "value": "SystemHidden" }, { "value": "Custom" } ] }, "azure-native:authorization:DefaultDecisionType": { "description": "This specifies the behavior for the autoReview feature when an access review completes.", "type": "string", "enum": [ { "name": "Approve", "description": "Approve", "value": "Approve" }, { "name": "Deny", "description": "Deny", "value": "Deny" }, { "name": "Recommendation", "description": "Recommendation", "value": "Recommendation" } ] }, "azure-native:authorization:DenyAssignmentEffect": { "description": "The effect of the deny assignment. 'enforced' blocks access, 'audit' logs without blocking.", "type": "string", "enum": [ { "name": "enforced", "description": "enforced", "value": "enforced" }, { "name": "audit", "description": "audit", "value": "audit" } ] }, "azure-native:authorization:DenyAssignmentPermission": { "description": "Deny assignment permissions.", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Actions to which the deny assignment does not grant access." }, "condition": { "type": "string", "description": "The conditions on the Deny assignment permission. This limits the resources it applies to." }, "conditionVersion": { "type": "string", "description": "Version of the condition." }, "dataActions": { "type": "array", "items": { "type": "string" }, "description": "Data actions to which the deny assignment does not grant access." }, "notActions": { "type": "array", "items": { "type": "string" }, "description": "Actions to exclude from that the deny assignment does not grant access." }, "notDataActions": { "type": "array", "items": { "type": "string" }, "description": "Data actions to exclude from that the deny assignment does not grant access." } }, "type": "object" }, "azure-native:authorization:DenyAssignmentPermissionResponse": { "description": "Deny assignment permissions.", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Actions to which the deny assignment does not grant access." }, "condition": { "type": "string", "description": "The conditions on the Deny assignment permission. This limits the resources it applies to." }, "conditionVersion": { "type": "string", "description": "Version of the condition." }, "dataActions": { "type": "array", "items": { "type": "string" }, "description": "Data actions to which the deny assignment does not grant access." }, "notActions": { "type": "array", "items": { "type": "string" }, "description": "Actions to exclude from that the deny assignment does not grant access." }, "notDataActions": { "type": "array", "items": { "type": "string" }, "description": "Data actions to exclude from that the deny assignment does not grant access." } }, "type": "object" }, "azure-native:authorization:DenyAssignmentPrincipal": { "description": "Deny assignment principal.", "properties": { "id": { "type": "string", "description": "The object ID of the principal." }, "type": { "type": "string", "description": "The type of the principal such as user, group, servicePrincipal, etc." } }, "type": "object" }, "azure-native:authorization:DenyAssignmentPrincipalResponse": { "description": "Deny assignment principal.", "properties": { "id": { "type": "string", "description": "The object ID of the principal." }, "type": { "type": "string", "description": "The type of the principal such as user, group, servicePrincipal, etc." } }, "type": "object" }, "azure-native:authorization:EnablementRules": { "description": "The type of enablement rule", "type": "string", "enum": [ { "name": "MultiFactorAuthentication", "description": "MultiFactorAuthentication", "value": "MultiFactorAuthentication" }, { "name": "Justification", "description": "Justification", "value": "Justification" }, { "name": "Ticketing", "description": "Ticketing", "value": "Ticketing" } ] }, "azure-native:authorization:EnforcementMode": { "description": "The policy assignment enforcement mode. Possible values are Default, DoNotEnforce, and Enroll", "type": "string", "enum": [ { "description": "The policy effect is enforced during resource creation or update.", "value": "Default" }, { "description": "The policy effect is not enforced during resource creation or update.", "value": "DoNotEnforce" }, { "description": "The policy effect is not enforced during resource creation or update until the resource or scope of the resource is enrolled to the assignment instance. Enrollment occurs upon deployment of the policy enrollment resource.", "value": "Enroll" } ] }, "azure-native:authorization:ExcludedPrincipalTypes": { "type": "string", "enum": [ { "name": "ServicePrincipalsAsTarget", "description": "ServicePrincipalsAsTarget", "value": "ServicePrincipalsAsTarget" }, { "name": "ServicePrincipalsAsRequestor", "description": "ServicePrincipalsAsRequestor", "value": "ServicePrincipalsAsRequestor" } ] }, "azure-native:authorization:ExemptionCategory": { "description": "The policy exemption category. Possible values are Waiver and Mitigated.", "type": "string", "enum": [ { "description": "This category of exemptions usually means the scope is not applicable for the policy.", "value": "Waiver" }, { "description": "This category of exemptions usually means the mitigation actions have been applied to the scope.", "value": "Mitigated" } ] }, "azure-native:authorization:ExpandedPropertiesResponse": { "description": "Expanded info of resource, role and principal", "properties": { "principal": { "type": "object", "$ref": "#/types/azure-native:authorization:ExpandedPropertiesResponsePrincipal", "description": "Details of the principal" }, "roleDefinition": { "type": "object", "$ref": "#/types/azure-native:authorization:ExpandedPropertiesResponseRoleDefinition", "description": "Details of role definition" }, "scope": { "type": "object", "$ref": "#/types/azure-native:authorization:ExpandedPropertiesResponseScope", "description": "Details of the resource scope" } }, "type": "object" }, "azure-native:authorization:ExpandedPropertiesResponsePrincipal": { "description": "Details of the principal", "properties": { "displayName": { "type": "string", "description": "Display name of the principal" }, "email": { "type": "string", "description": "Email id of the principal" }, "id": { "type": "string", "description": "Id of the principal" }, "type": { "type": "string", "description": "Type of the principal" } }, "type": "object" }, "azure-native:authorization:ExpandedPropertiesResponseRoleDefinition": { "description": "Details of role definition", "properties": { "displayName": { "type": "string", "description": "Display name of the role definition" }, "id": { "type": "string", "description": "Id of the role definition" }, "type": { "type": "string", "description": "Type of the role definition" } }, "type": "object" }, "azure-native:authorization:ExpandedPropertiesResponseScope": { "description": "Details of the resource scope", "properties": { "displayName": { "type": "string", "description": "Display name of the resource" }, "id": { "type": "string", "description": "Scope id of the resource" }, "type": { "type": "string", "description": "Type of the resource" } }, "type": "object" }, "azure-native:authorization:Identity": { "description": "Identity for the resource. Policy assignments support a maximum of one identity. That is either a system assigned identity or a single user assigned identity.", "properties": { "type": { "$ref": "#/types/azure-native:authorization:ResourceIdentityType", "description": "The identity type. This is the only required field when adding a system or user assigned identity to a resource." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The user identity associated with the policy. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object" }, "azure-native:authorization:IdentityResponse": { "description": "Identity for the resource. Policy assignments support a maximum of one identity. That is either a system assigned identity or a single user assigned identity.", "properties": { "principalId": { "type": "string", "description": "The principal ID of the resource identity. This property will only be provided for a system assigned identity" }, "tenantId": { "type": "string", "description": "The tenant ID of the resource identity. This property will only be provided for a system assigned identity" }, "type": { "type": "string", "description": "The identity type. This is the only required field when adding a system or user assigned identity to a resource." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:authorization:IdentityResponseUserAssignedIdentities" }, "description": "The user identity associated with the policy. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object", "required": [ "principalId", "tenantId" ] }, "azure-native:authorization:IdentityResponseUserAssignedIdentities": { "properties": { "clientId": { "type": "string", "description": "The client id of user assigned identity." }, "principalId": { "type": "string", "description": "The principal id of user assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:authorization:LockLevel": { "description": "The level of the lock. Possible values are: NotSpecified, CanNotDelete, ReadOnly. CanNotDelete means authorized users are able to read and modify the resources, but not delete. ReadOnly means authorized users can only read from a resource, but they can't modify or delete it.", "type": "string", "enum": [ { "value": "NotSpecified" }, { "value": "CanNotDelete" }, { "value": "ReadOnly" } ] }, "azure-native:authorization:ManagedByTenantResponse": { "description": "Information about a tenant managing the subscription.", "properties": { "tenantId": { "type": "string", "description": "The tenant ID of the managing tenant." } }, "type": "object" }, "azure-native:authorization:ManagementLockOwner": { "description": "Lock owner properties.", "properties": { "applicationId": { "type": "string", "description": "The application ID of the lock owner." } }, "type": "object" }, "azure-native:authorization:ManagementLockOwnerResponse": { "description": "Lock owner properties.", "properties": { "applicationId": { "type": "string", "description": "The application ID of the lock owner." } }, "type": "object" }, "azure-native:authorization:MicrosoftCommonPrincipalResponse": { "description": "The name of the entity last modified it", "properties": { "displayName": { "type": "string", "description": "The name of the principal made changes" }, "email": { "type": "string", "description": "Email of principal" }, "id": { "type": "string", "description": "The id of the principal made changes" }, "type": { "type": "string", "description": "Type of principal such as user , group etc" } }, "type": "object" }, "azure-native:authorization:NonComplianceMessage": { "description": "A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results.", "properties": { "message": { "type": "string", "description": "A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results." }, "policyDefinitionReferenceId": { "type": "string", "description": "The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment." } }, "type": "object", "required": [ "message" ] }, "azure-native:authorization:NonComplianceMessageResponse": { "description": "A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results.", "properties": { "message": { "type": "string", "description": "A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results." }, "policyDefinitionReferenceId": { "type": "string", "description": "The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment." } }, "type": "object", "required": [ "message" ] }, "azure-native:authorization:NotificationDeliveryMechanism": { "description": "The type of notification.", "type": "string", "enum": [ { "name": "Email", "description": "Email", "value": "Email" } ] }, "azure-native:authorization:NotificationLevel": { "description": "The notification level.", "type": "string", "enum": [ { "name": "None", "description": "None", "value": "None" }, { "name": "Critical", "description": "Critical", "value": "Critical" }, { "name": "All", "description": "All", "value": "All" } ] }, "azure-native:authorization:Override": { "description": "The policy property value override.", "properties": { "kind": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:OverrideKind" } ], "description": "The override kind." }, "selectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:Selector" }, "description": "The list of the selector expressions." }, "value": { "type": "string", "description": "The value to override the policy property." } }, "type": "object" }, "azure-native:authorization:OverrideKind": { "description": "The override kind.", "type": "string", "enum": [ { "description": "It will override the policy effect type.", "value": "policyEffect" }, { "description": "It will override the definition version property value of the policy assignment.", "value": "definitionVersion" } ] }, "azure-native:authorization:OverrideResponse": { "description": "The policy property value override.", "properties": { "kind": { "type": "string", "description": "The override kind." }, "selectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:SelectorResponse" }, "description": "The list of the selector expressions." }, "value": { "type": "string", "description": "The value to override the policy property." } }, "type": "object" }, "azure-native:authorization:PIMOnlyMode": { "description": "Determines whether the setting is enabled, disabled or report only.", "type": "string", "enum": [ { "name": "Disabled", "description": "Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "Enabled", "value": "Enabled" }, { "name": "ReportOnly", "description": "ReportOnly", "value": "ReportOnly" } ] }, "azure-native:authorization:PIMOnlyModeSettings": { "description": "The PIM Only Mode settings.", "properties": { "excludedAssignmentTypes": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:ExcludedPrincipalTypes" } ] }, "description": "The list of excluded assignment types allowed." }, "excludes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UsersOrServicePrincipalSet" }, "description": "The list of excluded entities that the rule does not apply to." }, "mode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:PIMOnlyMode" } ], "description": "Determines whether the setting is enabled, disabled or report only." } }, "type": "object" }, "azure-native:authorization:PIMOnlyModeSettingsResponse": { "description": "The PIM Only Mode settings.", "properties": { "excludedAssignmentTypes": { "type": "array", "items": { "type": "string" }, "description": "The list of excluded assignment types allowed." }, "excludes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UsersOrServicePrincipalSetResponse" }, "description": "The list of excluded entities that the rule does not apply to." }, "mode": { "type": "string", "description": "Determines whether the setting is enabled, disabled or report only." } }, "type": "object" }, "azure-native:authorization:ParameterDefinitionsValue": { "description": "The definition of a parameter that can be provided to the policy.", "properties": { "allowedValues": { "type": "array", "items": { "$ref": "pulumi.json#/Any" }, "description": "The allowed values for the parameter." }, "defaultValue": { "$ref": "pulumi.json#/Any", "description": "The default value for the parameter if no value is provided." }, "metadata": { "type": "object", "$ref": "#/types/azure-native:authorization:ParameterDefinitionsValueMetadata", "description": "General metadata for the parameter." }, "schema": { "$ref": "pulumi.json#/Any", "description": "Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:ParameterType" } ], "description": "The data type of the parameter." } }, "type": "object" }, "azure-native:authorization:ParameterDefinitionsValueMetadata": { "description": "General metadata for the parameter.", "properties": { "assignPermissions": { "type": "boolean", "description": "Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope." }, "description": { "type": "string", "description": "The description of the parameter." }, "displayName": { "type": "string", "description": "The display name for the parameter." }, "strongType": { "type": "string", "description": "Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from." } }, "type": "object" }, "azure-native:authorization:ParameterDefinitionsValueResponse": { "description": "The definition of a parameter that can be provided to the policy.", "properties": { "allowedValues": { "type": "array", "items": { "$ref": "pulumi.json#/Any" }, "description": "The allowed values for the parameter." }, "defaultValue": { "$ref": "pulumi.json#/Any", "description": "The default value for the parameter if no value is provided." }, "metadata": { "type": "object", "$ref": "#/types/azure-native:authorization:ParameterDefinitionsValueResponseMetadata", "description": "General metadata for the parameter." }, "schema": { "$ref": "pulumi.json#/Any", "description": "Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/." }, "type": { "type": "string", "description": "The data type of the parameter." } }, "type": "object" }, "azure-native:authorization:ParameterDefinitionsValueResponseMetadata": { "description": "General metadata for the parameter.", "properties": { "assignPermissions": { "type": "boolean", "description": "Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope." }, "description": { "type": "string", "description": "The description of the parameter." }, "displayName": { "type": "string", "description": "The display name for the parameter." }, "strongType": { "type": "string", "description": "Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from." } }, "type": "object" }, "azure-native:authorization:ParameterType": { "description": "The data type of the parameter.", "type": "string", "enum": [ { "value": "String" }, { "value": "Array" }, { "value": "Object" }, { "value": "Boolean" }, { "value": "Integer" }, { "value": "Float" }, { "value": "DateTime" } ] }, "azure-native:authorization:ParameterValuesValue": { "description": "The value of a parameter.", "properties": { "value": { "$ref": "pulumi.json#/Any", "description": "The value of the parameter." } }, "type": "object" }, "azure-native:authorization:ParameterValuesValueResponse": { "description": "The value of a parameter.", "properties": { "value": { "$ref": "pulumi.json#/Any", "description": "The value of the parameter." } }, "type": "object" }, "azure-native:authorization:Permission": { "description": "Role definition permissions.", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Allowed actions." }, "dataActions": { "type": "array", "items": { "type": "string" }, "description": "Allowed Data actions." }, "notActions": { "type": "array", "items": { "type": "string" }, "description": "Denied actions." }, "notDataActions": { "type": "array", "items": { "type": "string" }, "description": "Denied Data actions." } }, "type": "object" }, "azure-native:authorization:PermissionResponse": { "description": "Role definition permissions.", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Allowed actions." }, "condition": { "type": "string", "description": "The conditions on the role definition. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" }, "conditionVersion": { "type": "string", "description": "Version of the condition. Currently the only accepted value is '2.0'" }, "dataActions": { "type": "array", "items": { "type": "string" }, "description": "Allowed Data actions." }, "notActions": { "type": "array", "items": { "type": "string" }, "description": "Denied actions." }, "notDataActions": { "type": "array", "items": { "type": "string" }, "description": "Denied Data actions." } }, "type": "object", "required": [ "condition", "conditionVersion" ] }, "azure-native:authorization:PolicyAssignmentPropertiesPolicyResponse": { "description": "Details of the policy", "properties": { "id": { "type": "string", "description": "Id of the policy" }, "lastModifiedBy": { "type": "object", "$ref": "#/types/azure-native:authorization:MicrosoftCommonPrincipalResponse", "description": "The name of the entity last modified it" }, "lastModifiedDateTime": { "type": "string", "description": "The last modified date time." } }, "type": "object", "required": [ "lastModifiedBy" ] }, "azure-native:authorization:PolicyAssignmentPropertiesResponse": { "description": "Expanded info of resource scope, role definition and policy", "properties": { "policy": { "type": "object", "$ref": "#/types/azure-native:authorization:PolicyAssignmentPropertiesPolicyResponse", "description": "Details of the policy" }, "roleDefinition": { "type": "object", "$ref": "#/types/azure-native:authorization:PolicyAssignmentPropertiesRoleDefinitionResponse", "description": "Details of role definition" }, "scope": { "type": "object", "$ref": "#/types/azure-native:authorization:PolicyAssignmentPropertiesScopeResponse", "description": "Details of the resource scope" } }, "type": "object" }, "azure-native:authorization:PolicyAssignmentPropertiesRoleDefinitionResponse": { "description": "Details of role definition", "properties": { "displayName": { "type": "string", "description": "Display name of the role definition" }, "id": { "type": "string", "description": "Id of the role definition" }, "type": { "type": "string", "description": "Type of the role definition" } }, "type": "object" }, "azure-native:authorization:PolicyAssignmentPropertiesScopeResponse": { "description": "Details of the resource scope", "properties": { "displayName": { "type": "string", "description": "Display name of the resource" }, "id": { "type": "string", "description": "Scope id of the resource" }, "type": { "type": "string", "description": "Type of the resource" } }, "type": "object" }, "azure-native:authorization:PolicyDefinitionGroup": { "description": "The policy definition group.", "properties": { "additionalMetadataId": { "type": "string", "description": "A resource ID of a resource that contains additional metadata about the group." }, "category": { "type": "string", "description": "The group's category." }, "description": { "type": "string", "description": "The group's description." }, "displayName": { "type": "string", "description": "The group's display name." }, "name": { "type": "string", "description": "The name of the group." } }, "type": "object", "required": [ "name" ] }, "azure-native:authorization:PolicyDefinitionGroupResponse": { "description": "The policy definition group.", "properties": { "additionalMetadataId": { "type": "string", "description": "A resource ID of a resource that contains additional metadata about the group." }, "category": { "type": "string", "description": "The group's category." }, "description": { "type": "string", "description": "The group's description." }, "displayName": { "type": "string", "description": "The group's display name." }, "name": { "type": "string", "description": "The name of the group." } }, "type": "object", "required": [ "name" ] }, "azure-native:authorization:PolicyDefinitionReference": { "description": "The policy definition reference.", "properties": { "definitionVersion": { "type": "string", "description": "The version of the policy definition to use." }, "groupNames": { "type": "array", "items": { "type": "string" }, "description": "The name of the groups that this policy definition reference belongs to." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:authorization:ParameterValuesValue" }, "description": "The parameter values for the referenced policy rule. The keys are the parameter names." }, "policyDefinitionId": { "type": "string", "description": "The ID of the policy definition or policy set definition." }, "policyDefinitionReferenceId": { "type": "string", "description": "A unique id (within the policy set definition) for this policy definition reference." } }, "type": "object", "required": [ "policyDefinitionId" ] }, "azure-native:authorization:PolicyDefinitionReferenceResponse": { "description": "The policy definition reference.", "properties": { "definitionVersion": { "type": "string", "description": "The version of the policy definition to use." }, "effectiveDefinitionVersion": { "type": "string", "description": "The effective version of the policy definition in use. This is only present if requested via the $expand query parameter." }, "groupNames": { "type": "array", "items": { "type": "string" }, "description": "The name of the groups that this policy definition reference belongs to." }, "latestDefinitionVersion": { "type": "string", "description": "The latest version of the policy definition available. This is only present if requested via the $expand query parameter." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:authorization:ParameterValuesValueResponse" }, "description": "The parameter values for the referenced policy rule. The keys are the parameter names." }, "policyDefinitionId": { "type": "string", "description": "The ID of the policy definition or policy set definition." }, "policyDefinitionReferenceId": { "type": "string", "description": "A unique id (within the policy set definition) for this policy definition reference." } }, "type": "object", "required": [ "effectiveDefinitionVersion", "latestDefinitionVersion", "policyDefinitionId" ] }, "azure-native:authorization:PolicyDefinitionVersionResponse": { "description": "The ID of the policy definition version.", "properties": { "description": { "type": "string", "description": "The policy definition description." }, "displayName": { "type": "string", "description": "The display name of the policy definition." }, "id": { "type": "string", "description": "The ID of the policy definition version." }, "metadata": { "$ref": "pulumi.json#/Any", "description": "The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs." }, "mode": { "type": "string", "description": "The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data.", "default": "Indexed" }, "name": { "type": "string", "description": "The name of the policy definition version." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:authorization:ParameterDefinitionsValueResponse" }, "description": "The parameter definitions for parameters used in the policy rule. The keys are the parameter names." }, "policyRule": { "$ref": "pulumi.json#/Any", "description": "The policy rule." }, "policyType": { "type": "string", "description": "The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:authorization:SystemDataResponse", "description": "The system metadata relating to this resource." }, "type": { "type": "string", "description": "The type of the resource (Microsoft.Authorization/policyDefinitions/versions)." }, "version": { "type": "string", "description": "The policy definition version in #.#.# format." } }, "type": "object", "required": [ "id", "name", "systemData", "type" ] }, "azure-native:authorization:PolicyPropertiesResponse": { "description": "Expanded info of resource scope", "properties": { "scope": { "type": "object", "$ref": "#/types/azure-native:authorization:PolicyPropertiesScopeResponse", "description": "Details of the resource scope" } }, "type": "object", "required": [ "scope" ] }, "azure-native:authorization:PolicyPropertiesScopeResponse": { "description": "Details of the resource scope", "properties": { "displayName": { "type": "string", "description": "Display name of the resource" }, "id": { "type": "string", "description": "Scope id of the resource" }, "type": { "type": "string", "description": "Type of the resource" } }, "type": "object" }, "azure-native:authorization:PolicySetDefinitionVersionResponse": { "description": "The policy set definition version.", "properties": { "description": { "type": "string", "description": "The policy set definition description." }, "displayName": { "type": "string", "description": "The display name of the policy set definition." }, "id": { "type": "string", "description": "The ID of the policy set definition version." }, "metadata": { "$ref": "pulumi.json#/Any", "description": "The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs." }, "name": { "type": "string", "description": "The name of the policy set definition version." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:authorization:ParameterDefinitionsValueResponse" }, "description": "The policy set definition parameters that can be used in policy definition references." }, "policyDefinitionGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:PolicyDefinitionGroupResponse" }, "description": "The metadata describing groups of policy definition references within the policy set definition." }, "policyDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:PolicyDefinitionReferenceResponse" }, "description": "An array of policy definition references." }, "policyType": { "type": "string", "description": "The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:authorization:SystemDataResponse", "description": "The system metadata relating to this resource." }, "type": { "type": "string", "description": "The type of the resource (Microsoft.Authorization/policySetDefinitions/versions)." }, "version": { "type": "string", "description": "The policy set definition version in #.#.# format." } }, "type": "object", "required": [ "id", "name", "policyDefinitions", "systemData", "type" ] }, "azure-native:authorization:PolicyType": { "description": "The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static.", "type": "string", "enum": [ { "value": "NotSpecified" }, { "value": "BuiltIn" }, { "value": "Custom" }, { "value": "Static" } ] }, "azure-native:authorization:PolicyVariableColumn": { "description": "The variable column.", "properties": { "columnName": { "type": "string", "description": "The name of this policy variable column." } }, "type": "object", "required": [ "columnName" ] }, "azure-native:authorization:PolicyVariableColumnResponse": { "description": "The variable column.", "properties": { "columnName": { "type": "string", "description": "The name of this policy variable column." } }, "type": "object", "required": [ "columnName" ] }, "azure-native:authorization:PolicyVariableValueColumnValue": { "description": "The name value tuple for this variable value column.", "properties": { "columnName": { "type": "string", "description": "Column name for the variable value" }, "columnValue": { "$ref": "pulumi.json#/Any", "description": "Column value for the variable value; this can be an integer, double, boolean, null or a string." } }, "type": "object", "required": [ "columnName", "columnValue" ] }, "azure-native:authorization:PolicyVariableValueColumnValueResponse": { "description": "The name value tuple for this variable value column.", "properties": { "columnName": { "type": "string", "description": "Column name for the variable value" }, "columnValue": { "$ref": "pulumi.json#/Any", "description": "Column value for the variable value; this can be an integer, double, boolean, null or a string." } }, "type": "object", "required": [ "columnName", "columnValue" ] }, "azure-native:authorization:PrincipalType": { "description": "The principal type of the assigned principal ID.", "type": "string", "enum": [ { "name": "User", "description": "User", "value": "User" }, { "name": "Group", "description": "Group", "value": "Group" }, { "name": "ServicePrincipal", "description": "ServicePrincipal", "value": "ServicePrincipal" }, { "name": "ForeignGroup", "description": "ForeignGroup", "value": "ForeignGroup" }, { "name": "Device", "description": "Device", "value": "Device" } ] }, "azure-native:authorization:PrivateLinkAssociationProperties": { "properties": { "privateLink": { "type": "string", "description": "The rmpl Resource ID." }, "publicNetworkAccess": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:PublicNetworkAccessOptions" } ] } }, "type": "object" }, "azure-native:authorization:PrivateLinkAssociationPropertiesExpandedResponse": { "description": "Private Link Association Properties.", "properties": { "privateLink": { "type": "string", "description": "The rmpl Resource ID." }, "publicNetworkAccess": { "type": "string" }, "scope": { "type": "string", "description": "The scope of the private link association." }, "tenantID": { "type": "string", "description": "The TenantID." } }, "type": "object" }, "azure-native:authorization:PublicNetworkAccessOptions": { "type": "string", "enum": [ { "value": "Enabled" }, { "value": "Disabled" } ] }, "azure-native:authorization:RecipientType": { "description": "The recipient type.", "type": "string", "enum": [ { "name": "Requestor", "description": "Requestor", "value": "Requestor" }, { "name": "Approver", "description": "Approver", "value": "Approver" }, { "name": "Admin", "description": "Admin", "value": "Admin" } ] }, "azure-native:authorization:RequestType": { "description": "The type of the role assignment schedule request. Eg: SelfActivate, AdminAssign etc", "type": "string", "enum": [ { "value": "AdminAssign" }, { "value": "AdminRemove" }, { "value": "AdminUpdate" }, { "value": "AdminExtend" }, { "value": "AdminRenew" }, { "value": "SelfActivate" }, { "value": "SelfDeactivate" }, { "value": "SelfExtend" }, { "value": "SelfRenew" } ] }, "azure-native:authorization:ResourceIdentityType": { "description": "The identity type. This is the only required field when adding a system or user assigned identity to a resource.", "type": "string", "enum": [ { "description": "Indicates that a system assigned identity is associated with the resource.", "value": "SystemAssigned" }, { "description": "Indicates that a system assigned identity is associated with the resource.", "value": "UserAssigned" }, { "description": "Indicates that no identity is associated with the resource or that the existing identity should be removed.", "value": "None" } ] }, "azure-native:authorization:ResourceManagementPrivateLinkEndpointConnectionsResponse": { "properties": { "privateEndpointConnections": { "type": "array", "items": { "type": "string" }, "description": "The private endpoint connections." } }, "type": "object" }, "azure-native:authorization:ResourceSelector": { "description": "The resource selector to filter policies by resource properties.", "properties": { "name": { "type": "string", "description": "The name of the resource selector." }, "selectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:Selector" }, "description": "The list of the selector expressions." } }, "type": "object" }, "azure-native:authorization:ResourceSelectorResponse": { "description": "The resource selector to filter policies by resource properties.", "properties": { "name": { "type": "string", "description": "The name of the resource selector." }, "selectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:SelectorResponse" }, "description": "The list of the selector expressions." } }, "type": "object" }, "azure-native:authorization:RoleEligibilityScheduleRequestPropertiesExpiration": { "description": "Expiration of the role eligibility schedule", "properties": { "duration": { "type": "string", "description": "Duration of the role eligibility schedule in TimeSpan." }, "endDateTime": { "type": "string", "description": "End DateTime of the role eligibility schedule." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:Type" } ], "description": "Type of the role eligibility schedule expiration" } }, "type": "object" }, "azure-native:authorization:RoleEligibilityScheduleRequestPropertiesResponseExpiration": { "description": "Expiration of the role eligibility schedule", "properties": { "duration": { "type": "string", "description": "Duration of the role eligibility schedule in TimeSpan." }, "endDateTime": { "type": "string", "description": "End DateTime of the role eligibility schedule." }, "type": { "type": "string", "description": "Type of the role eligibility schedule expiration" } }, "type": "object" }, "azure-native:authorization:RoleEligibilityScheduleRequestPropertiesResponseScheduleInfo": { "description": "Schedule info of the role eligibility schedule", "properties": { "expiration": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleEligibilityScheduleRequestPropertiesResponseExpiration", "description": "Expiration of the role eligibility schedule" }, "startDateTime": { "type": "string", "description": "Start DateTime of the role eligibility schedule." } }, "type": "object" }, "azure-native:authorization:RoleEligibilityScheduleRequestPropertiesResponseTicketInfo": { "description": "Ticket Info of the role eligibility", "properties": { "ticketNumber": { "type": "string", "description": "Ticket number for the role eligibility" }, "ticketSystem": { "type": "string", "description": "Ticket system name for the role eligibility" } }, "type": "object" }, "azure-native:authorization:RoleEligibilityScheduleRequestPropertiesScheduleInfo": { "description": "Schedule info of the role eligibility schedule", "properties": { "expiration": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleEligibilityScheduleRequestPropertiesExpiration", "description": "Expiration of the role eligibility schedule" }, "startDateTime": { "type": "string", "description": "Start DateTime of the role eligibility schedule." } }, "type": "object" }, "azure-native:authorization:RoleEligibilityScheduleRequestPropertiesTicketInfo": { "description": "Ticket Info of the role eligibility", "properties": { "ticketNumber": { "type": "string", "description": "Ticket number for the role eligibility" }, "ticketSystem": { "type": "string", "description": "Ticket system name for the role eligibility" } }, "type": "object" }, "azure-native:authorization:RoleManagementPolicyApprovalRule": { "description": "The role management policy approval rule.", "properties": { "id": { "type": "string", "description": "The id of the rule." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyApprovalRule'.", "const": "RoleManagementPolicyApprovalRule" }, "setting": { "type": "object", "$ref": "#/types/azure-native:authorization:ApprovalSettings", "description": "The approval setting" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTarget", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyApprovalRuleResponse": { "description": "The role management policy approval rule.", "properties": { "id": { "type": "string", "description": "The id of the rule." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyApprovalRule'.", "const": "RoleManagementPolicyApprovalRule" }, "setting": { "type": "object", "$ref": "#/types/azure-native:authorization:ApprovalSettingsResponse", "description": "The approval setting" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTargetResponse", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyAuthenticationContextRule": { "description": "The role management policy authentication context rule.", "properties": { "claimValue": { "type": "string", "description": "The claim value." }, "id": { "type": "string", "description": "The id of the rule." }, "isEnabled": { "type": "boolean", "description": "The value indicating if rule is enabled." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyAuthenticationContextRule'.", "const": "RoleManagementPolicyAuthenticationContextRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTarget", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyAuthenticationContextRuleResponse": { "description": "The role management policy authentication context rule.", "properties": { "claimValue": { "type": "string", "description": "The claim value." }, "id": { "type": "string", "description": "The id of the rule." }, "isEnabled": { "type": "boolean", "description": "The value indicating if rule is enabled." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyAuthenticationContextRule'.", "const": "RoleManagementPolicyAuthenticationContextRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTargetResponse", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyEnablementRule": { "description": "The role management policy enablement rule.", "properties": { "enabledRules": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:EnablementRules" } ] }, "description": "The list of enabled rules." }, "id": { "type": "string", "description": "The id of the rule." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyEnablementRule'.", "const": "RoleManagementPolicyEnablementRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTarget", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyEnablementRuleResponse": { "description": "The role management policy enablement rule.", "properties": { "enabledRules": { "type": "array", "items": { "type": "string" }, "description": "The list of enabled rules." }, "id": { "type": "string", "description": "The id of the rule." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyEnablementRule'.", "const": "RoleManagementPolicyEnablementRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTargetResponse", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyExpirationRule": { "description": "The role management policy expiration rule.", "properties": { "exceptionMembers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UserSet" }, "description": "The members not restricted by expiration rule." }, "id": { "type": "string", "description": "The id of the rule." }, "isExpirationRequired": { "type": "boolean", "description": "The value indicating whether expiration is required." }, "maximumDuration": { "type": "string", "description": "The maximum duration of expiration in timespan." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyExpirationRule'.", "const": "RoleManagementPolicyExpirationRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTarget", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyExpirationRuleResponse": { "description": "The role management policy expiration rule.", "properties": { "exceptionMembers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:authorization:UserSetResponse" }, "description": "The members not restricted by expiration rule." }, "id": { "type": "string", "description": "The id of the rule." }, "isExpirationRequired": { "type": "boolean", "description": "The value indicating whether expiration is required." }, "maximumDuration": { "type": "string", "description": "The maximum duration of expiration in timespan." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyExpirationRule'.", "const": "RoleManagementPolicyExpirationRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTargetResponse", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyNotificationRule": { "description": "The role management policy notification rule.", "properties": { "id": { "type": "string", "description": "The id of the rule." }, "isDefaultRecipientsEnabled": { "type": "boolean", "description": "Determines if the notification will be sent to the recipient type specified in the policy rule." }, "notificationLevel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:NotificationLevel" } ], "description": "The notification level." }, "notificationRecipients": { "type": "array", "items": { "type": "string" }, "description": "The list of notification recipients." }, "notificationType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:NotificationDeliveryMechanism" } ], "description": "The type of notification." }, "recipientType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:RecipientType" } ], "description": "The recipient type." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyNotificationRule'.", "const": "RoleManagementPolicyNotificationRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTarget", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyNotificationRuleResponse": { "description": "The role management policy notification rule.", "properties": { "id": { "type": "string", "description": "The id of the rule." }, "isDefaultRecipientsEnabled": { "type": "boolean", "description": "Determines if the notification will be sent to the recipient type specified in the policy rule." }, "notificationLevel": { "type": "string", "description": "The notification level." }, "notificationRecipients": { "type": "array", "items": { "type": "string" }, "description": "The list of notification recipients." }, "notificationType": { "type": "string", "description": "The type of notification." }, "recipientType": { "type": "string", "description": "The recipient type." }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyNotificationRule'.", "const": "RoleManagementPolicyNotificationRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTargetResponse", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyPimOnlyModeRule": { "description": "The role management policy PIM only mode rule.", "properties": { "id": { "type": "string", "description": "The id of the rule." }, "pimOnlyModeSettings": { "type": "object", "$ref": "#/types/azure-native:authorization:PIMOnlyModeSettings", "description": "The PIM Only Mode settings" }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyPimOnlyModeRule'.", "const": "RoleManagementPolicyPimOnlyModeRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTarget", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyPimOnlyModeRuleResponse": { "description": "The role management policy PIM only mode rule.", "properties": { "id": { "type": "string", "description": "The id of the rule." }, "pimOnlyModeSettings": { "type": "object", "$ref": "#/types/azure-native:authorization:PIMOnlyModeSettingsResponse", "description": "The PIM Only Mode settings" }, "ruleType": { "type": "string", "description": "The type of rule\nExpected value is 'RoleManagementPolicyPimOnlyModeRule'.", "const": "RoleManagementPolicyPimOnlyModeRule" }, "target": { "type": "object", "$ref": "#/types/azure-native:authorization:RoleManagementPolicyRuleTargetResponse", "description": "The target of the current rule." } }, "type": "object", "required": [ "ruleType" ] }, "azure-native:authorization:RoleManagementPolicyRuleTarget": { "description": "The role management policy rule target.", "properties": { "caller": { "type": "string", "description": "The caller of the setting." }, "enforcedSettings": { "type": "array", "items": { "type": "string" }, "description": "The list of enforced settings." }, "inheritableSettings": { "type": "array", "items": { "type": "string" }, "description": "The list of inheritable settings." }, "level": { "type": "string", "description": "The assignment level to which rule is applied." }, "operations": { "type": "array", "items": { "type": "string" }, "description": "The type of operation." }, "targetObjects": { "type": "array", "items": { "type": "string" }, "description": "The list of target objects." } }, "type": "object" }, "azure-native:authorization:RoleManagementPolicyRuleTargetResponse": { "description": "The role management policy rule target.", "properties": { "caller": { "type": "string", "description": "The caller of the setting." }, "enforcedSettings": { "type": "array", "items": { "type": "string" }, "description": "The list of enforced settings." }, "inheritableSettings": { "type": "array", "items": { "type": "string" }, "description": "The list of inheritable settings." }, "level": { "type": "string", "description": "The assignment level to which rule is applied." }, "operations": { "type": "array", "items": { "type": "string" }, "description": "The type of operation." }, "targetObjects": { "type": "array", "items": { "type": "string" }, "description": "The list of target objects." } }, "type": "object" }, "azure-native:authorization:RoleManagementPolicyRuleType": { "description": "The type of rule", "type": "string", "enum": [ { "name": "RoleManagementPolicyApprovalRule", "description": "RoleManagementPolicyApprovalRule", "value": "RoleManagementPolicyApprovalRule" }, { "name": "RoleManagementPolicyAuthenticationContextRule", "description": "RoleManagementPolicyAuthenticationContextRule", "value": "RoleManagementPolicyAuthenticationContextRule" }, { "name": "RoleManagementPolicyEnablementRule", "description": "RoleManagementPolicyEnablementRule", "value": "RoleManagementPolicyEnablementRule" }, { "name": "RoleManagementPolicyExpirationRule", "description": "RoleManagementPolicyExpirationRule", "value": "RoleManagementPolicyExpirationRule" }, { "name": "RoleManagementPolicyNotificationRule", "description": "RoleManagementPolicyNotificationRule", "value": "RoleManagementPolicyNotificationRule" }, { "name": "RoleManagementPolicyPimOnlyModeRule", "description": "RoleManagementPolicyPimOnlyModeRule", "value": "RoleManagementPolicyPimOnlyModeRule" } ] }, "azure-native:authorization:Selector": { "description": "The selector expression.", "properties": { "in": { "type": "array", "items": { "type": "string" }, "description": "The list of values to filter in." }, "kind": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:SelectorKind" } ], "description": "The selector kind." }, "notIn": { "type": "array", "items": { "type": "string" }, "description": "The list of values to filter out." } }, "type": "object" }, "azure-native:authorization:SelectorKind": { "description": "The selector kind.", "type": "string", "enum": [ { "description": "The selector kind to filter policies by the resource location.", "value": "resourceLocation" }, { "description": "The selector kind to filter policies by the resource type.", "value": "resourceType" }, { "description": "The selector kind to filter policies by the resource without location.", "value": "resourceWithoutLocation" }, { "description": "The selector kind to filter policies by the policy definition reference ID.", "value": "policyDefinitionReferenceId" } ] }, "azure-native:authorization:SelectorResponse": { "description": "The selector expression.", "properties": { "in": { "type": "array", "items": { "type": "string" }, "description": "The list of values to filter in." }, "kind": { "type": "string", "description": "The selector kind." }, "notIn": { "type": "array", "items": { "type": "string" }, "description": "The list of values to filter out." } }, "type": "object" }, "azure-native:authorization:SubscriptionPoliciesResponse": { "description": "Subscription policies.", "properties": { "locationPlacementId": { "type": "string", "description": "The subscription location placement ID." }, "quotaId": { "type": "string", "description": "The subscription quota ID." }, "spendingLimit": { "type": "string", "description": "The subscription spending limit." } }, "type": "object" }, "azure-native:authorization:SubscriptionResponse": { "description": "Subscription information.", "properties": { "authorizationSource": { "type": "string", "description": "The authorization source of the request." }, "displayName": { "type": "string", "description": "The subscription display name." }, "id": { "type": "string", "description": "The fully qualified ID for the subscription." }, "managedByTenants": { "type": "array", "items": { "$ref": "#/types/azure-native:authorization:ManagedByTenantResponse" }, "description": "An array containing the tenants managing the subscription." }, "state": { "type": "string", "description": "The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted." }, "subscriptionId": { "type": "string", "description": "The subscription ID." }, "subscriptionPolicies": { "$ref": "#/types/azure-native:authorization:SubscriptionPoliciesResponse", "description": "The subscription policies." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The tags attached to the subscription." }, "tenantId": { "type": "string", "description": "The subscription tenant ID." } }, "type": "object" }, "azure-native:authorization:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:authorization:Type": { "description": "Type of the role eligibility schedule expiration", "type": "string", "enum": [ { "value": "AfterDuration" }, { "value": "AfterDateTime" }, { "value": "NoExpiration" } ] }, "azure-native:authorization:UserSet": { "description": "The detail of a user.", "properties": { "description": { "type": "string", "description": "The description of the user." }, "id": { "type": "string", "description": "The object id of the user." }, "isBackup": { "type": "boolean", "description": "The value indicating whether the user is a backup fallback approver" }, "userType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:UserType" } ], "description": "The type of user." } }, "type": "object" }, "azure-native:authorization:UserSetResponse": { "description": "The detail of a user.", "properties": { "description": { "type": "string", "description": "The description of the user." }, "id": { "type": "string", "description": "The object id of the user." }, "isBackup": { "type": "boolean", "description": "The value indicating whether the user is a backup fallback approver" }, "userType": { "type": "string", "description": "The type of user." } }, "type": "object" }, "azure-native:authorization:UserType": { "description": "The type of user.", "type": "string", "enum": [ { "name": "User", "description": "User", "value": "User" }, { "name": "Group", "description": "Group", "value": "Group" } ] }, "azure-native:authorization:UsersOrServicePrincipalSet": { "description": "The detail of a subject.", "properties": { "displayName": { "type": "string", "description": "The display Name of the entity." }, "id": { "type": "string", "description": "The object id of the entity." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:authorization:UsersOrServicePrincipalSetUserType" } ], "description": "The type of user." } }, "type": "object" }, "azure-native:authorization:UsersOrServicePrincipalSetResponse": { "description": "The detail of a subject.", "properties": { "displayName": { "type": "string", "description": "The display Name of the entity." }, "id": { "type": "string", "description": "The object id of the entity." }, "type": { "type": "string", "description": "The type of user." } }, "type": "object" }, "azure-native:authorization:UsersOrServicePrincipalSetUserType": { "description": "The type of user.", "type": "string", "enum": [ { "name": "User", "description": "User", "value": "User" }, { "name": "Group", "description": "Group", "value": "Group" }, { "name": "ServicePrincipal", "description": "ServicePrincipal", "value": "ServicePrincipal" } ] }, "azure-native:automanage:ConfigurationProfileAssignmentProperties": { "description": "Automanage configuration profile assignment properties.", "properties": { "configurationProfile": { "type": "string", "description": "The Automanage configurationProfile ARM Resource URI." } }, "type": "object" }, "azure-native:automanage:ConfigurationProfileAssignmentPropertiesResponse": { "description": "Automanage configuration profile assignment properties.", "properties": { "configurationProfile": { "type": "string", "description": "The Automanage configurationProfile ARM Resource URI." }, "status": { "type": "string", "description": "The status of onboarding, which only appears in the response." }, "targetId": { "type": "string", "description": "The target VM resource URI" } }, "type": "object", "required": [ "status", "targetId" ] }, "azure-native:automanage:ConfigurationProfileProperties": { "description": "Automanage configuration profile properties.", "properties": { "configuration": { "$ref": "pulumi.json#/Any", "description": "configuration dictionary of the configuration profile." } }, "type": "object" }, "azure-native:automanage:ConfigurationProfilePropertiesResponse": { "description": "Automanage configuration profile properties.", "properties": { "configuration": { "$ref": "pulumi.json#/Any", "description": "configuration dictionary of the configuration profile." } }, "type": "object" }, "azure-native:automanage:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:automation:AdvancedSchedule": { "description": "The properties of the create Advanced Schedule.", "properties": { "monthDays": { "type": "array", "items": { "type": "integer" }, "description": "Days of the month that the job should execute on. Must be between 1 and 31." }, "monthlyOccurrences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:automation:AdvancedScheduleMonthlyOccurrence" }, "description": "Occurrences of days within a month." }, "weekDays": { "type": "array", "items": { "type": "string" }, "description": "Days of the week that the job should execute on." } }, "type": "object" }, "azure-native:automation:AdvancedScheduleMonthlyOccurrence": { "description": "The properties of the create advanced schedule monthly occurrence.", "properties": { "day": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:ScheduleDay" } ], "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday." }, "occurrence": { "type": "integer", "description": "Occurrence of the week within the month. Must be between 1 and 5" } }, "type": "object" }, "azure-native:automation:AdvancedScheduleMonthlyOccurrenceResponse": { "description": "The properties of the create advanced schedule monthly occurrence.", "properties": { "day": { "type": "string", "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday." }, "occurrence": { "type": "integer", "description": "Occurrence of the week within the month. Must be between 1 and 5" } }, "type": "object" }, "azure-native:automation:AdvancedScheduleResponse": { "description": "The properties of the create Advanced Schedule.", "properties": { "monthDays": { "type": "array", "items": { "type": "integer" }, "description": "Days of the month that the job should execute on. Must be between 1 and 31." }, "monthlyOccurrences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:automation:AdvancedScheduleMonthlyOccurrenceResponse" }, "description": "Occurrences of days within a month." }, "weekDays": { "type": "array", "items": { "type": "string" }, "description": "Days of the week that the job should execute on." } }, "type": "object" }, "azure-native:automation:AutomationErrorResponse": { "description": "Error response of an operation failure", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message indicating why the operation failed." } }, "type": "object" }, "azure-native:automation:AutomationErrorResponseResponse": { "description": "Error response of an operation failure", "properties": { "code": { "type": "string", "description": "Error code" }, "message": { "type": "string", "description": "Error message indicating why the operation failed." } }, "type": "object" }, "azure-native:automation:AzureQueryProperties": { "description": "Azure query for the update configuration.", "properties": { "locations": { "type": "array", "items": { "type": "string" }, "description": "List of locations to scope the query to." }, "scope": { "type": "array", "items": { "type": "string" }, "description": "List of Subscription or Resource Group ARM Ids." }, "tagSettings": { "type": "object", "$ref": "#/types/azure-native:automation:TagSettingsProperties", "description": "Tag settings for the VM." } }, "type": "object" }, "azure-native:automation:AzureQueryPropertiesResponse": { "description": "Azure query for the update configuration.", "properties": { "locations": { "type": "array", "items": { "type": "string" }, "description": "List of locations to scope the query to." }, "scope": { "type": "array", "items": { "type": "string" }, "description": "List of Subscription or Resource Group ARM Ids." }, "tagSettings": { "type": "object", "$ref": "#/types/azure-native:automation:TagSettingsPropertiesResponse", "description": "Tag settings for the VM." } }, "type": "object" }, "azure-native:automation:ConnectionTypeAssociationProperty": { "description": "The connection type property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the connection type." } }, "type": "object" }, "azure-native:automation:ConnectionTypeAssociationPropertyResponse": { "description": "The connection type property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the connection type." } }, "type": "object" }, "azure-native:automation:ContentHash": { "description": "Definition of the runbook property type.", "properties": { "algorithm": { "type": "string", "description": "Gets or sets the content hash algorithm used to hash the content." }, "value": { "type": "string", "description": "Gets or sets expected hash value of the content." } }, "type": "object", "required": [ "algorithm", "value" ] }, "azure-native:automation:ContentHashResponse": { "description": "Definition of the runbook property type.", "properties": { "algorithm": { "type": "string", "description": "Gets or sets the content hash algorithm used to hash the content." }, "value": { "type": "string", "description": "Gets or sets expected hash value of the content." } }, "type": "object", "required": [ "algorithm", "value" ] }, "azure-native:automation:ContentLink": { "description": "Definition of the content link.", "properties": { "contentHash": { "type": "object", "$ref": "#/types/azure-native:automation:ContentHash", "description": "Gets or sets the hash." }, "uri": { "type": "string", "description": "Gets or sets the uri of content." }, "version": { "type": "string", "description": "Gets or sets the version of the content." } }, "type": "object" }, "azure-native:automation:ContentLinkResponse": { "description": "Definition of the content link.", "properties": { "contentHash": { "type": "object", "$ref": "#/types/azure-native:automation:ContentHashResponse", "description": "Gets or sets the hash." }, "uri": { "type": "string", "description": "Gets or sets the uri of content." }, "version": { "type": "string", "description": "Gets or sets the version of the content." } }, "type": "object" }, "azure-native:automation:ContentSource": { "description": "Definition of the content source.", "properties": { "hash": { "type": "object", "$ref": "#/types/azure-native:automation:ContentHash", "description": "Gets or sets the hash." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:ContentSourceType" } ], "description": "Gets or sets the content source type." }, "value": { "type": "string", "description": "Gets or sets the value of the content. This is based on the content source type." }, "version": { "type": "string", "description": "Gets or sets the version of the content." } }, "type": "object" }, "azure-native:automation:ContentSourceResponse": { "description": "Definition of the content source.", "properties": { "hash": { "type": "object", "$ref": "#/types/azure-native:automation:ContentHashResponse", "description": "Gets or sets the hash." }, "type": { "type": "string", "description": "Gets or sets the content source type." }, "value": { "type": "string", "description": "Gets or sets the value of the content. This is based on the content source type." }, "version": { "type": "string", "description": "Gets or sets the version of the content." } }, "type": "object" }, "azure-native:automation:ContentSourceType": { "description": "Gets or sets the content source type.", "type": "string", "enum": [ { "name": "embeddedContent", "description": "embeddedContent", "value": "embeddedContent" }, { "name": "uri", "description": "uri", "value": "uri" } ] }, "azure-native:automation:DeletedRunbookResponse": { "description": "Definition of deleted runbook.", "properties": { "creationTime": { "type": "string", "description": "Gets or sets the creation time." }, "deletionTime": { "type": "string", "description": "Gets or sets the last modified time." }, "id": { "type": "string", "description": "The resource id." }, "location": { "type": "string", "description": "Gets or sets the location of the resource." }, "name": { "type": "string", "description": "Gets or sets name of the resource." }, "runbookId": { "type": "string", "description": "Gets or sets the Runbook Id." }, "runbookType": { "type": "string", "description": "Type of the runbook." }, "runtime": { "type": "string", "description": "Gets or sets runtime of the runbook." }, "runtimeEnvironment": { "type": "string", "description": "Environment of the runbook." } }, "type": "object" }, "azure-native:automation:DscConfigurationAssociationProperty": { "description": "The Dsc configuration property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Dsc configuration." } }, "type": "object" }, "azure-native:automation:DscConfigurationAssociationPropertyResponse": { "description": "The Dsc configuration property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Dsc configuration." } }, "type": "object" }, "azure-native:automation:DscConfigurationParameter": { "description": "Definition of the configuration parameter type.", "properties": { "defaultValue": { "type": "string", "description": "Gets or sets the default value of parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", "description": "Get or sets the position of the parameter." }, "type": { "type": "string", "description": "Gets or sets the type of the parameter." } }, "type": "object" }, "azure-native:automation:DscConfigurationParameterResponse": { "description": "Definition of the configuration parameter type.", "properties": { "defaultValue": { "type": "string", "description": "Gets or sets the default value of parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", "description": "Get or sets the position of the parameter." }, "type": { "type": "string", "description": "Gets or sets the type of the parameter." } }, "type": "object" }, "azure-native:automation:EncryptionKeySourceType": { "description": "Encryption Key Source", "type": "string", "enum": [ { "name": "Microsoft.Automation", "description": "Microsoft.Automation", "value": "Microsoft.Automation" }, { "name": "Microsoft.Keyvault", "description": "Microsoft.Keyvault", "value": "Microsoft.Keyvault" } ] }, "azure-native:automation:EncryptionProperties": { "description": "The encryption settings for automation account", "properties": { "identity": { "type": "object", "$ref": "#/types/azure-native:automation:EncryptionPropertiesIdentity", "description": "User identity used for CMK." }, "keySource": { "$ref": "#/types/azure-native:automation:EncryptionKeySourceType", "description": "Encryption Key Source" }, "keyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:automation:KeyVaultProperties", "description": "Key vault properties." } }, "type": "object" }, "azure-native:automation:EncryptionPropertiesIdentity": { "description": "User identity used for CMK.", "properties": { "userAssignedIdentity": { "$ref": "pulumi.json#/Any", "description": "The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object" }, "azure-native:automation:EncryptionPropertiesIdentityResponse": { "description": "User identity used for CMK.", "properties": { "userAssignedIdentity": { "$ref": "pulumi.json#/Any", "description": "The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object" }, "azure-native:automation:EncryptionPropertiesResponse": { "description": "The encryption settings for automation account", "properties": { "identity": { "type": "object", "$ref": "#/types/azure-native:automation:EncryptionPropertiesIdentityResponse", "description": "User identity used for CMK." }, "keySource": { "type": "string", "description": "Encryption Key Source" }, "keyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:automation:KeyVaultPropertiesResponse", "description": "Key vault properties." } }, "type": "object" }, "azure-native:automation:FieldDefinition": { "description": "Definition of the connection fields.", "properties": { "isEncrypted": { "type": "boolean", "description": "Gets or sets the isEncrypted flag of the connection field definition." }, "isOptional": { "type": "boolean", "description": "Gets or sets the isOptional flag of the connection field definition." }, "type": { "type": "string", "description": "Gets or sets the type of the connection field definition." } }, "type": "object", "required": [ "type" ] }, "azure-native:automation:FieldDefinitionResponse": { "description": "Definition of the connection fields.", "properties": { "isEncrypted": { "type": "boolean", "description": "Gets or sets the isEncrypted flag of the connection field definition." }, "isOptional": { "type": "boolean", "description": "Gets or sets the isOptional flag of the connection field definition." }, "type": { "type": "string", "description": "Gets or sets the type of the connection field definition." } }, "type": "object", "required": [ "type" ] }, "azure-native:automation:Identity": { "description": "Identity for the resource.", "properties": { "type": { "$ref": "#/types/azure-native:automation:ResourceIdentityType", "description": "The identity type." }, "userAssignedIdentities": { "type": "array", "items": { "type": "string" }, "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object" }, "azure-native:automation:IdentityResponse": { "description": "Identity for the resource.", "properties": { "principalId": { "type": "string", "description": "The principal ID of resource identity. The value must be an UUID." }, "tenantId": { "type": "string", "description": "The tenant ID of resource." }, "type": { "type": "string", "description": "The identity type." }, "userAssignedIdentities": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:automation:UserAssignedIdentitiesPropertiesResponse" }, "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." } }, "type": "object", "required": [ "principalId", "tenantId" ] }, "azure-native:automation:KeyResponse": { "description": "Automation key which is used to register a DSC Node", "properties": { "keyName": { "type": "string", "description": "Automation key name." }, "permissions": { "type": "string", "description": "Automation key permissions." }, "value": { "type": "string", "description": "Value of the Automation Key used for registration." } }, "type": "object", "required": [ "keyName", "permissions", "value" ] }, "azure-native:automation:KeyVaultProperties": { "description": "Settings concerning key vault encryption for a configuration store.", "properties": { "keyName": { "type": "string", "description": "The name of key used to encrypt data." }, "keyVersion": { "type": "string", "description": "The key version of the key used to encrypt data." }, "keyvaultUri": { "type": "string", "description": "The URI of the key vault key used to encrypt data." } }, "type": "object" }, "azure-native:automation:KeyVaultPropertiesResponse": { "description": "Settings concerning key vault encryption for a configuration store.", "properties": { "keyName": { "type": "string", "description": "The name of key used to encrypt data." }, "keyVersion": { "type": "string", "description": "The key version of the key used to encrypt data." }, "keyvaultUri": { "type": "string", "description": "The URI of the key vault key used to encrypt data." } }, "type": "object" }, "azure-native:automation:LinuxProperties": { "description": "Linux specific update configuration.", "properties": { "excludedPackageNameMasks": { "type": "array", "items": { "type": "string" }, "description": "packages excluded from the software update configuration." }, "includedPackageClassifications": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:LinuxUpdateClasses" } ], "description": "Update classifications included in the software update configuration." }, "includedPackageNameMasks": { "type": "array", "items": { "type": "string" }, "description": "packages included from the software update configuration." }, "rebootSetting": { "type": "string", "description": "Reboot setting for the software update configuration." } }, "type": "object" }, "azure-native:automation:LinuxPropertiesResponse": { "description": "Linux specific update configuration.", "properties": { "excludedPackageNameMasks": { "type": "array", "items": { "type": "string" }, "description": "packages excluded from the software update configuration." }, "includedPackageClassifications": { "type": "string", "description": "Update classifications included in the software update configuration." }, "includedPackageNameMasks": { "type": "array", "items": { "type": "string" }, "description": "packages included from the software update configuration." }, "rebootSetting": { "type": "string", "description": "Reboot setting for the software update configuration." } }, "type": "object" }, "azure-native:automation:LinuxUpdateClasses": { "description": "Update classifications included in the software update configuration.", "type": "string", "enum": [ { "name": "Unclassified", "description": "Unclassified", "value": "Unclassified" }, { "name": "Critical", "description": "Critical", "value": "Critical" }, { "name": "Security", "description": "Security", "value": "Security" }, { "name": "Other", "description": "Other", "value": "Other" } ] }, "azure-native:automation:ModuleErrorInfoResponse": { "description": "Definition of the module error info type.", "properties": { "code": { "type": "string", "description": "Gets or sets the error code." }, "message": { "type": "string", "description": "Gets or sets the error message." } }, "type": "object" }, "azure-native:automation:NonAzureQueryProperties": { "description": "Non Azure query for the update configuration.", "properties": { "functionAlias": { "type": "string", "description": "Log Analytics Saved Search name." }, "workspaceId": { "type": "string", "description": "Workspace Id for Log Analytics in which the saved Search is resided." } }, "type": "object" }, "azure-native:automation:NonAzureQueryPropertiesResponse": { "description": "Non Azure query for the update configuration.", "properties": { "functionAlias": { "type": "string", "description": "Log Analytics Saved Search name." }, "workspaceId": { "type": "string", "description": "Workspace Id for Log Analytics in which the saved Search is resided." } }, "type": "object" }, "azure-native:automation:OperatingSystemType": { "description": "operating system of target machines", "type": "string", "enum": [ { "name": "Windows", "description": "Windows", "value": "Windows" }, { "name": "Linux", "description": "Linux", "value": "Linux" } ] }, "azure-native:automation:PackageErrorInfoResponse": { "description": "Definition of the package error info type.", "properties": { "code": { "type": "string", "description": "Package import error code." }, "message": { "type": "string", "description": "Package import error message." } }, "type": "object" }, "azure-native:automation:PrivateEndpointConnectionResponse": { "description": "A private endpoint connection", "properties": { "groupIds": { "type": "array", "items": { "type": "string" }, "description": "Gets the groupIds." }, "id": { "type": "string", "description": "Fully qualified resource ID for the resource. E.g. \"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}\"" }, "name": { "type": "string", "description": "The name of the resource" }, "privateEndpoint": { "type": "object", "$ref": "#/types/azure-native:automation:PrivateEndpointPropertyResponse", "description": "Private endpoint which the connection belongs to." }, "privateLinkServiceConnectionState": { "type": "object", "$ref": "#/types/azure-native:automation:PrivateLinkServiceConnectionStatePropertyResponse", "description": "Connection State of the Private Endpoint Connection." }, "systemData": { "type": "object", "$ref": "#/types/azure-native:automation:SystemDataResponse", "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information." }, "type": { "type": "string", "description": "The type of the resource. E.g. \"Microsoft.Compute/virtualMachines\" or \"Microsoft.Storage/storageAccounts\"" } }, "type": "object", "required": [ "id", "name", "systemData", "type" ] }, "azure-native:automation:PrivateEndpointProperty": { "description": "Private endpoint which the connection belongs to.", "properties": { "id": { "type": "string", "description": "Resource id of the private endpoint." } }, "type": "object" }, "azure-native:automation:PrivateEndpointPropertyResponse": { "description": "Private endpoint which the connection belongs to.", "properties": { "id": { "type": "string", "description": "Resource id of the private endpoint." } }, "type": "object" }, "azure-native:automation:PrivateLinkServiceConnectionStateProperty": { "description": "Connection State of the Private Endpoint Connection.", "properties": { "description": { "type": "string", "description": "The private link service connection description." }, "status": { "type": "string", "description": "The private link service connection status." } }, "type": "object" }, "azure-native:automation:PrivateLinkServiceConnectionStatePropertyResponse": { "description": "Connection State of the Private Endpoint Connection.", "properties": { "actionsRequired": { "type": "string", "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)" }, "description": { "type": "string", "description": "The private link service connection description." }, "status": { "type": "string", "description": "The private link service connection status." } }, "type": "object", "required": [ "actionsRequired" ] }, "azure-native:automation:ResourceIdentityType": { "description": "The identity type.", "type": "string", "enum": [ { "name": "SystemAssigned", "description": "SystemAssigned", "value": "SystemAssigned" }, { "name": "UserAssigned", "description": "UserAssigned", "value": "UserAssigned" }, { "name": "SystemAssigned, UserAssigned", "description": "SystemAssigned, UserAssigned", "value": "SystemAssigned, UserAssigned" }, { "name": "None", "description": "None", "value": "None" } ] }, "azure-native:automation:RunAsCredentialAssociationProperty": { "description": "Definition of RunAs credential to use for hybrid worker.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the credential." } }, "type": "object" }, "azure-native:automation:RunAsCredentialAssociationPropertyResponse": { "description": "Definition of RunAs credential to use for hybrid worker.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the credential." } }, "type": "object" }, "azure-native:automation:RunbookAssociationProperty": { "description": "The runbook property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the runbook." } }, "type": "object" }, "azure-native:automation:RunbookAssociationPropertyResponse": { "description": "The runbook property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the runbook." } }, "type": "object" }, "azure-native:automation:RunbookDraft": { "properties": { "creationTime": { "type": "string", "description": "Gets or sets the creation time of the runbook draft." }, "draftContentLink": { "type": "object", "$ref": "#/types/azure-native:automation:ContentLink", "description": "Gets or sets the draft runbook content link." }, "inEdit": { "type": "boolean", "description": "Gets or sets whether runbook is in edit mode." }, "lastModifiedTime": { "type": "string", "description": "Gets or sets the last modified time of the runbook draft." }, "outputTypes": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets the runbook output types." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:automation:RunbookParameter" }, "description": "Gets or sets the runbook draft parameters." } }, "type": "object" }, "azure-native:automation:RunbookDraftResponse": { "properties": { "creationTime": { "type": "string", "description": "Gets or sets the creation time of the runbook draft." }, "draftContentLink": { "type": "object", "$ref": "#/types/azure-native:automation:ContentLinkResponse", "description": "Gets or sets the draft runbook content link." }, "inEdit": { "type": "boolean", "description": "Gets or sets whether runbook is in edit mode." }, "lastModifiedTime": { "type": "string", "description": "Gets or sets the last modified time of the runbook draft." }, "outputTypes": { "type": "array", "items": { "type": "string" }, "description": "Gets or sets the runbook output types." }, "parameters": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:automation:RunbookParameterResponse" }, "description": "Gets or sets the runbook draft parameters." } }, "type": "object" }, "azure-native:automation:RunbookParameter": { "description": "Definition of the runbook parameter type.", "properties": { "defaultValue": { "type": "string", "description": "Gets or sets the default value of parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", "description": "Get or sets the position of the parameter." }, "type": { "type": "string", "description": "Gets or sets the type of the parameter." } }, "type": "object" }, "azure-native:automation:RunbookParameterResponse": { "description": "Definition of the runbook parameter type.", "properties": { "defaultValue": { "type": "string", "description": "Gets or sets the default value of parameter." }, "isMandatory": { "type": "boolean", "description": "Gets or sets a Boolean value to indicate whether the parameter is mandatory or not." }, "position": { "type": "integer", "description": "Get or sets the position of the parameter." }, "type": { "type": "string", "description": "Gets or sets the type of the parameter." } }, "type": "object" }, "azure-native:automation:RunbookTypeEnum": { "description": "Gets or sets the type of the runbook.", "type": "string", "enum": [ { "name": "Script", "description": "Script", "value": "Script" }, { "name": "Graph", "description": "Graph", "value": "Graph" }, { "name": "PowerShellWorkflow", "description": "PowerShellWorkflow", "value": "PowerShellWorkflow" }, { "name": "PowerShell", "description": "PowerShell", "value": "PowerShell" }, { "name": "GraphPowerShellWorkflow", "description": "GraphPowerShellWorkflow", "value": "GraphPowerShellWorkflow" }, { "name": "GraphPowerShell", "description": "GraphPowerShell", "value": "GraphPowerShell" }, { "name": "Python2", "description": "Python2", "value": "Python2" }, { "name": "Python3", "description": "Python3", "value": "Python3" }, { "name": "Python", "description": "Python", "value": "Python" }, { "name": "PowerShell72", "description": "PowerShell72", "value": "PowerShell72" } ] }, "azure-native:automation:SUCScheduleProperties": { "description": "Definition of schedule parameters.", "properties": { "advancedSchedule": { "type": "object", "$ref": "#/types/azure-native:automation:AdvancedSchedule", "description": "Gets or sets the advanced schedule." }, "creationTime": { "type": "string", "description": "Gets or sets the creation time." }, "description": { "type": "string", "description": "Gets or sets the description." }, "expiryTime": { "type": "string", "description": "Gets or sets the end time of the schedule." }, "expiryTimeOffsetMinutes": { "type": "number", "description": "Gets or sets the expiry time's offset in minutes." }, "frequency": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:ScheduleFrequency" } ], "description": "Gets or sets the frequency of the schedule." }, "interval": { "type": "number", "description": "Gets or sets the interval of the schedule." }, "isEnabled": { "type": "boolean", "description": "Gets or sets a value indicating whether this schedule is enabled." }, "lastModifiedTime": { "type": "string", "description": "Gets or sets the last modified time." }, "nextRun": { "type": "string", "description": "Gets or sets the next run time of the schedule." }, "nextRunOffsetMinutes": { "type": "number", "description": "Gets or sets the next run time's offset in minutes." }, "startTime": { "type": "string", "description": "Gets or sets the start time of the schedule." }, "timeZone": { "type": "string", "description": "Gets or sets the time zone of the schedule." } }, "type": "object" }, "azure-native:automation:SUCSchedulePropertiesResponse": { "description": "Definition of schedule parameters.", "properties": { "advancedSchedule": { "type": "object", "$ref": "#/types/azure-native:automation:AdvancedScheduleResponse", "description": "Gets or sets the advanced schedule." }, "creationTime": { "type": "string", "description": "Gets or sets the creation time." }, "description": { "type": "string", "description": "Gets or sets the description." }, "expiryTime": { "type": "string", "description": "Gets or sets the end time of the schedule." }, "expiryTimeOffsetMinutes": { "type": "number", "description": "Gets or sets the expiry time's offset in minutes." }, "frequency": { "type": "string", "description": "Gets or sets the frequency of the schedule." }, "interval": { "type": "number", "description": "Gets or sets the interval of the schedule." }, "isEnabled": { "type": "boolean", "description": "Gets or sets a value indicating whether this schedule is enabled." }, "lastModifiedTime": { "type": "string", "description": "Gets or sets the last modified time." }, "nextRun": { "type": "string", "description": "Gets or sets the next run time of the schedule." }, "nextRunOffsetMinutes": { "type": "number", "description": "Gets or sets the next run time's offset in minutes." }, "startTime": { "type": "string", "description": "Gets or sets the start time of the schedule." }, "startTimeOffsetMinutes": { "type": "number", "description": "Gets the start time's offset in minutes." }, "timeZone": { "type": "string", "description": "Gets or sets the time zone of the schedule." } }, "type": "object", "required": [ "startTimeOffsetMinutes" ] }, "azure-native:automation:ScheduleAssociationProperty": { "description": "The schedule property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Schedule." } }, "type": "object" }, "azure-native:automation:ScheduleAssociationPropertyResponse": { "description": "The schedule property associated with the entity.", "properties": { "name": { "type": "string", "description": "Gets or sets the name of the Schedule." } }, "type": "object" }, "azure-native:automation:ScheduleDay": { "description": "Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday.", "type": "string", "enum": [ { "name": "Monday", "description": "Monday", "value": "Monday" }, { "name": "Tuesday", "description": "Tuesday", "value": "Tuesday" }, { "name": "Wednesday", "description": "Wednesday", "value": "Wednesday" }, { "name": "Thursday", "description": "Thursday", "value": "Thursday" }, { "name": "Friday", "description": "Friday", "value": "Friday" }, { "name": "Saturday", "description": "Saturday", "value": "Saturday" }, { "name": "Sunday", "description": "Sunday", "value": "Sunday" } ] }, "azure-native:automation:ScheduleFrequency": { "description": "Gets or sets the frequency of the schedule.", "type": "string", "enum": [ { "name": "OneTime", "description": "OneTime", "value": "OneTime" }, { "name": "Day", "description": "Day", "value": "Day" }, { "name": "Hour", "description": "Hour", "value": "Hour" }, { "name": "Week", "description": "Week", "value": "Week" }, { "name": "Month", "description": "Month", "value": "Month" }, { "name": "Minute", "description": "The minimum allowed interval for Minute schedules is 15 minutes.", "value": "Minute" } ] }, "azure-native:automation:Sku": { "description": "The account SKU.", "properties": { "capacity": { "type": "integer", "description": "Gets or sets the SKU capacity." }, "family": { "type": "string", "description": "Gets or sets the SKU family." }, "name": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:SkuNameEnum" } ], "description": "Gets or sets the SKU name of the account." } }, "type": "object", "required": [ "name" ] }, "azure-native:automation:SkuNameEnum": { "description": "Gets or sets the SKU name of the account.", "type": "string", "enum": [ { "name": "Free", "description": "Free", "value": "Free" }, { "name": "Basic", "description": "Basic", "value": "Basic" } ] }, "azure-native:automation:SkuResponse": { "description": "The account SKU.", "properties": { "capacity": { "type": "integer", "description": "Gets or sets the SKU capacity." }, "family": { "type": "string", "description": "Gets or sets the SKU family." }, "name": { "type": "string", "description": "Gets or sets the SKU name of the account." } }, "type": "object", "required": [ "name" ] }, "azure-native:automation:SoftwareUpdateConfigurationTasks": { "description": "Task properties of the software update configuration.", "properties": { "postTask": { "type": "object", "$ref": "#/types/azure-native:automation:TaskProperties", "description": "Post task properties." }, "preTask": { "type": "object", "$ref": "#/types/azure-native:automation:TaskProperties", "description": "Pre task properties." } }, "type": "object" }, "azure-native:automation:SoftwareUpdateConfigurationTasksResponse": { "description": "Task properties of the software update configuration.", "properties": { "postTask": { "type": "object", "$ref": "#/types/azure-native:automation:TaskPropertiesResponse", "description": "Post task properties." }, "preTask": { "type": "object", "$ref": "#/types/azure-native:automation:TaskPropertiesResponse", "description": "Pre task properties." } }, "type": "object" }, "azure-native:automation:SourceControlSecurityTokenProperties": { "properties": { "accessToken": { "type": "string", "description": "The access token." }, "refreshToken": { "type": "string", "description": "The refresh token." }, "tokenType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:TokenType" } ], "description": "The token type. Must be either PersonalAccessToken or Oauth." } }, "type": "object" }, "azure-native:automation:SourceType": { "description": "The source type. Must be one of VsoGit, VsoTfvc, GitHub, case sensitive.", "type": "string", "enum": [ { "name": "VsoGit", "description": "VsoGit", "value": "VsoGit" }, { "name": "VsoTfvc", "description": "VsoTfvc", "value": "VsoTfvc" }, { "name": "GitHub", "description": "GitHub", "value": "GitHub" } ] }, "azure-native:automation:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:automation:TagOperators": { "description": "Filter VMs by Any or All specified tags.", "type": "string", "enum": [ { "name": "All", "description": "All", "value": "All" }, { "name": "Any", "description": "Any", "value": "Any" } ] }, "azure-native:automation:TagSettingsProperties": { "description": "Tag filter information for the VM.", "properties": { "filterOperator": { "$ref": "#/types/azure-native:automation:TagOperators", "description": "Filter VMs by Any or All specified tags." }, "tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Dictionary of tags with its list of values." } }, "type": "object" }, "azure-native:automation:TagSettingsPropertiesResponse": { "description": "Tag filter information for the VM.", "properties": { "filterOperator": { "type": "string", "description": "Filter VMs by Any or All specified tags." }, "tags": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Dictionary of tags with its list of values." } }, "type": "object" }, "azure-native:automation:TargetProperties": { "description": "Group specific to the update configuration.", "properties": { "azureQueries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:automation:AzureQueryProperties" }, "description": "List of Azure queries in the software update configuration." }, "nonAzureQueries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:automation:NonAzureQueryProperties" }, "description": "List of non Azure queries in the software update configuration." } }, "type": "object" }, "azure-native:automation:TargetPropertiesResponse": { "description": "Group specific to the update configuration.", "properties": { "azureQueries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:automation:AzureQueryPropertiesResponse" }, "description": "List of Azure queries in the software update configuration." }, "nonAzureQueries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:automation:NonAzureQueryPropertiesResponse" }, "description": "List of non Azure queries in the software update configuration." } }, "type": "object" }, "azure-native:automation:TaskProperties": { "description": "Task properties of the software update configuration.", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Gets or sets the parameters of the task." }, "source": { "type": "string", "description": "Gets or sets the name of the runbook." } }, "type": "object" }, "azure-native:automation:TaskPropertiesResponse": { "description": "Task properties of the software update configuration.", "properties": { "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Gets or sets the parameters of the task." }, "source": { "type": "string", "description": "Gets or sets the name of the runbook." } }, "type": "object" }, "azure-native:automation:TokenType": { "description": "The token type. Must be either PersonalAccessToken or Oauth.", "type": "string", "enum": [ { "name": "PersonalAccessToken", "description": "PersonalAccessToken", "value": "PersonalAccessToken" }, { "name": "Oauth", "description": "Oauth", "value": "Oauth" } ] }, "azure-native:automation:TrackedResource": { "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'", "properties": { "location": { "type": "string", "description": "The geo-location where the resource lives" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Resource tags." } }, "type": "object", "required": [ "location" ] }, "azure-native:automation:UpdateConfiguration": { "description": "Update specific properties of the software update configuration.", "properties": { "azureVirtualMachines": { "type": "array", "items": { "type": "string" }, "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration." }, "duration": { "type": "string", "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" }, "linux": { "type": "object", "$ref": "#/types/azure-native:automation:LinuxProperties", "description": "Linux specific update configuration." }, "nonAzureComputerNames": { "type": "array", "items": { "type": "string" }, "description": "List of names of non-azure machines targeted by the software update configuration." }, "operatingSystem": { "$ref": "#/types/azure-native:automation:OperatingSystemType", "description": "operating system of target machines" }, "targets": { "type": "object", "$ref": "#/types/azure-native:automation:TargetProperties", "description": "Group targets for the software update configuration." }, "windows": { "type": "object", "$ref": "#/types/azure-native:automation:WindowsProperties", "description": "Windows specific update configuration." } }, "type": "object", "required": [ "operatingSystem" ] }, "azure-native:automation:UpdateConfigurationResponse": { "description": "Update specific properties of the software update configuration.", "properties": { "azureVirtualMachines": { "type": "array", "items": { "type": "string" }, "description": "List of azure resource Ids for azure virtual machines targeted by the software update configuration." }, "duration": { "type": "string", "description": "Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601" }, "linux": { "type": "object", "$ref": "#/types/azure-native:automation:LinuxPropertiesResponse", "description": "Linux specific update configuration." }, "nonAzureComputerNames": { "type": "array", "items": { "type": "string" }, "description": "List of names of non-azure machines targeted by the software update configuration." }, "operatingSystem": { "type": "string", "description": "operating system of target machines" }, "targets": { "type": "object", "$ref": "#/types/azure-native:automation:TargetPropertiesResponse", "description": "Group targets for the software update configuration." }, "windows": { "type": "object", "$ref": "#/types/azure-native:automation:WindowsPropertiesResponse", "description": "Windows specific update configuration." } }, "type": "object", "required": [ "operatingSystem" ] }, "azure-native:automation:UserAssignedIdentitiesPropertiesResponse": { "properties": { "clientId": { "type": "string", "description": "The client id of user assigned identity." }, "principalId": { "type": "string", "description": "The principal id of user assigned identity." } }, "type": "object", "required": [ "clientId", "principalId" ] }, "azure-native:automation:WindowsProperties": { "description": "Windows specific update configuration.", "properties": { "excludedKbNumbers": { "type": "array", "items": { "type": "string" }, "description": "KB numbers excluded from the software update configuration." }, "includedKbNumbers": { "type": "array", "items": { "type": "string" }, "description": "KB numbers included from the software update configuration." }, "includedUpdateClassifications": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:automation:WindowsUpdateClasses" } ], "description": "Update classification included in the software update configuration. A comma separated string with required values" }, "rebootSetting": { "type": "string", "description": "Reboot setting for the software update configuration." } }, "type": "object" }, "azure-native:automation:WindowsPropertiesResponse": { "description": "Windows specific update configuration.", "properties": { "excludedKbNumbers": { "type": "array", "items": { "type": "string" }, "description": "KB numbers excluded from the software update configuration." }, "includedKbNumbers": { "type": "array", "items": { "type": "string" }, "description": "KB numbers included from the software update configuration." }, "includedUpdateClassifications": { "type": "string", "description": "Update classification included in the software update configuration. A comma separated string with required values" }, "rebootSetting": { "type": "string", "description": "Reboot setting for the software update configuration." } }, "type": "object" }, "azure-native:automation:WindowsUpdateClasses": { "description": "Update classification included in the software update configuration. A comma separated string with required values", "type": "string", "enum": [ { "name": "Unclassified", "description": "Unclassified", "value": "Unclassified" }, { "name": "Critical", "description": "Critical", "value": "Critical" }, { "name": "Security", "description": "Security", "value": "Security" }, { "name": "UpdateRollup", "description": "UpdateRollup", "value": "UpdateRollup" }, { "name": "FeaturePack", "description": "FeaturePack", "value": "FeaturePack" }, { "name": "ServicePack", "description": "ServicePack", "value": "ServicePack" }, { "name": "Definition", "description": "Definition", "value": "Definition" }, { "name": "Tools", "description": "Tools", "value": "Tools" }, { "name": "Updates", "description": "Updates", "value": "Updates" } ] }, "azure-native:avs:AddonArcProperties": { "description": "The properties of an Arc addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'Arc'.", "const": "Arc" }, "vCenter": { "type": "string", "description": "The VMware vCenter resource ID" } }, "type": "object", "required": [ "addonType" ] }, "azure-native:avs:AddonArcPropertiesResponse": { "description": "The properties of an Arc addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'Arc'.", "const": "Arc" }, "provisioningState": { "type": "string", "description": "The state of the addon provisioning" }, "vCenter": { "type": "string", "description": "The VMware vCenter resource ID" } }, "type": "object", "required": [ "addonType", "provisioningState" ] }, "azure-native:avs:AddonHcxProperties": { "description": "The properties of an HCX addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'HCX'.", "const": "HCX" }, "offer": { "type": "string", "description": "The HCX offer, example VMware MaaS Cloud Provider (Enterprise)" } }, "type": "object", "required": [ "addonType", "offer" ] }, "azure-native:avs:AddonHcxPropertiesResponse": { "description": "The properties of an HCX addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'HCX'.", "const": "HCX" }, "offer": { "type": "string", "description": "The HCX offer, example VMware MaaS Cloud Provider (Enterprise)" }, "provisioningState": { "type": "string", "description": "The state of the addon provisioning" } }, "type": "object", "required": [ "addonType", "offer", "provisioningState" ] }, "azure-native:avs:AddonSrmProperties": { "description": "The properties of a Site Recovery Manager (SRM) addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'SRM'.", "const": "SRM" }, "licenseKey": { "type": "string", "description": "The Site Recovery Manager (SRM) license" } }, "type": "object", "required": [ "addonType" ] }, "azure-native:avs:AddonSrmPropertiesResponse": { "description": "The properties of a Site Recovery Manager (SRM) addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'SRM'.", "const": "SRM" }, "licenseKey": { "type": "string", "description": "The Site Recovery Manager (SRM) license" }, "provisioningState": { "type": "string", "description": "The state of the addon provisioning" } }, "type": "object", "required": [ "addonType", "provisioningState" ] }, "azure-native:avs:AddonType": { "description": "Addon type", "type": "string", "enum": [ { "name": "SRM", "value": "SRM" }, { "name": "VR", "value": "VR" }, { "name": "HCX", "value": "HCX" }, { "name": "Arc", "value": "Arc" } ] }, "azure-native:avs:AddonVrProperties": { "description": "The properties of a vSphere Replication (VR) addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'VR'.", "const": "VR" }, "vrsCount": { "type": "integer", "description": "The vSphere Replication Server (VRS) count" } }, "type": "object", "required": [ "addonType", "vrsCount" ] }, "azure-native:avs:AddonVrPropertiesResponse": { "description": "The properties of a vSphere Replication (VR) addon", "properties": { "addonType": { "type": "string", "description": "Addon type\nExpected value is 'VR'.", "const": "VR" }, "provisioningState": { "type": "string", "description": "The state of the addon provisioning" }, "vrsCount": { "type": "integer", "description": "The vSphere Replication Server (VRS) count" } }, "type": "object", "required": [ "addonType", "provisioningState", "vrsCount" ] }, "azure-native:avs:AffinityStrength": { "description": "vm-host placement policy affinity strength (should/must)", "type": "string", "enum": [ { "name": "Should", "description": "is should", "value": "Should" }, { "name": "Must", "description": "is must", "value": "Must" } ] }, "azure-native:avs:AffinityType": { "description": "placement policy affinity type", "type": "string", "enum": [ { "name": "Affinity", "description": "is affinity", "value": "Affinity" }, { "name": "AntiAffinity", "description": "is anti-affinity", "value": "AntiAffinity" } ] }, "azure-native:avs:AvailabilityProperties": { "description": "The properties describing private cloud availability zone distribution", "properties": { "secondaryZone": { "type": "integer", "description": "The secondary availability zone for the private cloud" }, "strategy": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:AvailabilityStrategy" } ], "description": "The availability strategy for the private cloud" }, "zone": { "type": "integer", "description": "The primary availability zone for the private cloud" } }, "type": "object" }, "azure-native:avs:AvailabilityPropertiesResponse": { "description": "The properties describing private cloud availability zone distribution", "properties": { "secondaryZone": { "type": "integer", "description": "The secondary availability zone for the private cloud" }, "strategy": { "type": "string", "description": "The availability strategy for the private cloud" }, "zone": { "type": "integer", "description": "The primary availability zone for the private cloud" } }, "type": "object" }, "azure-native:avs:AvailabilityStrategy": { "description": "The availability strategy for the private cloud", "type": "string", "enum": [ { "name": "SingleZone", "description": "in single zone", "value": "SingleZone" }, { "name": "DualZone", "description": "in two zones", "value": "DualZone" } ] }, "azure-native:avs:AzureHybridBenefitType": { "description": "placement policy azure hybrid benefit opt-in type", "type": "string", "enum": [ { "name": "SqlHost", "description": "is SqlHost", "value": "SqlHost" }, { "name": "None", "description": "is None", "value": "None" } ] }, "azure-native:avs:CircuitResponse": { "description": "An ExpressRoute Circuit", "properties": { "expressRouteID": { "type": "string", "description": "Identifier of the ExpressRoute Circuit (Microsoft Colo only)" }, "expressRoutePrivatePeeringID": { "type": "string", "description": "ExpressRoute Circuit private peering identifier" }, "primarySubnet": { "type": "string", "description": "CIDR of primary subnet" }, "secondarySubnet": { "type": "string", "description": "CIDR of secondary subnet" } }, "type": "object", "required": [ "expressRouteID", "expressRoutePrivatePeeringID", "primarySubnet", "secondarySubnet" ] }, "azure-native:avs:ClusterZoneResponse": { "description": "Zone and associated hosts info", "properties": { "hosts": { "type": "array", "items": { "type": "string" }, "description": "List of hosts belonging to the availability zone in a cluster" }, "zone": { "type": "string", "description": "Availability zone identifier" } }, "type": "object", "required": [ "hosts", "zone" ] }, "azure-native:avs:DhcpTypeEnum": { "description": "Type of DHCP: SERVER or RELAY.", "type": "string", "enum": [ { "name": "SERVER", "value": "SERVER" }, { "name": "RELAY", "value": "RELAY" } ] }, "azure-native:avs:DiskPoolVolume": { "description": "An iSCSI volume from Microsoft.StoragePool provider", "properties": { "lunName": { "type": "string", "description": "Name of the LUN to be used for datastore" }, "mountOption": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:MountOptionEnum" } ], "description": "Mode that describes whether the LUN has to be mounted as a datastore or\nattached as a LUN", "default": "MOUNT" }, "targetId": { "type": "string", "description": "Azure resource ID of the iSCSI target" } }, "type": "object", "required": [ "lunName", "targetId" ] }, "azure-native:avs:DiskPoolVolumeResponse": { "description": "An iSCSI volume from Microsoft.StoragePool provider", "properties": { "lunName": { "type": "string", "description": "Name of the LUN to be used for datastore" }, "mountOption": { "type": "string", "description": "Mode that describes whether the LUN has to be mounted as a datastore or\nattached as a LUN", "default": "MOUNT" }, "path": { "type": "string", "description": "Device path" }, "targetId": { "type": "string", "description": "Azure resource ID of the iSCSI target" } }, "type": "object", "required": [ "lunName", "path", "targetId" ] }, "azure-native:avs:DnsServiceLogLevelEnum": { "description": "DNS Service log level.", "type": "string", "enum": [ { "name": "DEBUG", "description": "is debug", "value": "DEBUG" }, { "name": "INFO", "description": "is info", "value": "INFO" }, { "name": "WARNING", "description": "is warning", "value": "WARNING" }, { "name": "ERROR", "description": "is error", "value": "ERROR" }, { "name": "FATAL", "description": "is fatal", "value": "FATAL" } ] }, "azure-native:avs:DnsZoneType": { "description": "The type of DNS zone to use.", "type": "string", "enum": [ { "name": "Public", "description": "Primary DNS zone.", "value": "Public" }, { "name": "Private", "description": "Private DNS zone.", "value": "Private" } ] }, "azure-native:avs:ElasticSanVolume": { "description": "An Elastic SAN volume from Microsoft.ElasticSan provider", "properties": { "targetId": { "type": "string", "description": "Azure resource ID of the Elastic SAN Volume" } }, "type": "object", "required": [ "targetId" ] }, "azure-native:avs:ElasticSanVolumeResponse": { "description": "An Elastic SAN volume from Microsoft.ElasticSan provider", "properties": { "targetId": { "type": "string", "description": "Azure resource ID of the Elastic SAN Volume" } }, "type": "object", "required": [ "targetId" ] }, "azure-native:avs:Encryption": { "description": "The properties of customer managed encryption key", "properties": { "keyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:avs:EncryptionKeyVaultProperties", "description": "The key vault where the encryption key is stored" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:EncryptionState" } ], "description": "Status of customer managed encryption key" } }, "type": "object" }, "azure-native:avs:EncryptionKeyVaultProperties": { "description": "An Encryption Key", "properties": { "keyName": { "type": "string", "description": "The name of the key." }, "keyVaultUrl": { "type": "string", "description": "The URL of the vault." }, "keyVersion": { "type": "string", "description": "The version of the key." } }, "type": "object" }, "azure-native:avs:EncryptionKeyVaultPropertiesResponse": { "description": "An Encryption Key", "properties": { "autoDetectedKeyVersion": { "type": "string", "description": "The auto-detected version of the key if versionType is auto-detected." }, "keyName": { "type": "string", "description": "The name of the key." }, "keyState": { "type": "string", "description": "The state of key provided" }, "keyVaultUrl": { "type": "string", "description": "The URL of the vault." }, "keyVersion": { "type": "string", "description": "The version of the key." }, "versionType": { "type": "string", "description": "Property of the key if user provided or auto detected" } }, "type": "object", "required": [ "autoDetectedKeyVersion", "keyState", "versionType" ] }, "azure-native:avs:EncryptionResponse": { "description": "The properties of customer managed encryption key", "properties": { "keyVaultProperties": { "type": "object", "$ref": "#/types/azure-native:avs:EncryptionKeyVaultPropertiesResponse", "description": "The key vault where the encryption key is stored" }, "status": { "type": "string", "description": "Status of customer managed encryption key" } }, "type": "object" }, "azure-native:avs:EncryptionState": { "description": "Status of customer managed encryption key", "type": "string", "enum": [ { "name": "Enabled", "description": "is enabled", "value": "Enabled" }, { "name": "Disabled", "description": "is disabled", "value": "Disabled" } ] }, "azure-native:avs:EndpointsResponse": { "description": "Endpoint addresses", "properties": { "hcxCloudManager": { "type": "string", "description": "Endpoint FQDN for the HCX Cloud Manager" }, "hcxCloudManagerIp": { "type": "string", "description": "Endpoint IP for the HCX Cloud Manager" }, "nsxtManager": { "type": "string", "description": "Endpoint FQDN for the NSX-T Data Center manager" }, "nsxtManagerIp": { "type": "string", "description": "Endpoint IP for the NSX-T Data Center manager" }, "vcenterIp": { "type": "string", "description": "Endpoint IP for Virtual Center Server Appliance" }, "vcsa": { "type": "string", "description": "Endpoint FQDN for Virtual Center Server Appliance" } }, "type": "object", "required": [ "hcxCloudManager", "hcxCloudManagerIp", "nsxtManager", "nsxtManagerIp", "vcenterIp", "vcsa" ] }, "azure-native:avs:IdentitySource": { "description": "vCenter Single Sign On Identity Source", "properties": { "alias": { "type": "string", "description": "The domain's NetBIOS name" }, "baseGroupDN": { "type": "string", "description": "The base distinguished name for groups" }, "baseUserDN": { "type": "string", "description": "The base distinguished name for users" }, "domain": { "type": "string", "description": "The domain's DNS name" }, "name": { "type": "string", "description": "The name of the identity source" }, "password": { "type": "string", "description": "The password of the Active Directory user with a minimum of read-only access to\nBase DN for users and groups." }, "primaryServer": { "type": "string", "description": "Primary server URL" }, "secondaryServer": { "type": "string", "description": "Secondary server URL" }, "ssl": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:SslEnum" } ], "description": "Protect LDAP communication using SSL certificate (LDAPS)" }, "username": { "type": "string", "description": "The ID of an Active Directory user with a minimum of read-only access to Base\nDN for users and group" } }, "type": "object" }, "azure-native:avs:IdentitySourceResponse": { "description": "vCenter Single Sign On Identity Source", "properties": { "alias": { "type": "string", "description": "The domain's NetBIOS name" }, "baseGroupDN": { "type": "string", "description": "The base distinguished name for groups" }, "baseUserDN": { "type": "string", "description": "The base distinguished name for users" }, "domain": { "type": "string", "description": "The domain's DNS name" }, "name": { "type": "string", "description": "The name of the identity source" }, "password": { "type": "string", "description": "The password of the Active Directory user with a minimum of read-only access to\nBase DN for users and groups." }, "primaryServer": { "type": "string", "description": "Primary server URL" }, "secondaryServer": { "type": "string", "description": "Secondary server URL" }, "ssl": { "type": "string", "description": "Protect LDAP communication using SSL certificate (LDAPS)" }, "username": { "type": "string", "description": "The ID of an Active Directory user with a minimum of read-only access to Base\nDN for users and group" } }, "type": "object" }, "azure-native:avs:InternetEnum": { "description": "Connectivity to internet is enabled or disabled", "type": "string", "enum": [ { "name": "Enabled", "description": "is enabled", "value": "Enabled" }, { "name": "Disabled", "description": "is disabled", "value": "Disabled" } ] }, "azure-native:avs:Label": { "description": "A key-value pair representing a label.", "properties": { "key": { "type": "string", "description": "The key of the label." }, "value": { "type": "string", "description": "The value of the label." } }, "type": "object", "required": [ "key", "value" ] }, "azure-native:avs:LabelResponse": { "description": "A key-value pair representing a label.", "properties": { "key": { "type": "string", "description": "The key of the label." }, "value": { "type": "string", "description": "The value of the label." } }, "type": "object", "required": [ "key", "value" ] }, "azure-native:avs:LicenseKind": { "description": "License kind", "type": "string", "enum": [ { "name": "VmwareFirewall", "value": "VmwareFirewall" } ] }, "azure-native:avs:ManagementCluster": { "description": "The properties of a management cluster", "properties": { "clusterSize": { "type": "integer", "description": "The cluster size" }, "hosts": { "type": "array", "items": { "type": "string" }, "description": "The hosts" }, "vsanDatastoreName": { "type": "string", "description": "Name of the vsan datastore associated with the cluster" } }, "type": "object" }, "azure-native:avs:ManagementClusterResponse": { "description": "The properties of a management cluster", "properties": { "clusterId": { "type": "integer", "description": "The identity" }, "clusterSize": { "type": "integer", "description": "The cluster size" }, "hosts": { "type": "array", "items": { "type": "string" }, "description": "The hosts" }, "provisioningState": { "type": "string", "description": "The state of the cluster provisioning" }, "vsanDatastoreName": { "type": "string", "description": "Name of the vsan datastore associated with the cluster" } }, "type": "object", "required": [ "clusterId", "provisioningState" ] }, "azure-native:avs:MountOptionEnum": { "description": "Mode that describes whether the LUN has to be mounted as a datastore or\nattached as a LUN", "type": "string", "enum": [ { "name": "MOUNT", "description": "is mount", "value": "MOUNT" }, { "name": "ATTACH", "description": "is attach", "value": "ATTACH" } ] }, "azure-native:avs:NetAppVolume": { "description": "An Azure NetApp Files volume from Microsoft.NetApp provider", "properties": { "id": { "type": "string", "description": "Azure resource ID of the NetApp volume" } }, "type": "object", "required": [ "id" ] }, "azure-native:avs:NetAppVolumeResponse": { "description": "An Azure NetApp Files volume from Microsoft.NetApp provider", "properties": { "id": { "type": "string", "description": "Azure resource ID of the NetApp volume" } }, "type": "object", "required": [ "id" ] }, "azure-native:avs:PSCredentialExecutionParameter": { "description": "a powershell credential object", "properties": { "name": { "type": "string", "description": "The parameter name" }, "password": { "type": "string", "description": "password for login" }, "type": { "type": "string", "description": "script execution parameter type\nExpected value is 'Credential'.", "const": "Credential" }, "username": { "type": "string", "description": "username for login" } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:avs:PSCredentialExecutionParameterResponse": { "description": "a powershell credential object", "properties": { "name": { "type": "string", "description": "The parameter name" }, "password": { "type": "string", "description": "password for login" }, "type": { "type": "string", "description": "script execution parameter type\nExpected value is 'Credential'.", "const": "Credential" }, "username": { "type": "string", "description": "username for login" } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:avs:PlacementPolicyState": { "description": "Whether the placement policy is enabled or disabled", "type": "string", "enum": [ { "name": "Enabled", "description": "is enabled", "value": "Enabled" }, { "name": "Disabled", "description": "is disabled", "value": "Disabled" } ] }, "azure-native:avs:PlacementPolicyType": { "description": "Placement Policy type", "type": "string", "enum": [ { "name": "VmVm", "value": "VmVm" }, { "name": "VmHost", "value": "VmHost" } ] }, "azure-native:avs:PortMirroringDirectionEnum": { "description": "Direction of port mirroring profile.", "type": "string", "enum": [ { "name": "INGRESS", "description": "is ingress", "value": "INGRESS" }, { "name": "EGRESS", "description": "is egress", "value": "EGRESS" }, { "name": "BIDIRECTIONAL", "description": "is bidirectional", "value": "BIDIRECTIONAL" } ] }, "azure-native:avs:ScriptExecutionParameterType": { "description": "script execution parameter type", "type": "string", "enum": [ { "name": "Value", "value": "Value" }, { "name": "SecureValue", "value": "SecureValue" }, { "name": "Credential", "value": "Credential" } ] }, "azure-native:avs:ScriptSecureStringExecutionParameter": { "description": "a plain text value execution parameter", "properties": { "name": { "type": "string", "description": "The parameter name" }, "secureValue": { "type": "string", "description": "A secure value for the passed parameter, not to be stored in logs" }, "type": { "type": "string", "description": "script execution parameter type\nExpected value is 'SecureValue'.", "const": "SecureValue" } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:avs:ScriptSecureStringExecutionParameterResponse": { "description": "a plain text value execution parameter", "properties": { "name": { "type": "string", "description": "The parameter name" }, "secureValue": { "type": "string", "description": "A secure value for the passed parameter, not to be stored in logs" }, "type": { "type": "string", "description": "script execution parameter type\nExpected value is 'SecureValue'.", "const": "SecureValue" } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:avs:ScriptStringExecutionParameter": { "description": "a plain text value execution parameter", "properties": { "name": { "type": "string", "description": "The parameter name" }, "type": { "type": "string", "description": "script execution parameter type\nExpected value is 'Value'.", "const": "Value" }, "value": { "type": "string", "description": "The value for the passed parameter" } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:avs:ScriptStringExecutionParameterResponse": { "description": "a plain text value execution parameter", "properties": { "name": { "type": "string", "description": "The parameter name" }, "type": { "type": "string", "description": "script execution parameter type\nExpected value is 'Value'.", "const": "Value" }, "value": { "type": "string", "description": "The value for the passed parameter" } }, "type": "object", "required": [ "name", "type" ] }, "azure-native:avs:Sku": { "description": "The resource model definition representing SKU", "properties": { "capacity": { "type": "integer", "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." }, "family": { "type": "string", "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." }, "name": { "type": "string", "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" }, "size": { "type": "string", "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " }, "tier": { "$ref": "#/types/azure-native:avs:SkuTier", "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." } }, "type": "object", "required": [ "name" ] }, "azure-native:avs:SkuResponse": { "description": "The resource model definition representing SKU", "properties": { "capacity": { "type": "integer", "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." }, "family": { "type": "string", "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." }, "name": { "type": "string", "description": "The name of the SKU. E.g. P3. It is typically a letter+number code" }, "size": { "type": "string", "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " }, "tier": { "type": "string", "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT." } }, "type": "object", "required": [ "name" ] }, "azure-native:avs:SkuTier": { "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.", "type": "string", "enum": [ { "value": "Free" }, { "value": "Basic" }, { "value": "Standard" }, { "value": "Premium" } ] }, "azure-native:avs:SslEnum": { "description": "Protect LDAP communication using SSL certificate (LDAPS)", "type": "string", "enum": [ { "name": "Enabled", "description": "is enabled", "value": "Enabled" }, { "name": "Disabled", "description": "is disabled", "value": "Disabled" } ] }, "azure-native:avs:SystemAssignedServiceIdentity": { "description": "Managed service identity (either system assigned, or none)", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:SystemAssignedServiceIdentityType" } ], "description": "Type of managed service identity (either system assigned, or none)." } }, "type": "object", "required": [ "type" ] }, "azure-native:avs:SystemAssignedServiceIdentityResponse": { "description": "Managed service identity (either system assigned, or none)", "properties": { "principalId": { "type": "string", "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "tenantId": { "type": "string", "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity." }, "type": { "type": "string", "description": "Type of managed service identity (either system assigned, or none)." } }, "type": "object", "required": [ "principalId", "tenantId", "type" ] }, "azure-native:avs:SystemAssignedServiceIdentityType": { "description": "Type of managed service identity (either system assigned, or none).", "type": "string", "enum": [ { "value": "None" }, { "value": "SystemAssigned" } ] }, "azure-native:avs:SystemDataResponse": { "description": "Metadata pertaining to creation and last modification of the resource.", "properties": { "createdAt": { "type": "string", "description": "The timestamp of resource creation (UTC)." }, "createdBy": { "type": "string", "description": "The identity that created the resource." }, "createdByType": { "type": "string", "description": "The type of identity that created the resource." }, "lastModifiedAt": { "type": "string", "description": "The timestamp of resource last modification (UTC)" }, "lastModifiedBy": { "type": "string", "description": "The identity that last modified the resource." }, "lastModifiedByType": { "type": "string", "description": "The type of identity that last modified the resource." } }, "type": "object" }, "azure-native:avs:VmHostPlacementPolicyProperties": { "description": "VM-Host placement policy properties", "properties": { "affinityStrength": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:AffinityStrength" } ], "description": "vm-host placement policy affinity strength (should/must)" }, "affinityType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:AffinityType" } ], "description": "placement policy affinity type" }, "azureHybridBenefitType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:AzureHybridBenefitType" } ], "description": "placement policy azure hybrid benefit opt-in type" }, "displayName": { "type": "string", "description": "Display name of the placement policy" }, "hostMembers": { "type": "array", "items": { "type": "string" }, "description": "Host members list" }, "state": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:PlacementPolicyState" } ], "description": "Whether the placement policy is enabled or disabled" }, "type": { "type": "string", "description": "Placement Policy type\nExpected value is 'VmHost'.", "const": "VmHost" }, "vmMembers": { "type": "array", "items": { "type": "string" }, "description": "Virtual machine members list" } }, "type": "object", "required": [ "affinityType", "hostMembers", "type", "vmMembers" ] }, "azure-native:avs:VmHostPlacementPolicyPropertiesResponse": { "description": "VM-Host placement policy properties", "properties": { "affinityStrength": { "type": "string", "description": "vm-host placement policy affinity strength (should/must)" }, "affinityType": { "type": "string", "description": "placement policy affinity type" }, "azureHybridBenefitType": { "type": "string", "description": "placement policy azure hybrid benefit opt-in type" }, "displayName": { "type": "string", "description": "Display name of the placement policy" }, "hostMembers": { "type": "array", "items": { "type": "string" }, "description": "Host members list" }, "provisioningState": { "type": "string", "description": "The provisioning state" }, "state": { "type": "string", "description": "Whether the placement policy is enabled or disabled" }, "type": { "type": "string", "description": "Placement Policy type\nExpected value is 'VmHost'.", "const": "VmHost" }, "vmMembers": { "type": "array", "items": { "type": "string" }, "description": "Virtual machine members list" } }, "type": "object", "required": [ "affinityType", "hostMembers", "provisioningState", "type", "vmMembers" ] }, "azure-native:avs:VmVmPlacementPolicyProperties": { "description": "VM-VM placement policy properties", "properties": { "affinityType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:AffinityType" } ], "description": "placement policy affinity type" }, "displayName": { "type": "string", "description": "Display name of the placement policy" }, "state": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:avs:PlacementPolicyState" } ], "description": "Whether the placement policy is enabled or disabled" }, "type": { "type": "string", "description": "Placement Policy type\nExpected value is 'VmVm'.", "const": "VmVm" }, "vmMembers": { "type": "array", "items": { "type": "string" }, "description": "Virtual machine members list" } }, "type": "object", "required": [ "affinityType", "type", "vmMembers" ] }, "azure-native:avs:VmVmPlacementPolicyPropertiesResponse": { "description": "VM-VM placement policy properties", "properties": { "affinityType": { "type": "string", "description": "placement policy affinity type" }, "displayName": { "type": "string", "description": "Display name of the placement policy" }, "provisioningState": { "type": "string", "description": "The provisioning state" }, "state": { "type": "string", "description": "Whether the placement policy is enabled or disabled" }, "type": { "type": "string", "description": "Placement Policy type\nExpected value is 'VmVm'.", "const": "VmVm" }, "vmMembers": { "type": "array", "items": { "type": "string" }, "description": "Virtual machine members list" } }, "type": "object", "required": [ "affinityType", "provisioningState", "type", "vmMembers" ] }, "azure-native:avs:VmwareFirewallLicenseProperties": { "description": "The properties of a VMware Firewall license", "properties": { "broadcomContractNumber": { "type": "string", "description": "The Broadcom contract number associated with the license." }, "broadcomSiteId": { "type": "string", "description": "The Broadcom site ID associated with the license." }, "cores": { "type": "integer", "description": "Number of cores included in the license, measured per hour" }, "endDate": { "type": "string", "description": "UTC datetime when the license expires" }, "kind": { "type": "string", "description": "The kind of license.\nExpected value is 'VmwareFirewall'.", "const": "VmwareFirewall" }, "labels": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:avs:Label" }, "description": "Additional labels passed through for license reporting." }, "licenseKey": { "type": "string", "description": "License key" } }, "type": "object", "required": [ "cores", "endDate", "kind" ] }, "azure-native:avs:VmwareFirewallLicensePropertiesResponse": { "description": "The properties of a VMware Firewall license", "properties": { "broadcomContractNumber": { "type": "string", "description": "The Broadcom contract number associated with the license." }, "broadcomSiteId": { "type": "string", "description": "The Broadcom site ID associated with the license." }, "cores": { "type": "integer", "description": "Number of cores included in the license, measured per hour" }, "endDate": { "type": "string", "description": "UTC datetime when the license expires" }, "kind": { "type": "string", "description": "The kind of license.\nExpected value is 'VmwareFirewall'.", "const": "VmwareFirewall" }, "labels": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:avs:LabelResponse" }, "description": "Additional labels passed through for license reporting." }, "licenseKey": { "type": "string", "description": "License key" }, "provisioningState": { "type": "string", "description": "The state of the license provisioning" } }, "type": "object", "required": [ "cores", "endDate", "kind", "provisioningState" ] }, "azure-native:avs:WorkloadNetworkDhcpRelay": { "description": "NSX DHCP Relay", "properties": { "dhcpType": { "type": "string", "description": "Type of DHCP: SERVER or RELAY.\nExpected value is 'RELAY'.", "const": "RELAY" }, "displayName": { "type": "string", "description": "Display name of the DHCP entity." }, "revision": { "type": "number", "description": "NSX revision number." }, "serverAddresses": { "type": "array", "items": { "type": "string" }, "description": "DHCP Relay Addresses. Max 3." } }, "type": "object", "required": [ "dhcpType" ] }, "azure-native:avs:WorkloadNetworkDhcpRelayResponse": { "description": "NSX DHCP Relay", "properties": { "dhcpType": { "type": "string", "description": "Type of DHCP: SERVER or RELAY.\nExpected value is 'RELAY'.", "const": "RELAY" }, "displayName": { "type": "string", "description": "Display name of the DHCP entity." }, "provisioningState": { "type": "string", "description": "The provisioning state" }, "revision": { "type": "number", "description": "NSX revision number." }, "segments": { "type": "array", "items": { "type": "string" }, "description": "NSX Segments consuming DHCP." }, "serverAddresses": { "type": "array", "items": { "type": "string" }, "description": "DHCP Relay Addresses. Max 3." } }, "type": "object", "required": [ "dhcpType", "provisioningState", "segments" ] }, "azure-native:avs:WorkloadNetworkDhcpServer": { "description": "NSX DHCP Server", "properties": { "dhcpType": { "type": "string", "description": "Type of DHCP: SERVER or RELAY.\nExpected value is 'SERVER'.", "const": "SERVER" }, "displayName": { "type": "string", "description": "Display name of the DHCP entity." }, "leaseTime": { "type": "number", "description": "DHCP Server Lease Time." }, "revision": { "type": "number", "description": "NSX revision number." }, "serverAddress": { "type": "string", "description": "DHCP Server Address." } }, "type": "object", "required": [ "dhcpType" ] }, "azure-native:avs:WorkloadNetworkDhcpServerResponse": { "description": "NSX DHCP Server", "properties": { "dhcpType": { "type": "string", "description": "Type of DHCP: SERVER or RELAY.\nExpected value is 'SERVER'.", "const": "SERVER" }, "displayName": { "type": "string", "description": "Display name of the DHCP entity." }, "leaseTime": { "type": "number", "description": "DHCP Server Lease Time." }, "provisioningState": { "type": "string", "description": "The provisioning state" }, "revision": { "type": "number", "description": "NSX revision number." }, "segments": { "type": "array", "items": { "type": "string" }, "description": "NSX Segments consuming DHCP." }, "serverAddress": { "type": "string", "description": "DHCP Server Address." } }, "type": "object", "required": [ "dhcpType", "provisioningState", "segments" ] }, "azure-native:avs:WorkloadNetworkSegmentPortVifResponse": { "description": "Ports and any VIF attached to segment.", "properties": { "portName": { "type": "string", "description": "Name of port or VIF attached to segment." } }, "type": "object" }, "azure-native:avs:WorkloadNetworkSegmentSubnet": { "description": "Subnet configuration for segment", "properties": { "dhcpRanges": { "type": "array", "items": { "type": "string" }, "description": "DHCP Range assigned for subnet." }, "gatewayAddress": { "type": "string", "description": "Gateway address." } }, "type": "object" }, "azure-native:avs:WorkloadNetworkSegmentSubnetResponse": { "description": "Subnet configuration for segment", "properties": { "dhcpRanges": { "type": "array", "items": { "type": "string" }, "description": "DHCP Range assigned for subnet." }, "gatewayAddress": { "type": "string", "description": "Gateway address." } }, "type": "object" }, "azure-native:awsconnector:AbortIncompleteMultipartUpload": { "description": "Definition of AbortIncompleteMultipartUpload", "properties": { "daysAfterInitiation": { "type": "integer", "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload." } }, "type": "object" }, "azure-native:awsconnector:AbortIncompleteMultipartUploadResponse": { "description": "Definition of AbortIncompleteMultipartUpload", "properties": { "daysAfterInitiation": { "type": "integer", "description": "Specifies the number of days after which Amazon S3 stops an incomplete multipart upload." } }, "type": "object" }, "azure-native:awsconnector:AccelerateConfiguration": { "description": "Definition of AccelerateConfiguration", "properties": { "accelerationStatus": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AccelerateConfigurationAccelerationStatus" } ], "description": "Specifies the transfer acceleration status of the bucket." } }, "type": "object" }, "azure-native:awsconnector:AccelerateConfigurationAccelerationStatus": { "description": "Specifies the transfer acceleration status of the bucket.", "type": "string", "enum": [ { "name": "Enabled", "description": "AccelerateConfigurationAccelerationStatus enum Enabled", "value": "Enabled" }, { "name": "Suspended", "description": "AccelerateConfigurationAccelerationStatus enum Suspended", "value": "Suspended" } ] }, "azure-native:awsconnector:AccelerateConfigurationResponse": { "description": "Definition of AccelerateConfiguration", "properties": { "accelerationStatus": { "type": "string", "description": "Specifies the transfer acceleration status of the bucket." } }, "type": "object" }, "azure-native:awsconnector:AcceleratorCountRequest": { "description": "Definition of AcceleratorCountRequest", "properties": { "max": { "type": "integer", "description": "The maximum value." }, "min": { "type": "integer", "description": "The minimum value." } }, "type": "object" }, "azure-native:awsconnector:AcceleratorCountRequestResponse": { "description": "Definition of AcceleratorCountRequest", "properties": { "max": { "type": "integer", "description": "The maximum value." }, "min": { "type": "integer", "description": "The minimum value." } }, "type": "object" }, "azure-native:awsconnector:AcceleratorTotalMemoryMiBRequest": { "description": "Definition of AcceleratorTotalMemoryMiBRequest", "properties": { "max": { "type": "integer", "description": "The memory maximum in MiB." }, "min": { "type": "integer", "description": "The memory minimum in MiB." } }, "type": "object" }, "azure-native:awsconnector:AcceleratorTotalMemoryMiBRequestResponse": { "description": "Definition of AcceleratorTotalMemoryMiBRequest", "properties": { "max": { "type": "integer", "description": "The memory maximum in MiB." }, "min": { "type": "integer", "description": "The memory minimum in MiB." } }, "type": "object" }, "azure-native:awsconnector:AccessAnalyzerAnalyzerProperties": { "description": "Definition of AccessAnalyzerAnalyzer", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAccessAnalyzerAnalyzerProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:AccessAnalyzerAnalyzerPropertiesResponse": { "description": "Definition of AccessAnalyzerAnalyzer", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAccessAnalyzerAnalyzerPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:AccessConfigResponse": { "description": "Definition of AccessConfigResponse", "properties": { "authenticationMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticationModeEnumValue", "description": "\u003cp\u003eThe current authentication mode of the cluster.\u003c/p\u003e" }, "bootstrapClusterCreatorAdminPermissions": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AccessConfigResponseResponse": { "description": "Definition of AccessConfigResponse", "properties": { "authenticationMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticationModeEnumValueResponse", "description": "\u003cp\u003eThe current authentication mode of the cluster.\u003c/p\u003e" }, "bootstrapClusterCreatorAdminPermissions": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AccessControl": { "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*.", "type": "string", "enum": [ { "name": "AuthenticatedRead", "description": "AccessControl enum AuthenticatedRead", "value": "AuthenticatedRead" }, { "name": "AwsExecRead", "description": "AccessControl enum AwsExecRead", "value": "AwsExecRead" }, { "name": "BucketOwnerFullControl", "description": "AccessControl enum BucketOwnerFullControl", "value": "BucketOwnerFullControl" }, { "name": "BucketOwnerRead", "description": "AccessControl enum BucketOwnerRead", "value": "BucketOwnerRead" }, { "name": "LogDeliveryWrite", "description": "AccessControl enum LogDeliveryWrite", "value": "LogDeliveryWrite" }, { "name": "Private", "description": "AccessControl enum Private", "value": "Private" }, { "name": "PublicRead", "description": "AccessControl enum PublicRead", "value": "PublicRead" }, { "name": "PublicReadWrite", "description": "AccessControl enum PublicReadWrite", "value": "PublicReadWrite" } ] }, "azure-native:awsconnector:AccessControlTranslation": { "description": "Definition of AccessControlTranslation", "properties": { "owner": { "type": "string", "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*." } }, "type": "object" }, "azure-native:awsconnector:AccessControlTranslationResponse": { "description": "Definition of AccessControlTranslation", "properties": { "owner": { "type": "string", "description": "Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*." } }, "type": "object" }, "azure-native:awsconnector:AccessLogSetting": { "description": "Definition of AccessLogSetting", "properties": { "destinationArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging." }, "format": { "type": "string", "description": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging." } }, "type": "object" }, "azure-native:awsconnector:AccessLogSettingResponse": { "description": "Definition of AccessLogSetting", "properties": { "destinationArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging." }, "format": { "type": "string", "description": "A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging." } }, "type": "object" }, "azure-native:awsconnector:AccessRules": { "description": "Definition of AccessRules", "properties": { "allowPublicOverrides": { "type": "boolean", "description": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified." }, "getObject": { "type": "string", "description": "Specifies the anonymous access to all objects in a bucket." } }, "type": "object" }, "azure-native:awsconnector:AccessRulesResponse": { "description": "Definition of AccessRules", "properties": { "allowPublicOverrides": { "type": "boolean", "description": "A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified." }, "getObject": { "type": "string", "description": "Specifies the anonymous access to all objects in a bucket." } }, "type": "object" }, "azure-native:awsconnector:AccountAttributeValue": { "description": "Definition of AccountAttributeValue", "properties": { "attributeValue": { "type": "string", "description": "\u003cp\u003eThe value of the attribute.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AccountAttributeValueResponse": { "description": "Definition of AccountAttributeValue", "properties": { "attributeValue": { "type": "string", "description": "\u003cp\u003eThe value of the attribute.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AcmCertificateSummaryProperties": { "description": "Definition of AcmCertificateSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAcmCertificateSummaryProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:AcmCertificateSummaryPropertiesResponse": { "description": "Definition of AcmCertificateSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAcmCertificateSummaryPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Action": { "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.", "type": "string", "enum": [ { "name": "ALLOW", "description": "Action enum ALLOW", "value": "ALLOW" }, { "name": "BLOCK", "description": "Action enum BLOCK", "value": "BLOCK" }, { "name": "CAPTCHA", "description": "Action enum CAPTCHA", "value": "CAPTCHA" }, { "name": "CHALLENGE", "description": "Action enum CHALLENGE", "value": "CHALLENGE" }, { "name": "COUNT", "description": "Action enum COUNT", "value": "COUNT" }, { "name": "EXCLUDED_AS_COUNT", "description": "Action enum EXCLUDED_AS_COUNT", "value": "EXCLUDED_AS_COUNT" } ] }, "azure-native:awsconnector:ActionConditionModelProperties": { "description": "Definition of ActionConditionModelProperties", "properties": { "action": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Action" } ], "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." } }, "type": "object" }, "azure-native:awsconnector:ActionConditionModelPropertiesResponse": { "description": "Definition of ActionConditionModelProperties", "properties": { "action": { "type": "string", "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." } }, "type": "object" }, "azure-native:awsconnector:ActionDefinition": { "description": "Definition of ActionDefinition", "properties": { "publishMetricAction": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublishMetricAction", "description": "Property publishMetricAction" } }, "type": "object" }, "azure-native:awsconnector:ActionDefinitionResponse": { "description": "Definition of ActionDefinition", "properties": { "publishMetricAction": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublishMetricActionResponse", "description": "Property publishMetricAction" } }, "type": "object" }, "azure-native:awsconnector:ActionDefinitionResponseV1": { "description": "Definition of ActionDefinition", "properties": { "publishMetricAction": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublishMetricActionResponseV1", "description": "Property publishMetricAction" } }, "type": "object" }, "azure-native:awsconnector:ActionResponse": { "description": "Definition of Action", "properties": { "authenticateCognitoConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticateCognitoConfigResponse", "description": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``. Specifies information required when integrating with Amazon Cognito to authenticate users." }, "authenticateOidcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticateOidcConfigResponse", "description": "[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``. Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users." }, "fixedResponseConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FixedResponseConfigResponse", "description": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``. Specifies information required when returning a custom HTTP response." }, "forwardConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ForwardConfigResponse", "description": "Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``." }, "order": { "type": "integer", "description": "The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first." }, "redirectConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RedirectConfigResponse", "description": "[Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``. Information about a redirect action. A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. You can reuse URI components using the following reserved keywords: + #{protocol} + #{host} + #{port} + #{path} (the leading '/' is removed) + #{query} For example, you can change the path to '/new/#{path}', the hostname to 'example.#{host}', or the query to '#{query}\u0026value=xyz'." }, "targetGroupArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead." }, "type": { "type": "string", "description": "The type of action." } }, "type": "object" }, "azure-native:awsconnector:ActiveModel": { "description": "Definition of Active", "properties": { "active": { "type": "boolean", "description": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order." } }, "type": "object" }, "azure-native:awsconnector:ActiveModelResponse": { "description": "Definition of Active", "properties": { "active": { "type": "boolean", "description": "When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order." } }, "type": "object" }, "azure-native:awsconnector:AddOn": { "description": "Definition of AddOn", "properties": { "addOnType": { "type": "string", "description": "The add-on type" }, "autoSnapshotAddOnRequest": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoSnapshotAddOn", "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AddOnStatus" } ], "description": "Status of the Addon" } }, "type": "object" }, "azure-native:awsconnector:AddOnResponse": { "description": "Definition of AddOn", "properties": { "addOnType": { "type": "string", "description": "The add-on type" }, "autoSnapshotAddOnRequest": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoSnapshotAddOnResponse", "description": "An object that represents additional parameters when enabling or modifying the automatic snapshot add-on" }, "status": { "type": "string", "description": "Status of the Addon" } }, "type": "object" }, "azure-native:awsconnector:AddOnStatus": { "description": "Status of the Addon", "type": "string", "enum": [ { "name": "Disabled", "description": "AddOnStatus enum Disabled", "value": "Disabled" }, { "name": "Disabling", "description": "AddOnStatus enum Disabling", "value": "Disabling" }, { "name": "Enabled", "description": "AddOnStatus enum Enabled", "value": "Enabled" }, { "name": "Enabling", "description": "AddOnStatus enum Enabling", "value": "Enabling" }, { "name": "Failed", "description": "AddOnStatus enum Failed", "value": "Failed" }, { "name": "Terminated", "description": "AddOnStatus enum Terminated", "value": "Terminated" }, { "name": "Terminating", "description": "AddOnStatus enum Terminating", "value": "Terminating" } ] }, "azure-native:awsconnector:AdditionalAuthenticationProvider": { "description": "Definition of AdditionalAuthenticationProvider", "properties": { "authenticationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticationTypeEnumValue", "description": "\u003cp\u003eThe authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.\u003c/p\u003e" }, "lambdaAuthorizerConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaAuthorizerConfig", "description": "\u003cp\u003eConfiguration for Lambda function authorization.\u003c/p\u003e" }, "openIDConnectConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenIDConnectConfig", "description": "\u003cp\u003eThe OIDC configuration.\u003c/p\u003e" }, "userPoolConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CognitoUserPoolConfig", "description": "\u003cp\u003eThe Amazon Cognito user pool configuration.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AdditionalAuthenticationProviderResponse": { "description": "Definition of AdditionalAuthenticationProvider", "properties": { "authenticationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticationTypeEnumValueResponse", "description": "\u003cp\u003eThe authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.\u003c/p\u003e" }, "lambdaAuthorizerConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaAuthorizerConfigResponse", "description": "\u003cp\u003eConfiguration for Lambda function authorization.\u003c/p\u003e" }, "openIDConnectConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenIDConnectConfigResponse", "description": "\u003cp\u003eThe OIDC configuration.\u003c/p\u003e" }, "userPoolConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CognitoUserPoolConfigResponse", "description": "\u003cp\u003eThe Amazon Cognito user pool configuration.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Address": { "description": "Definition of Address", "properties": { "addressDefinition": { "type": "string", "description": "Property addressDefinition" } }, "type": "object" }, "azure-native:awsconnector:AddressResponse": { "description": "Definition of Address", "properties": { "addressDefinition": { "type": "string", "description": "Property addressDefinition" } }, "type": "object" }, "azure-native:awsconnector:AdvancedEventSelector": { "description": "Definition of AdvancedEventSelector", "properties": { "fieldSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdvancedFieldSelector" }, "description": "Contains all selector statements in an advanced event selector." }, "name": { "type": "string", "description": "An optional, descriptive name for an advanced event selector, such as 'Log data events for only two S3 buckets'." } }, "type": "object" }, "azure-native:awsconnector:AdvancedEventSelectorResponse": { "description": "Definition of AdvancedEventSelector", "properties": { "fieldSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdvancedFieldSelectorResponse" }, "description": "Contains all selector statements in an advanced event selector." }, "name": { "type": "string", "description": "An optional, descriptive name for an advanced event selector, such as 'Log data events for only two S3 buckets'." } }, "type": "object" }, "azure-native:awsconnector:AdvancedFieldSelector": { "description": "Definition of AdvancedFieldSelector", "properties": { "endsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field." }, "equals": { "type": "array", "items": { "type": "string" }, "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields." }, "field": { "type": "string", "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN." }, "notEndsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field." }, "notEquals": { "type": "array", "items": { "type": "string" }, "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field." }, "notStartsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field." }, "startsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field." } }, "type": "object" }, "azure-native:awsconnector:AdvancedFieldSelectorResponse": { "description": "Definition of AdvancedFieldSelector", "properties": { "endsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that includes events that match the last few characters of the event record field specified as the value of Field." }, "equals": { "type": "array", "items": { "type": "string" }, "description": "An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields." }, "field": { "type": "string", "description": "A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN." }, "notEndsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that excludes events that match the last few characters of the event record field specified as the value of Field." }, "notEquals": { "type": "array", "items": { "type": "string" }, "description": "An operator that excludes events that match the exact value of the event record field specified as the value of Field." }, "notStartsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that excludes events that match the first few characters of the event record field specified as the value of Field." }, "startsWith": { "type": "array", "items": { "type": "string" }, "description": "An operator that includes events that match the first few characters of the event record field specified as the value of Field." } }, "type": "object" }, "azure-native:awsconnector:AdvancedSecurityOptions": { "description": "Definition of AdvancedSecurityOptions", "properties": { "anonymousAuthDisableDate": { "type": "string", "description": "\u003cp\u003eDate and time when the migration period will be disabled. Only necessary when \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'\u003eenabling fine-grained access control on an existing domain\u003c/a\u003e.\u003c/p\u003e" }, "anonymousAuthEnabled": { "type": "boolean", "description": "\u003cp\u003eTrue if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'\u003eenabling fine-grained access control on an existing domain\u003c/a\u003e.\u003c/p\u003e" }, "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue if fine-grained access control is enabled.\u003c/p\u003e" }, "internalUserDatabaseEnabled": { "type": "boolean", "description": "\u003cp\u003eTrue if the internal user database is enabled.\u003c/p\u003e" }, "samlOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SAMLOptionsOutput", "description": "\u003cp\u003eContainer for information about the SAML configuration for OpenSearch Dashboards.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AdvancedSecurityOptionsResponse": { "description": "Definition of AdvancedSecurityOptions", "properties": { "anonymousAuthDisableDate": { "type": "string", "description": "\u003cp\u003eDate and time when the migration period will be disabled. Only necessary when \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'\u003eenabling fine-grained access control on an existing domain\u003c/a\u003e.\u003c/p\u003e" }, "anonymousAuthEnabled": { "type": "boolean", "description": "\u003cp\u003eTrue if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/fgac.html#fgac-enabling-existing'\u003eenabling fine-grained access control on an existing domain\u003c/a\u003e.\u003c/p\u003e" }, "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue if fine-grained access control is enabled.\u003c/p\u003e" }, "internalUserDatabaseEnabled": { "type": "boolean", "description": "\u003cp\u003eTrue if the internal user database is enabled.\u003c/p\u003e" }, "samlOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SAMLOptionsOutputResponse", "description": "\u003cp\u003eContainer for information about the SAML configuration for OpenSearch Dashboards.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AliasTarget": { "description": "Definition of AliasTarget", "properties": { "dnsName": { "type": "string", "description": "\u003cp\u003e \u003ci\u003eAlias resource record sets only:\u003c/i\u003e The value that you specify depends on where you want to route queries:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eAmazon API Gateway custom regional APIs and edge-optimized APIs\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the applicable domain name for your API. You can get the applicable value using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'\u003eget-domain-names\u003c/a\u003e:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor regional APIs, specify the value of \u003ccode\u003eregionalDomainName\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor edge-optimized APIs, specify the value of \u003ccode\u003edistributionDomainName\u003c/code\u003e. This is the name of the associated CloudFront distribution, such as \u003ccode\u003eda1b2c3d4e5.cloudfront.net\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eThe name of the record that you're creating must match a custom domain name for your API, such as \u003ccode\u003eapi.example.com\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eAmazon Virtual Private Cloud interface VPC endpoint\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eEnter the API endpoint for the interface endpoint, such as \u003ccode\u003evpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com\u003c/code\u003e. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of \u003ccode\u003eDnsName\u003c/code\u003e using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'\u003edescribe-vpc-endpoints\u003c/a\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eCloudFront distribution\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the domain name that CloudFront assigned when you created your distribution.\u003c/p\u003e \u003cp\u003eYour CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is \u003ci\u003eacme.example.com\u003c/i\u003e, your CloudFront distribution must include \u003ci\u003eacme.example.com\u003c/i\u003e as one of the alternate domain names. For more information, see \u003ca href='https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html'\u003eUsing Alternate Domain Names (CNAMEs)\u003c/a\u003e in the \u003ci\u003eAmazon CloudFront Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eYou can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eFor failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. \u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eElastic Beanstalk environment\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eIf the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name \u003ccode\u003emy-environment.\u003ci\u003eus-west-2\u003c/i\u003e.elasticbeanstalk.com\u003c/code\u003e is a regionalized domain name. \u003c/p\u003e \u003cimportant\u003e \u003cp\u003eFor environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.\u003c/p\u003e \u003c/important\u003e \u003cp\u003eFor Elastic Beanstalk environments that have regionalized subdomains, specify the \u003ccode\u003eCNAME\u003c/code\u003e attribute for the environment. You can use the following methods to get the value of the CNAME attribute:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ci\u003eAmazon Web Services Management Console\u003c/i\u003e: For information about how to get the value by using the console, see \u003ca href='https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html'\u003eUsing Custom Domains with Elastic Beanstalk\u003c/a\u003e in the \u003ci\u003eElastic Beanstalk Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ci\u003eElastic Beanstalk API\u003c/i\u003e: Use the \u003ccode\u003eDescribeEnvironments\u003c/code\u003e action to get the value of the \u003ccode\u003eCNAME\u003c/code\u003e attribute. For more information, see \u003ca href='https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html'\u003eDescribeEnvironments\u003c/a\u003e in the \u003ci\u003eElastic Beanstalk API Reference\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ci\u003eCLI\u003c/i\u003e: Use the \u003ccode\u003edescribe-environments\u003c/code\u003e command to get the value of the \u003ccode\u003eCNAME\u003c/code\u003e attribute. For more information, see \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html'\u003edescribe-environments\u003c/a\u003e in the \u003ci\u003eCLI Command Reference\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eELB load balancer\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI. \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon Web Services Management Console\u003c/b\u003e: Go to the EC2 page, choose \u003cb\u003eLoad Balancers\u003c/b\u003e in the navigation pane, choose the load balancer, choose the \u003cb\u003eDescription\u003c/b\u003e tab, and get the value of the \u003cb\u003eDNS name\u003c/b\u003e field. \u003c/p\u003e \u003cp\u003eIf you're routing traffic to a Classic Load Balancer, get the value that begins with \u003cb\u003edualstack\u003c/b\u003e. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eElastic Load Balancing API\u003c/b\u003e: Use \u003ccode\u003eDescribeLoadBalancers\u003c/code\u003e to get the value of \u003ccode\u003eDNSName\u003c/code\u003e. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCLI\u003c/b\u003e: Use \u003ccode\u003edescribe-load-balancers\u003c/code\u003e to get the value of \u003ccode\u003eDNSName\u003c/code\u003e. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eGlobal Accelerator accelerator\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the DNS name for your accelerator:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eGlobal Accelerator API:\u003c/b\u003e To get the DNS name, use \u003ca href='https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html'\u003eDescribeAccelerator\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCLI:\u003c/b\u003e To get the DNS name, use \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html'\u003edescribe-accelerator\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eAmazon S3 bucket that is configured as a static website\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, \u003ccode\u003es3-website.us-east-2.amazonaws.com\u003c/code\u003e. For more information about valid values, see the table \u003ca href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'\u003eAmazon S3 Website Endpoints\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e. For more information about using S3 buckets for websites, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html'\u003eGetting Started with Amazon Route 53\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide.\u003c/i\u003e \u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eAnother Route 53 resource record set\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the value of the \u003ccode\u003eName\u003c/code\u003e element for a resource record set in the current hosted zone.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of \u003ccode\u003eType\u003c/code\u003e is \u003ccode\u003eCNAME\u003c/code\u003e. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.\u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "evaluateTargetHealth": { "type": "boolean", "description": "\u003cp\u003e \u003ci\u003eApplies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:\u003c/i\u003e When \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e is \u003ccode\u003etrue\u003c/code\u003e, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.\u003c/p\u003e \u003cp\u003eNote the following:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eCloudFront distributions\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eYou can't set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e when the alias target is a CloudFront distribution.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eElastic Beanstalk environments that have regionalized subdomains\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eIf you specify an Elastic Beanstalk environment in \u003ccode\u003eDNSName\u003c/code\u003e and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. \u003c/p\u003e \u003cp\u003eIf the environment contains a single Amazon EC2 instance, there are no special requirements.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eELB load balancers\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eHealth checking behavior depends on the type of load balancer:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eClassic Load Balancers\u003c/b\u003e: If you specify an ELB Classic Load Balancer in \u003ccode\u003eDNSName\u003c/code\u003e, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eApplication and Network Load Balancers\u003c/b\u003e: If you specify an ELB Application or Network Load Balancer and you set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eA target group that has no registered targets is considered unhealthy.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eWhen you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. \u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eS3 buckets\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThere are no special requirements for setting \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e when the alias target is an S3 bucket.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eOther records in the same hosted zone\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eIf the Amazon Web Services resource that you specify in \u003ccode\u003eDNSName\u003c/code\u003e is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting'\u003eWhat Happens When You Omit Health Checks?\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e \u003cp\u003eFor more information and examples, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'\u003eAmazon Route 53 Health Checks and DNS Failover\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e" }, "hostedZoneId": { "type": "string", "description": "\u003cp\u003e \u003ci\u003eAlias resource records sets only\u003c/i\u003e: The value used depends on where you want to route traffic:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eAmazon API Gateway custom regional APIs and edge-optimized APIs\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for your API. You can get the applicable value using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'\u003eget-domain-names\u003c/a\u003e:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor regional APIs, specify the value of \u003ccode\u003eregionalHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor edge-optimized APIs, specify the value of \u003ccode\u003edistributionHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eAmazon Virtual Private Cloud interface VPC endpoint\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for your interface endpoint. You can get the value of \u003ccode\u003eHostedZoneId\u003c/code\u003e using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'\u003edescribe-vpc-endpoints\u003c/a\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eCloudFront distribution\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify \u003ccode\u003eZ2FDTNDATAQYW2\u003c/code\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eAlias resource record sets for CloudFront can't be created in a private zone.\u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eElastic Beanstalk environment\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html'\u003eElastic Beanstalk endpoints and quotas\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eELB load balancer\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/general/latest/gr/elb.html'\u003eElastic Load Balancing endpoints and quotas\u003c/a\u003e topic in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon Web Services Management Console\u003c/b\u003e: Go to the Amazon EC2 page, choose \u003cb\u003eLoad Balancers\u003c/b\u003e in the navigation pane, select the load balancer, and get the value of the \u003cb\u003eHosted zone\u003c/b\u003e field on the \u003cb\u003eDescription\u003c/b\u003e tab.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eElastic Load Balancing API\u003c/b\u003e: Use \u003ccode\u003eDescribeLoadBalancers\u003c/code\u003e to get the applicable value. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: Use \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneNameId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: Use \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCLI\u003c/b\u003e: Use \u003ccode\u003edescribe-load-balancers\u003c/code\u003e to get the applicable value. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: Use \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneNameId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: Use \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eGlobal Accelerator accelerator\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify \u003ccode\u003eZ2BJ6XQ5FK7U4H\u003c/code\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eAn Amazon S3 bucket configured as a static website\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table \u003ca href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'\u003eAmazon S3 Website Endpoints\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eAnother Route 53 resource record set in your hosted zone\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" } }, "type": "object" }, "azure-native:awsconnector:AliasTargetResponse": { "description": "Definition of AliasTarget", "properties": { "dnsName": { "type": "string", "description": "\u003cp\u003e \u003ci\u003eAlias resource record sets only:\u003c/i\u003e The value that you specify depends on where you want to route queries:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eAmazon API Gateway custom regional APIs and edge-optimized APIs\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the applicable domain name for your API. You can get the applicable value using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'\u003eget-domain-names\u003c/a\u003e:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor regional APIs, specify the value of \u003ccode\u003eregionalDomainName\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor edge-optimized APIs, specify the value of \u003ccode\u003edistributionDomainName\u003c/code\u003e. This is the name of the associated CloudFront distribution, such as \u003ccode\u003eda1b2c3d4e5.cloudfront.net\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eThe name of the record that you're creating must match a custom domain name for your API, such as \u003ccode\u003eapi.example.com\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eAmazon Virtual Private Cloud interface VPC endpoint\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eEnter the API endpoint for the interface endpoint, such as \u003ccode\u003evpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com\u003c/code\u003e. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of \u003ccode\u003eDnsName\u003c/code\u003e using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'\u003edescribe-vpc-endpoints\u003c/a\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eCloudFront distribution\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the domain name that CloudFront assigned when you created your distribution.\u003c/p\u003e \u003cp\u003eYour CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is \u003ci\u003eacme.example.com\u003c/i\u003e, your CloudFront distribution must include \u003ci\u003eacme.example.com\u003c/i\u003e as one of the alternate domain names. For more information, see \u003ca href='https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/CNAMEs.html'\u003eUsing Alternate Domain Names (CNAMEs)\u003c/a\u003e in the \u003ci\u003eAmazon CloudFront Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eYou can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eFor failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution. \u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eElastic Beanstalk environment\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eIf the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name \u003ccode\u003emy-environment.\u003ci\u003eus-west-2\u003c/i\u003e.elasticbeanstalk.com\u003c/code\u003e is a regionalized domain name. \u003c/p\u003e \u003cimportant\u003e \u003cp\u003eFor environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.\u003c/p\u003e \u003c/important\u003e \u003cp\u003eFor Elastic Beanstalk environments that have regionalized subdomains, specify the \u003ccode\u003eCNAME\u003c/code\u003e attribute for the environment. You can use the following methods to get the value of the CNAME attribute:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ci\u003eAmazon Web Services Management Console\u003c/i\u003e: For information about how to get the value by using the console, see \u003ca href='https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/customdomains.html'\u003eUsing Custom Domains with Elastic Beanstalk\u003c/a\u003e in the \u003ci\u003eElastic Beanstalk Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ci\u003eElastic Beanstalk API\u003c/i\u003e: Use the \u003ccode\u003eDescribeEnvironments\u003c/code\u003e action to get the value of the \u003ccode\u003eCNAME\u003c/code\u003e attribute. For more information, see \u003ca href='https://docs.aws.amazon.com/elasticbeanstalk/latest/api/API_DescribeEnvironments.html'\u003eDescribeEnvironments\u003c/a\u003e in the \u003ci\u003eElastic Beanstalk API Reference\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ci\u003eCLI\u003c/i\u003e: Use the \u003ccode\u003edescribe-environments\u003c/code\u003e command to get the value of the \u003ccode\u003eCNAME\u003c/code\u003e attribute. For more information, see \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/elasticbeanstalk/describe-environments.html'\u003edescribe-environments\u003c/a\u003e in the \u003ci\u003eCLI Command Reference\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eELB load balancer\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI. \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon Web Services Management Console\u003c/b\u003e: Go to the EC2 page, choose \u003cb\u003eLoad Balancers\u003c/b\u003e in the navigation pane, choose the load balancer, choose the \u003cb\u003eDescription\u003c/b\u003e tab, and get the value of the \u003cb\u003eDNS name\u003c/b\u003e field. \u003c/p\u003e \u003cp\u003eIf you're routing traffic to a Classic Load Balancer, get the value that begins with \u003cb\u003edualstack\u003c/b\u003e. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eElastic Load Balancing API\u003c/b\u003e: Use \u003ccode\u003eDescribeLoadBalancers\u003c/code\u003e to get the value of \u003ccode\u003eDNSName\u003c/code\u003e. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCLI\u003c/b\u003e: Use \u003ccode\u003edescribe-load-balancers\u003c/code\u003e to get the value of \u003ccode\u003eDNSName\u003c/code\u003e. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eGlobal Accelerator accelerator\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the DNS name for your accelerator:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eGlobal Accelerator API:\u003c/b\u003e To get the DNS name, use \u003ca href='https://docs.aws.amazon.com/global-accelerator/latest/api/API_DescribeAccelerator.html'\u003eDescribeAccelerator\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCLI:\u003c/b\u003e To get the DNS name, use \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/globalaccelerator/describe-accelerator.html'\u003edescribe-accelerator\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eAmazon S3 bucket that is configured as a static website\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, \u003ccode\u003es3-website.us-east-2.amazonaws.com\u003c/code\u003e. For more information about valid values, see the table \u003ca href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'\u003eAmazon S3 Website Endpoints\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e. For more information about using S3 buckets for websites, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/getting-started.html'\u003eGetting Started with Amazon Route 53\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide.\u003c/i\u003e \u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eAnother Route 53 resource record set\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the value of the \u003ccode\u003eName\u003c/code\u003e element for a resource record set in the current hosted zone.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of \u003ccode\u003eType\u003c/code\u003e is \u003ccode\u003eCNAME\u003c/code\u003e. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.\u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "evaluateTargetHealth": { "type": "boolean", "description": "\u003cp\u003e \u003ci\u003eApplies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:\u003c/i\u003e When \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e is \u003ccode\u003etrue\u003c/code\u003e, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.\u003c/p\u003e \u003cp\u003eNote the following:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eCloudFront distributions\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eYou can't set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e when the alias target is a CloudFront distribution.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eElastic Beanstalk environments that have regionalized subdomains\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eIf you specify an Elastic Beanstalk environment in \u003ccode\u003eDNSName\u003c/code\u003e and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any. \u003c/p\u003e \u003cp\u003eIf the environment contains a single Amazon EC2 instance, there are no special requirements.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eELB load balancers\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eHealth checking behavior depends on the type of load balancer:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eClassic Load Balancers\u003c/b\u003e: If you specify an ELB Classic Load Balancer in \u003ccode\u003eDNSName\u003c/code\u003e, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eApplication and Network Load Balancers\u003c/b\u003e: If you specify an ELB Application or Network Load Balancer and you set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eA target group that has no registered targets is considered unhealthy.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eWhen you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer. \u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eS3 buckets\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThere are no special requirements for setting \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e when the alias target is an S3 bucket.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eOther records in the same hosted zone\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eIf the Amazon Web Services resource that you specify in \u003ccode\u003eDNSName\u003c/code\u003e is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-complex-configs.html#dns-failover-complex-configs-hc-omitting'\u003eWhat Happens When You Omit Health Checks?\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e \u003cp\u003eFor more information and examples, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'\u003eAmazon Route 53 Health Checks and DNS Failover\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e" }, "hostedZoneId": { "type": "string", "description": "\u003cp\u003e \u003ci\u003eAlias resource records sets only\u003c/i\u003e: The value used depends on where you want to route traffic:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eAmazon API Gateway custom regional APIs and edge-optimized APIs\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for your API. You can get the applicable value using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/apigateway/get-domain-names.html'\u003eget-domain-names\u003c/a\u003e:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor regional APIs, specify the value of \u003ccode\u003eregionalHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor edge-optimized APIs, specify the value of \u003ccode\u003edistributionHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eAmazon Virtual Private Cloud interface VPC endpoint\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for your interface endpoint. You can get the value of \u003ccode\u003eHostedZoneId\u003c/code\u003e using the CLI command \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-vpc-endpoints.html'\u003edescribe-vpc-endpoints\u003c/a\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eCloudFront distribution\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify \u003ccode\u003eZ2FDTNDATAQYW2\u003c/code\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eAlias resource record sets for CloudFront can't be created in a private zone.\u003c/p\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eElastic Beanstalk environment\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/elasticbeanstalk.html'\u003eElastic Beanstalk endpoints and quotas\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eELB load balancer\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/general/latest/gr/elb.html'\u003eElastic Load Balancing endpoints and quotas\u003c/a\u003e topic in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon Web Services Management Console\u003c/b\u003e: Go to the Amazon EC2 page, choose \u003cb\u003eLoad Balancers\u003c/b\u003e in the navigation pane, select the load balancer, and get the value of the \u003cb\u003eHosted zone\u003c/b\u003e field on the \u003cb\u003eDescription\u003c/b\u003e tab.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eElastic Load Balancing API\u003c/b\u003e: Use \u003ccode\u003eDescribeLoadBalancers\u003c/code\u003e to get the applicable value. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: Use \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/2012-06-01/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneNameId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: Use \u003ca href='https://docs.aws.amazon.com/elasticloadbalancing/latest/APIReference/API_DescribeLoadBalancers.html'\u003eDescribeLoadBalancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCLI\u003c/b\u003e: Use \u003ccode\u003edescribe-load-balancers\u003c/code\u003e to get the applicable value. For more information, see the applicable guide:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eClassic Load Balancers: Use \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elb/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneNameId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eApplication and Network Load Balancers: Use \u003ca href='http://docs.aws.amazon.com/cli/latest/reference/elbv2/describe-load-balancers.html'\u003edescribe-load-balancers\u003c/a\u003e to get the value of \u003ccode\u003eCanonicalHostedZoneId\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003cdt\u003eGlobal Accelerator accelerator\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify \u003ccode\u003eZ2BJ6XQ5FK7U4H\u003c/code\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eAn Amazon S3 bucket configured as a static website\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table \u003ca href='https://docs.aws.amazon.com/general/latest/gr/s3.html#s3_website_region_endpoints'\u003eAmazon S3 Website Endpoints\u003c/a\u003e in the \u003ci\u003eAmazon Web Services General Reference\u003c/i\u003e.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eAnother Route 53 resource record set in your hosted zone\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSpecify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" } }, "type": "object" }, "azure-native:awsconnector:AmdSevSnpSpecification": { "description": "Property value", "type": "string", "enum": [ { "name": "Disabled", "description": "AmdSevSnpSpecification enum disabled", "value": "disabled" }, { "name": "Enabled", "description": "AmdSevSnpSpecification enum enabled", "value": "enabled" } ] }, "azure-native:awsconnector:AmdSevSnpSpecificationEnumValue": { "description": "Definition of AmdSevSnpSpecificationEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AmdSevSnpSpecification" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AmdSevSnpSpecificationEnumValueResponse": { "description": "Definition of AmdSevSnpSpecificationEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AnalyticsConfiguration": { "description": "Definition of AnalyticsConfiguration", "properties": { "id": { "type": "string", "description": "The ID that identifies the analytics configuration." }, "prefix": { "type": "string", "description": "The prefix that an object must have to be included in the analytics results." }, "storageClassAnalysis": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StorageClassAnalysis", "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilter" }, "description": "The tags to use when evaluating an analytics filter. The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis." } }, "type": "object" }, "azure-native:awsconnector:AnalyticsConfigurationResponse": { "description": "Definition of AnalyticsConfiguration", "properties": { "id": { "type": "string", "description": "The ID that identifies the analytics configuration." }, "prefix": { "type": "string", "description": "The prefix that an object must have to be included in the analytics results." }, "storageClassAnalysis": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StorageClassAnalysisResponse", "description": "Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilterResponse" }, "description": "The tags to use when evaluating an analytics filter. The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis." } }, "type": "object" }, "azure-native:awsconnector:AnomalyDetection": { "description": "Definition of AnomalyDetection", "properties": { "mitigationInEffect": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MitigationInEffectEnumEnumValue", "description": "\u003cp\u003eIndicates whether anomaly mitigation is in progress.\u003c/p\u003e" }, "result": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AnomalyResultEnumEnumValue", "description": "\u003cp\u003eThe latest anomaly detection result.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AnomalyDetectionResponse": { "description": "Definition of AnomalyDetection", "properties": { "mitigationInEffect": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MitigationInEffectEnumEnumValueResponse", "description": "\u003cp\u003eIndicates whether anomaly mitigation is in progress.\u003c/p\u003e" }, "result": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AnomalyResultEnumEnumValueResponse", "description": "\u003cp\u003eThe latest anomaly detection result.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AnomalyResultEnum": { "description": "Property value", "type": "string", "enum": [ { "name": "Anomalous", "description": "AnomalyResultEnum enum anomalous", "value": "anomalous" }, { "name": "Normal", "description": "AnomalyResultEnum enum normal", "value": "normal" } ] }, "azure-native:awsconnector:AnomalyResultEnumEnumValue": { "description": "Definition of AnomalyResultEnumEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AnomalyResultEnum" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AnomalyResultEnumEnumValueResponse": { "description": "Definition of AnomalyResultEnumEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ApiGatewayRestApiProperties": { "description": "Definition of ApiGatewayRestApi", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsApiGatewayRestApiProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ApiGatewayRestApiPropertiesResponse": { "description": "Definition of ApiGatewayRestApi", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsApiGatewayRestApiPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ApiGatewayStageProperties": { "description": "Definition of ApiGatewayStage", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsApiGatewayStageProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ApiGatewayStagePropertiesResponse": { "description": "Definition of ApiGatewayStage", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsApiGatewayStagePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:AppSyncGraphqlApiProperties": { "description": "Definition of AppSyncGraphqlApi", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAppSyncGraphqlApiProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:AppSyncGraphqlApiPropertiesResponse": { "description": "Definition of AppSyncGraphqlApi", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAppSyncGraphqlApiPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:AppType": { "description": "The type of app.", "type": "string", "enum": [ { "name": "Canvas", "description": "AppType enum Canvas", "value": "Canvas" }, { "name": "JupyterServer", "description": "AppType enum JupyterServer", "value": "JupyterServer" }, { "name": "KernelGateway", "description": "AppType enum KernelGateway", "value": "KernelGateway" }, { "name": "RSessionGateway", "description": "AppType enum RSessionGateway", "value": "RSessionGateway" }, { "name": "RStudioServerPro", "description": "AppType enum RStudioServerPro", "value": "RStudioServerPro" } ] }, "azure-native:awsconnector:Application": { "description": "Definition of Application", "properties": { "additionalInfo": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThis option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.\u003c/p\u003e" }, "args": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eArguments for Amazon EMR to pass to the application.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the application.\u003c/p\u003e" }, "version": { "type": "string", "description": "\u003cp\u003eThe version of the application.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ApplicationResourceLifecycleConfig": { "description": "Definition of ApplicationResourceLifecycleConfig", "properties": { "serviceRole": { "type": "string", "description": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value." }, "versionLifecycleConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ApplicationVersionLifecycleConfig", "description": "Defines lifecycle settings for application versions." } }, "type": "object" }, "azure-native:awsconnector:ApplicationResourceLifecycleConfigResponse": { "description": "Definition of ApplicationResourceLifecycleConfig", "properties": { "serviceRole": { "type": "string", "description": "The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value." }, "versionLifecycleConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ApplicationVersionLifecycleConfigResponse", "description": "Defines lifecycle settings for application versions." } }, "type": "object" }, "azure-native:awsconnector:ApplicationResponse": { "description": "Definition of Application", "properties": { "additionalInfo": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThis option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.\u003c/p\u003e" }, "args": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eArguments for Amazon EMR to pass to the application.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the application.\u003c/p\u003e" }, "version": { "type": "string", "description": "\u003cp\u003eThe version of the application.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ApplicationVersionLifecycleConfig": { "description": "Definition of ApplicationVersionLifecycleConfig", "properties": { "maxAgeRule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MaxAgeRule", "description": "Specify a max age rule to restrict the length of time that application versions are retained for an application." }, "maxCountRule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MaxCountRule", "description": "Specify a max count rule to restrict the number of application versions that are retained for an application." } }, "type": "object" }, "azure-native:awsconnector:ApplicationVersionLifecycleConfigResponse": { "description": "Definition of ApplicationVersionLifecycleConfig", "properties": { "maxAgeRule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MaxAgeRuleResponse", "description": "Specify a max age rule to restrict the length of time that application versions are retained for an application." }, "maxCountRule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MaxCountRuleResponse", "description": "Specify a max count rule to restrict the number of application versions that are retained for an application." } }, "type": "object" }, "azure-native:awsconnector:ArchitectureValues": { "description": "Property value", "type": "string", "enum": [ { "name": "Arm64", "description": "ArchitectureValues enum arm64", "value": "arm64" }, { "name": "Arm64_mac", "description": "ArchitectureValues enum arm64_mac", "value": "arm64_mac" }, { "name": "I386", "description": "ArchitectureValues enum i386", "value": "i386" }, { "name": "X86_64", "description": "ArchitectureValues enum x86_64", "value": "x86_64" }, { "name": "X86_64_mac", "description": "ArchitectureValues enum x86_64_mac", "value": "x86_64_mac" } ] }, "azure-native:awsconnector:ArchitectureValuesEnumValue": { "description": "Definition of ArchitectureValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ArchitectureValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ArchitectureValuesEnumValueResponse": { "description": "Definition of ArchitectureValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Architectures": { "description": "Architectures enum", "type": "string", "enum": [ { "name": "arm64", "description": "Architectures enum arm64", "value": "arm64" }, { "name": "x86_64", "description": "Architectures enum x86_64", "value": "x86_64" } ] }, "azure-native:awsconnector:ArchiveRule": { "description": "Definition of ArchiveRule", "properties": { "filter": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Filter" }, "description": "Property filter" }, "ruleName": { "type": "string", "description": "The archive rule name" } }, "type": "object" }, "azure-native:awsconnector:ArchiveRuleResponse": { "description": "Definition of ArchiveRule", "properties": { "filter": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FilterResponse" }, "description": "Property filter" }, "ruleName": { "type": "string", "description": "The archive rule name" } }, "type": "object" }, "azure-native:awsconnector:ArtifactNamespace": { "description": "Property value", "type": "string", "enum": [ { "name": "BUILD_ID", "description": "ArtifactNamespace enum BUILD_ID", "value": "BUILD_ID" }, { "name": "NONE", "description": "ArtifactNamespace enum NONE", "value": "NONE" } ] }, "azure-native:awsconnector:ArtifactNamespaceEnumValue": { "description": "Definition of ArtifactNamespaceEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ArtifactNamespace" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ArtifactNamespaceEnumValueResponse": { "description": "Definition of ArtifactNamespaceEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ArtifactPackaging": { "description": "Property value", "type": "string", "enum": [ { "name": "NONE", "description": "ArtifactPackaging enum NONE", "value": "NONE" }, { "name": "ZIP", "description": "ArtifactPackaging enum ZIP", "value": "ZIP" } ] }, "azure-native:awsconnector:ArtifactPackagingEnumValue": { "description": "Definition of ArtifactPackagingEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ArtifactPackaging" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ArtifactPackagingEnumValueResponse": { "description": "Definition of ArtifactPackagingEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ArtifactsType": { "description": "Property value", "type": "string", "enum": [ { "name": "CODEPIPELINE", "description": "ArtifactsType enum CODEPIPELINE", "value": "CODEPIPELINE" }, { "name": "NO_ARTIFACTS", "description": "ArtifactsType enum NO_ARTIFACTS", "value": "NO_ARTIFACTS" }, { "name": "S3", "description": "ArtifactsType enum S3", "value": "S3" } ] }, "azure-native:awsconnector:ArtifactsTypeEnumValue": { "description": "Definition of ArtifactsTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ArtifactsType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ArtifactsTypeEnumValueResponse": { "description": "Definition of ArtifactsTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AttachmentStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "Attached", "description": "AttachmentStatus enum attached", "value": "attached" }, { "name": "Attaching", "description": "AttachmentStatus enum attaching", "value": "attaching" }, { "name": "Detached", "description": "AttachmentStatus enum detached", "value": "detached" }, { "name": "Detaching", "description": "AttachmentStatus enum detaching", "value": "detaching" } ] }, "azure-native:awsconnector:AttachmentStatusEnumValue": { "description": "Definition of AttachmentStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AttachmentStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AttachmentStatusEnumValueResponse": { "description": "Definition of AttachmentStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AttributeDefinition": { "description": "Definition of AttributeDefinition", "properties": { "attributeName": { "type": "string", "description": "A name for the attribute." }, "attributeType": { "type": "string", "description": "The data type for the attribute, where: + ``S`` - the attribute is of type String + ``N`` - the attribute is of type Number + ``B`` - the attribute is of type Binary" } }, "type": "object" }, "azure-native:awsconnector:AttributeDefinitionResponse": { "description": "Definition of AttributeDefinition", "properties": { "attributeName": { "type": "string", "description": "A name for the attribute." }, "attributeType": { "type": "string", "description": "The data type for the attribute, where: + ``S`` - the attribute is of type String + ``N`` - the attribute is of type Number + ``B`` - the attribute is of type Binary" } }, "type": "object" }, "azure-native:awsconnector:AuthType": { "description": "Property value", "type": "string", "enum": [ { "name": "BASIC_AUTH", "description": "AuthType enum BASIC_AUTH", "value": "BASIC_AUTH" }, { "name": "CODECONNECTIONS", "description": "AuthType enum CODECONNECTIONS", "value": "CODECONNECTIONS" }, { "name": "OAUTH", "description": "AuthType enum OAUTH", "value": "OAUTH" }, { "name": "PERSONAL_ACCESS_TOKEN", "description": "AuthType enum PERSONAL_ACCESS_TOKEN", "value": "PERSONAL_ACCESS_TOKEN" } ] }, "azure-native:awsconnector:AuthTypeEnumValue": { "description": "Definition of AuthTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AuthType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AuthTypeEnumValueResponse": { "description": "Definition of AuthTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AuthenticateCognitoConfigResponse": { "description": "Definition of AuthenticateCognitoConfig", "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint." }, "onUnauthenticatedRequest": { "type": "string", "description": "The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." }, "scope": { "type": "string", "description": "The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." }, "sessionCookieName": { "type": "string", "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." }, "sessionTimeout": { "type": "string", "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." }, "userPoolArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool." }, "userPoolClientId": { "type": "string", "description": "The ID of the Amazon Cognito user pool client." }, "userPoolDomain": { "type": "string", "description": "The domain prefix or fully-qualified domain name of the Amazon Cognito user pool." } }, "type": "object" }, "azure-native:awsconnector:AuthenticateOidcConfigResponse": { "description": "Definition of AuthenticateOidcConfig", "properties": { "authenticationRequestExtraParams": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint." }, "authorizationEndpoint": { "type": "string", "description": "The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." }, "clientId": { "type": "string", "description": "The OAuth 2.0 client identifier." }, "clientSecret": { "type": "string", "description": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true." }, "issuer": { "type": "string", "description": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." }, "onUnauthenticatedRequest": { "type": "string", "description": "The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value." }, "scope": { "type": "string", "description": "The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP." }, "sessionCookieName": { "type": "string", "description": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie." }, "sessionTimeout": { "type": "string", "description": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days)." }, "tokenEndpoint": { "type": "string", "description": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." }, "useExistingClientSecret": { "type": "boolean", "description": "Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false." }, "userInfoEndpoint": { "type": "string", "description": "The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path." } }, "type": "object" }, "azure-native:awsconnector:AuthenticationMode": { "description": "Property value", "type": "string", "enum": [ { "name": "API", "description": "AuthenticationMode enum API", "value": "API" }, { "name": "API_AND_CONFIG_MAP", "description": "AuthenticationMode enum API_AND_CONFIG_MAP", "value": "API_AND_CONFIG_MAP" }, { "name": "CONFIG_MAP", "description": "AuthenticationMode enum CONFIG_MAP", "value": "CONFIG_MAP" } ] }, "azure-native:awsconnector:AuthenticationModeEnumValue": { "description": "Definition of AuthenticationModeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AuthenticationMode" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AuthenticationModeEnumValueResponse": { "description": "Definition of AuthenticationModeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AuthenticationType": { "description": "Property value", "type": "string", "enum": [ { "name": "AMAZON_COGNITO_USER_POOLS", "description": "AuthenticationType enum AMAZON_COGNITO_USER_POOLS", "value": "AMAZON_COGNITO_USER_POOLS" }, { "name": "API_KEY", "description": "AuthenticationType enum API_KEY", "value": "API_KEY" }, { "name": "AWS_IAM", "description": "AuthenticationType enum AWS_IAM", "value": "AWS_IAM" }, { "name": "AWS_LAMBDA", "description": "AuthenticationType enum AWS_LAMBDA", "value": "AWS_LAMBDA" }, { "name": "OPENID_CONNECT", "description": "AuthenticationType enum OPENID_CONNECT", "value": "OPENID_CONNECT" } ] }, "azure-native:awsconnector:AuthenticationTypeEnumValue": { "description": "Definition of AuthenticationTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AuthenticationType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AuthenticationTypeEnumValueResponse": { "description": "Definition of AuthenticationTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AuthorizationConfig": { "description": "Definition of AuthorizationConfig", "properties": { "accessPointId": { "type": "string", "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*." }, "iam": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AuthorizationConfigIAM" } ], "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:AuthorizationConfigIAM": { "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string", "enum": [ { "name": "DISABLED", "description": "AuthorizationConfigIAM enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "AuthorizationConfigIAM enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:AuthorizationConfigResponse": { "description": "Definition of AuthorizationConfig", "properties": { "accessPointId": { "type": "string", "description": "The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*." }, "iam": { "type": "string", "description": "Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:AutoDeployment": { "description": "Definition of AutoDeployment", "properties": { "enabled": { "type": "boolean", "description": "If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions." }, "retainStacksOnAccountRemoval": { "type": "boolean", "description": "If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True." } }, "type": "object" }, "azure-native:awsconnector:AutoDeploymentResponse": { "description": "Definition of AutoDeployment", "properties": { "enabled": { "type": "boolean", "description": "If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions." }, "retainStacksOnAccountRemoval": { "type": "boolean", "description": "If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True." } }, "type": "object" }, "azure-native:awsconnector:AutoScalingAutoScalingGroupProperties": { "description": "Definition of AutoScalingAutoScalingGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAutoScalingAutoScalingGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:AutoScalingAutoScalingGroupPropertiesResponse": { "description": "Definition of AutoScalingAutoScalingGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsAutoScalingAutoScalingGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:AutoScalingGroupNotificationConfiguration": { "description": "Definition of NotificationConfiguration", "properties": { "notificationTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of event types that send a notification. Event types can include any of the following types. *Allowed values*: + ``autoscaling:EC2_INSTANCE_LAUNCH`` + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + ``autoscaling:EC2_INSTANCE_TERMINATE`` + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + ``autoscaling:TEST_NOTIFICATION``" }, "topicARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic." } }, "type": "object" }, "azure-native:awsconnector:AutoScalingGroupNotificationConfigurationResponse": { "description": "Definition of NotificationConfiguration", "properties": { "notificationTypes": { "type": "array", "items": { "type": "string" }, "description": "A list of event types that send a notification. Event types can include any of the following types. *Allowed values*: + ``autoscaling:EC2_INSTANCE_LAUNCH`` + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + ``autoscaling:EC2_INSTANCE_TERMINATE`` + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + ``autoscaling:TEST_NOTIFICATION``" }, "topicARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon SNS topic." } }, "type": "object" }, "azure-native:awsconnector:AutoSnapshotAddOn": { "description": "Definition of AutoSnapshotAddOn", "properties": { "snapshotTimeOfDay": { "type": "string", "description": "The daily time when an automatic snapshot will be created." } }, "type": "object" }, "azure-native:awsconnector:AutoSnapshotAddOnResponse": { "description": "Definition of AutoSnapshotAddOn", "properties": { "snapshotTimeOfDay": { "type": "string", "description": "The daily time when an automatic snapshot will be created." } }, "type": "object" }, "azure-native:awsconnector:AutoTuneOptionsOutput": { "description": "Definition of AutoTuneOptionsOutput", "properties": { "errorMessage": { "type": "string", "description": "\u003cp\u003eAny errors that occurred while enabling or disabling Auto-Tune.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoTuneStateEnumValue", "description": "\u003cp\u003eThe current state of Auto-Tune on the domain.\u003c/p\u003e" }, "useOffPeakWindow": { "type": "boolean", "description": "\u003cp\u003eWhether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AutoTuneOptionsOutputResponse": { "description": "Definition of AutoTuneOptionsOutput", "properties": { "errorMessage": { "type": "string", "description": "\u003cp\u003eAny errors that occurred while enabling or disabling Auto-Tune.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoTuneStateEnumValueResponse", "description": "\u003cp\u003eThe current state of Auto-Tune on the domain.\u003c/p\u003e" }, "useOffPeakWindow": { "type": "boolean", "description": "\u003cp\u003eWhether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AutoTuneState": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "AutoTuneState enum DISABLED", "value": "DISABLED" }, { "name": "DISABLED_AND_ROLLBACK_COMPLETE", "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_COMPLETE", "value": "DISABLED_AND_ROLLBACK_COMPLETE" }, { "name": "DISABLED_AND_ROLLBACK_ERROR", "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_ERROR", "value": "DISABLED_AND_ROLLBACK_ERROR" }, { "name": "DISABLED_AND_ROLLBACK_IN_PROGRESS", "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_IN_PROGRESS", "value": "DISABLED_AND_ROLLBACK_IN_PROGRESS" }, { "name": "DISABLED_AND_ROLLBACK_SCHEDULED", "description": "AutoTuneState enum DISABLED_AND_ROLLBACK_SCHEDULED", "value": "DISABLED_AND_ROLLBACK_SCHEDULED" }, { "name": "DISABLE_IN_PROGRESS", "description": "AutoTuneState enum DISABLE_IN_PROGRESS", "value": "DISABLE_IN_PROGRESS" }, { "name": "ENABLED", "description": "AutoTuneState enum ENABLED", "value": "ENABLED" }, { "name": "ENABLE_IN_PROGRESS", "description": "AutoTuneState enum ENABLE_IN_PROGRESS", "value": "ENABLE_IN_PROGRESS" }, { "name": "ERROR", "description": "AutoTuneState enum ERROR", "value": "ERROR" } ] }, "azure-native:awsconnector:AutoTuneStateEnumValue": { "description": "Definition of AutoTuneStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AutoTuneState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AutoTuneStateEnumValueResponse": { "description": "Definition of AutoTuneStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:AvailabilityZone": { "description": "Definition of AvailabilityZone", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name of the Availability Zone.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AvailabilityZoneResponse": { "description": "Definition of AvailabilityZone", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name of the Availability Zone.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsAccessAnalyzerAnalyzerProperties": { "description": "Definition of awsAccessAnalyzerAnalyzer", "properties": { "analyzerConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UnusedAccessConfiguration", "description": "The configuration for the analyzer" }, "analyzerName": { "type": "string", "description": "Analyzer name" }, "archiveRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArchiveRule" }, "description": "Property archiveRules" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN) of the analyzer" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." }, "type": { "type": "string", "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS" } }, "type": "object" }, "azure-native:awsconnector:AwsAccessAnalyzerAnalyzerPropertiesResponse": { "description": "Definition of awsAccessAnalyzerAnalyzer", "properties": { "analyzerConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UnusedAccessConfigurationResponse", "description": "The configuration for the analyzer" }, "analyzerName": { "type": "string", "description": "Analyzer name" }, "archiveRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArchiveRuleResponse" }, "description": "Property archiveRules" }, "arn": { "type": "string", "description": "Amazon Resource Name (ARN) of the analyzer" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." }, "type": { "type": "string", "description": "The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS" } }, "type": "object" }, "azure-native:awsconnector:AwsAcmCertificateSummaryProperties": { "description": "Definition of awsAcmCertificateSummary", "properties": { "certificateArn": { "type": "string", "description": "\u003cp\u003eAmazon Resource Name (ARN) of the certificate. This is of the form:\u003c/p\u003e \u003cp\u003e \u003ccode\u003earn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\u003c/code\u003e \u003c/p\u003e \u003cp\u003eFor more information about ARNs, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html'\u003eAmazon Resource Names (ARNs)\u003c/a\u003e.\u003c/p\u003e" }, "createdAt": { "type": "string", "description": "\u003cp\u003eThe time at which the certificate was requested.\u003c/p\u003e" }, "domainName": { "type": "string", "description": "\u003cp\u003eFully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.\u003c/p\u003e" }, "exported": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the certificate has been exported. This value exists only when the certificate type is \u003ccode\u003ePRIVATE\u003c/code\u003e.\u003c/p\u003e" }, "extendedKeyUsages": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ExtendedKeyUsageName" } ] }, "description": "\u003cp\u003eContains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). \u003c/p\u003e" }, "hasAdditionalSubjectAlternativeNames": { "type": "boolean", "description": "\u003cp\u003eWhen called by \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'\u003eListCertificates\u003c/a\u003e, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'\u003eDescribeCertificate\u003c/a\u003e.\u003c/p\u003e" }, "importedAt": { "type": "string", "description": "\u003cp\u003eThe date and time when the certificate was imported. This value exists only when the certificate type is \u003ccode\u003eIMPORTED\u003c/code\u003e. \u003c/p\u003e" }, "inUse": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the certificate is currently in use by any Amazon Web Services resources.\u003c/p\u003e" }, "issuedAt": { "type": "string", "description": "\u003cp\u003eThe time at which the certificate was issued. This value exists only when the certificate type is \u003ccode\u003eAMAZON_ISSUED\u003c/code\u003e. \u003c/p\u003e" }, "keyAlgorithm": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeyAlgorithmEnumValue", "description": "\u003cp\u003eThe algorithm that was used to generate the public-private key pair.\u003c/p\u003e" }, "keyUsages": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KeyUsageName" } ] }, "description": "\u003cp\u003eA list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.\u003c/p\u003e" }, "notAfter": { "type": "string", "description": "\u003cp\u003eThe time after which the certificate is not valid.\u003c/p\u003e" }, "notBefore": { "type": "string", "description": "\u003cp\u003eThe time before which the certificate is not valid.\u003c/p\u003e" }, "renewalEligibility": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RenewalEligibilityEnumValue", "description": "\u003cp\u003eSpecifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the \u003ca\u003eRenewCertificate\u003c/a\u003e command.\u003c/p\u003e" }, "revokedAt": { "type": "string", "description": "\u003cp\u003eThe time at which the certificate was revoked. This value exists only when the certificate status is \u003ccode\u003eREVOKED\u003c/code\u003e. \u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateStatusEnumValue", "description": "\u003cp\u003eThe status of the certificate.\u003c/p\u003e \u003cp\u003eA certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html'\u003eCertificate request fails\u003c/a\u003e. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html'\u003eDNS validation\u003c/a\u003e or \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html'\u003eEmail validation\u003c/a\u003e, and try again. If validation succeeds, the certificate enters status ISSUED. \u003c/p\u003e" }, "subjectAlternativeNameSummaries": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. \u003c/p\u003e \u003cp\u003eWhen called by \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'\u003eListCertificates\u003c/a\u003e, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'\u003eDescribeCertificate\u003c/a\u003e.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateTypeEnumValue", "description": "\u003cp\u003eThe source of the certificate. For certificates provided by ACM, this value is \u003ccode\u003eAMAZON_ISSUED\u003c/code\u003e. For certificates that you imported with \u003ca\u003eImportCertificate\u003c/a\u003e, this value is \u003ccode\u003eIMPORTED\u003c/code\u003e. ACM does not provide \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html'\u003emanaged renewal\u003c/a\u003e for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html'\u003eImporting Certificates\u003c/a\u003e in the \u003ci\u003eCertificate Manager User Guide\u003c/i\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsAcmCertificateSummaryPropertiesResponse": { "description": "Definition of awsAcmCertificateSummary", "properties": { "certificateArn": { "type": "string", "description": "\u003cp\u003eAmazon Resource Name (ARN) of the certificate. This is of the form:\u003c/p\u003e \u003cp\u003e \u003ccode\u003earn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012\u003c/code\u003e \u003c/p\u003e \u003cp\u003eFor more information about ARNs, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html'\u003eAmazon Resource Names (ARNs)\u003c/a\u003e.\u003c/p\u003e" }, "createdAt": { "type": "string", "description": "\u003cp\u003eThe time at which the certificate was requested.\u003c/p\u003e" }, "domainName": { "type": "string", "description": "\u003cp\u003eFully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.\u003c/p\u003e" }, "exported": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the certificate has been exported. This value exists only when the certificate type is \u003ccode\u003ePRIVATE\u003c/code\u003e.\u003c/p\u003e" }, "extendedKeyUsages": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eContains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). \u003c/p\u003e" }, "hasAdditionalSubjectAlternativeNames": { "type": "boolean", "description": "\u003cp\u003eWhen called by \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'\u003eListCertificates\u003c/a\u003e, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'\u003eDescribeCertificate\u003c/a\u003e.\u003c/p\u003e" }, "importedAt": { "type": "string", "description": "\u003cp\u003eThe date and time when the certificate was imported. This value exists only when the certificate type is \u003ccode\u003eIMPORTED\u003c/code\u003e. \u003c/p\u003e" }, "inUse": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the certificate is currently in use by any Amazon Web Services resources.\u003c/p\u003e" }, "issuedAt": { "type": "string", "description": "\u003cp\u003eThe time at which the certificate was issued. This value exists only when the certificate type is \u003ccode\u003eAMAZON_ISSUED\u003c/code\u003e. \u003c/p\u003e" }, "keyAlgorithm": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeyAlgorithmEnumValueResponse", "description": "\u003cp\u003eThe algorithm that was used to generate the public-private key pair.\u003c/p\u003e" }, "keyUsages": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.\u003c/p\u003e" }, "notAfter": { "type": "string", "description": "\u003cp\u003eThe time after which the certificate is not valid.\u003c/p\u003e" }, "notBefore": { "type": "string", "description": "\u003cp\u003eThe time before which the certificate is not valid.\u003c/p\u003e" }, "renewalEligibility": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RenewalEligibilityEnumValueResponse", "description": "\u003cp\u003eSpecifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the \u003ca\u003eRenewCertificate\u003c/a\u003e command.\u003c/p\u003e" }, "revokedAt": { "type": "string", "description": "\u003cp\u003eThe time at which the certificate was revoked. This value exists only when the certificate status is \u003ccode\u003eREVOKED\u003c/code\u003e. \u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateStatusEnumValueResponse", "description": "\u003cp\u003eThe status of the certificate.\u003c/p\u003e \u003cp\u003eA certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/troubleshooting-failed.html'\u003eCertificate request fails\u003c/a\u003e. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html'\u003eDNS validation\u003c/a\u003e or \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html'\u003eEmail validation\u003c/a\u003e, and try again. If validation succeeds, the certificate enters status ISSUED. \u003c/p\u003e" }, "subjectAlternativeNameSummaries": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. \u003c/p\u003e \u003cp\u003eWhen called by \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_ListCertificates.html'\u003eListCertificates\u003c/a\u003e, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use \u003ca href='https://docs.aws.amazon.com/acm/latestAPIReference/API_DescribeCertificate.html'\u003eDescribeCertificate\u003c/a\u003e.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateTypeEnumValueResponse", "description": "\u003cp\u003eThe source of the certificate. For certificates provided by ACM, this value is \u003ccode\u003eAMAZON_ISSUED\u003c/code\u003e. For certificates that you imported with \u003ca\u003eImportCertificate\u003c/a\u003e, this value is \u003ccode\u003eIMPORTED\u003c/code\u003e. ACM does not provide \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html'\u003emanaged renewal\u003c/a\u003e for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see \u003ca href='https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html'\u003eImporting Certificates\u003c/a\u003e in the \u003ci\u003eCertificate Manager User Guide\u003c/i\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsApiGatewayRestApiProperties": { "description": "Definition of awsApiGatewayRestApi", "properties": { "apiKeySourceType": { "type": "string", "description": "The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer." }, "binaryMediaTypes": { "type": "array", "items": { "type": "string" }, "description": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads." }, "body": { "$ref": "pulumi.json#/Any", "description": "An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format." }, "bodyS3Location": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3Location", "description": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://www.openapis.org/), becoming the foundation of the OpenAPI Specification." }, "cloneFrom": { "type": "string", "description": "The ID of the RestApi that you want to clone from." }, "description": { "type": "string", "description": "The description of the RestApi." }, "disableExecuteApiEndpoint": { "type": "boolean", "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint" }, "endpointConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EndpointConfiguration", "description": "A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource." }, "failOnWarnings": { "type": "boolean", "description": "A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``." }, "minimumCompressionSize": { "type": "integer", "description": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size." }, "mode": { "type": "string", "description": "This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties." }, "name": { "type": "string", "description": "The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification." }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``." }, "policy": { "type": "string", "description": "A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``''`` as delimiter and values of ``'execute-api:/'`` and ``'*'``." }, "restApiId": { "type": "string", "description": "Property restApiId" }, "rootResourceId": { "type": "string", "description": "Property rootResourceId" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters." } }, "type": "object" }, "azure-native:awsconnector:AwsApiGatewayRestApiPropertiesResponse": { "description": "Definition of awsApiGatewayRestApi", "properties": { "apiKeySourceType": { "type": "string", "description": "The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer." }, "binaryMediaTypes": { "type": "array", "items": { "type": "string" }, "description": "The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads." }, "body": { "$ref": "pulumi.json#/Any", "description": "An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format." }, "bodyS3Location": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3LocationResponse", "description": "The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://www.openapis.org/), becoming the foundation of the OpenAPI Specification." }, "cloneFrom": { "type": "string", "description": "The ID of the RestApi that you want to clone from." }, "description": { "type": "string", "description": "The description of the RestApi." }, "disableExecuteApiEndpoint": { "type": "boolean", "description": "Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint" }, "endpointConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EndpointConfigurationResponse", "description": "A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource." }, "failOnWarnings": { "type": "boolean", "description": "A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``." }, "minimumCompressionSize": { "type": "integer", "description": "A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size." }, "mode": { "type": "string", "description": "This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties." }, "name": { "type": "string", "description": "The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification." }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``." }, "policy": { "type": "string", "description": "A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``''`` as delimiter and values of ``'execute-api:/'`` and ``'*'``." }, "restApiId": { "type": "string", "description": "Property restApiId" }, "rootResourceId": { "type": "string", "description": "Property rootResourceId" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters." } }, "type": "object" }, "azure-native:awsconnector:AwsApiGatewayStageProperties": { "description": "Definition of awsApiGatewayStage", "properties": { "accessLogSetting": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessLogSetting", "description": "Access log settings, including the access log format and access log destination ARN. The ``AccessLogSetting`` property type specifies settings for logging access in this stage. ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource." }, "cacheClusterEnabled": { "type": "boolean", "description": "Specifies whether a cache cluster is enabled for the stage." }, "cacheClusterSize": { "type": "string", "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)." }, "canarySetting": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CanarySetting", "description": "Settings for the canary deployment in this stage. Configuration settings of a canary deployment." }, "clientCertificateId": { "type": "string", "description": "The identifier of a client certificate for an API stage." }, "deploymentId": { "type": "string", "description": "The identifier of the Deployment that the stage points to." }, "description": { "type": "string", "description": "The stage's description." }, "documentationVersion": { "type": "string", "description": "The version of the associated API documentation." }, "methodSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MethodSetting" }, "description": "A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage." }, "restApiId": { "type": "string", "description": "The string identifier of the associated RestApi." }, "stageName": { "type": "string", "description": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The collection of tags. Each tag element is associated with a given resource." }, "tracingEnabled": { "type": "boolean", "description": "Specifies whether active tracing with X-ray is enabled for the Stage." }, "variables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#\u0026=,]+``." } }, "type": "object" }, "azure-native:awsconnector:AwsApiGatewayStagePropertiesResponse": { "description": "Definition of awsApiGatewayStage", "properties": { "accessLogSetting": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessLogSettingResponse", "description": "Access log settings, including the access log format and access log destination ARN. The ``AccessLogSetting`` property type specifies settings for logging access in this stage. ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource." }, "cacheClusterEnabled": { "type": "boolean", "description": "Specifies whether a cache cluster is enabled for the stage." }, "cacheClusterSize": { "type": "string", "description": "The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html)." }, "canarySetting": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CanarySettingResponse", "description": "Settings for the canary deployment in this stage. Configuration settings of a canary deployment." }, "clientCertificateId": { "type": "string", "description": "The identifier of a client certificate for an API stage." }, "deploymentId": { "type": "string", "description": "The identifier of the Deployment that the stage points to." }, "description": { "type": "string", "description": "The stage's description." }, "documentationVersion": { "type": "string", "description": "The version of the associated API documentation." }, "methodSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MethodSettingResponse" }, "description": "A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\\*/\\*`` for overriding all methods in the stage." }, "restApiId": { "type": "string", "description": "The string identifier of the associated RestApi." }, "stageName": { "type": "string", "description": "The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The collection of tags. Each tag element is associated with a given resource." }, "tracingEnabled": { "type": "boolean", "description": "Specifies whether active tracing with X-ray is enabled for the Stage." }, "variables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#\u0026=,]+``." } }, "type": "object" }, "azure-native:awsconnector:AwsAppSyncGraphqlApiProperties": { "description": "Definition of awsAppSyncGraphqlApi", "properties": { "additionalAuthenticationProviders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdditionalAuthenticationProvider" }, "description": "\u003cp\u003eA list of additional authentication providers for the \u003ccode\u003eGraphqlApi\u003c/code\u003e API.\u003c/p\u003e" }, "apiId": { "type": "string", "description": "\u003cp\u003eThe API ID.\u003c/p\u003e" }, "apiType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GraphQLApiTypeEnumValue", "description": "\u003cp\u003eThe value that indicates whether the GraphQL API is a standard API (\u003ccode\u003eGRAPHQL\u003c/code\u003e) or merged API (\u003ccode\u003eMERGED\u003c/code\u003e).\u003c/p\u003e" }, "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN).\u003c/p\u003e" }, "authenticationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticationTypeEnumValue", "description": "\u003cp\u003eThe authentication type.\u003c/p\u003e" }, "dns": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe DNS records for the API.\u003c/p\u003e" }, "enhancedMetricsConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnhancedMetricsConfig", "description": "\u003cp\u003eThe \u003ccode\u003eenhancedMetricsConfig\u003c/code\u003e object.\u003c/p\u003e" }, "introspectionConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GraphQLApiIntrospectionConfigEnumValue", "description": "\u003cp\u003eSets the value of the GraphQL API to enable (\u003ccode\u003eENABLED\u003c/code\u003e) or disable (\u003ccode\u003eDISABLED\u003c/code\u003e) introspection. If no value is provided, the introspection configuration will be set to \u003ccode\u003eENABLED\u003c/code\u003e by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.\u003c/p\u003e \u003cp\u003eFor more information about introspection, see \u003ca href='https://graphql.org/learn/introspection/'\u003eGraphQL introspection\u003c/a\u003e.\u003c/p\u003e" }, "lambdaAuthorizerConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaAuthorizerConfig", "description": "\u003cp\u003eConfiguration for Lambda function authorization.\u003c/p\u003e" }, "logConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogConfig", "description": "\u003cp\u003eThe Amazon CloudWatch Logs configuration.\u003c/p\u003e" }, "mergedApiExecutionRoleArn": { "type": "string", "description": "\u003cp\u003eThe Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the \u003ccode\u003eAUTO_MERGE\u003c/code\u003e to update the merged API endpoint with the source API changes automatically.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe API name.\u003c/p\u003e" }, "openIDConnectConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenIDConnectConfig", "description": "\u003cp\u003eThe OpenID Connect configuration.\u003c/p\u003e" }, "owner": { "type": "string", "description": "\u003cp\u003eThe account owner of the GraphQL API.\u003c/p\u003e" }, "ownerContact": { "type": "string", "description": "\u003cp\u003eThe owner contact information for an API resource.\u003c/p\u003e \u003cp\u003eThis field accepts any string input with a length of 0 - 256 characters.\u003c/p\u003e" }, "queryDepthLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is \u003ccode\u003e0\u003c/code\u003e (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between \u003ccode\u003e1\u003c/code\u003e and \u003ccode\u003e75\u003c/code\u003e nested levels. This field will produce a limit error if the operation falls out of bounds.\u003c/p\u003e \u003cp\u003eNote that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.\u003c/p\u003e" }, "resolverCountLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum number of resolvers that can be invoked in a single request. The default value is \u003ccode\u003e0\u003c/code\u003e (or unspecified), which will set the limit to \u003ccode\u003e10000\u003c/code\u003e. When specified, the limit value can be between \u003ccode\u003e1\u003c/code\u003e and \u003ccode\u003e10000\u003c/code\u003e. This field will produce a limit error if the operation falls out of bounds.\u003c/p\u003e" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe tags.\u003c/p\u003e" }, "uris": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe URIs.\u003c/p\u003e" }, "userPoolConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UserPoolConfig", "description": "\u003cp\u003eThe Amazon Cognito user pool configuration.\u003c/p\u003e" }, "visibility": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GraphQLApiVisibilityEnumValue", "description": "\u003cp\u003eSets the value of the GraphQL API to public (\u003ccode\u003eGLOBAL\u003c/code\u003e) or private (\u003ccode\u003ePRIVATE\u003c/code\u003e). If no value is provided, the visibility will be set to \u003ccode\u003eGLOBAL\u003c/code\u003e by default. This value cannot be changed once the API has been created.\u003c/p\u003e" }, "wafWebAclArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the WAF access control list (ACL) associated with this \u003ccode\u003eGraphqlApi\u003c/code\u003e, if one exists.\u003c/p\u003e" }, "xrayEnabled": { "type": "boolean", "description": "\u003cp\u003eA flag indicating whether to use X-Ray tracing for this \u003ccode\u003eGraphqlApi\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsAppSyncGraphqlApiPropertiesResponse": { "description": "Definition of awsAppSyncGraphqlApi", "properties": { "additionalAuthenticationProviders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdditionalAuthenticationProviderResponse" }, "description": "\u003cp\u003eA list of additional authentication providers for the \u003ccode\u003eGraphqlApi\u003c/code\u003e API.\u003c/p\u003e" }, "apiId": { "type": "string", "description": "\u003cp\u003eThe API ID.\u003c/p\u003e" }, "apiType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GraphQLApiTypeEnumValueResponse", "description": "\u003cp\u003eThe value that indicates whether the GraphQL API is a standard API (\u003ccode\u003eGRAPHQL\u003c/code\u003e) or merged API (\u003ccode\u003eMERGED\u003c/code\u003e).\u003c/p\u003e" }, "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN).\u003c/p\u003e" }, "authenticationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthenticationTypeEnumValueResponse", "description": "\u003cp\u003eThe authentication type.\u003c/p\u003e" }, "dns": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe DNS records for the API.\u003c/p\u003e" }, "enhancedMetricsConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnhancedMetricsConfigResponse", "description": "\u003cp\u003eThe \u003ccode\u003eenhancedMetricsConfig\u003c/code\u003e object.\u003c/p\u003e" }, "introspectionConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GraphQLApiIntrospectionConfigEnumValueResponse", "description": "\u003cp\u003eSets the value of the GraphQL API to enable (\u003ccode\u003eENABLED\u003c/code\u003e) or disable (\u003ccode\u003eDISABLED\u003c/code\u003e) introspection. If no value is provided, the introspection configuration will be set to \u003ccode\u003eENABLED\u003c/code\u003e by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.\u003c/p\u003e \u003cp\u003eFor more information about introspection, see \u003ca href='https://graphql.org/learn/introspection/'\u003eGraphQL introspection\u003c/a\u003e.\u003c/p\u003e" }, "lambdaAuthorizerConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaAuthorizerConfigResponse", "description": "\u003cp\u003eConfiguration for Lambda function authorization.\u003c/p\u003e" }, "logConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogConfigResponse", "description": "\u003cp\u003eThe Amazon CloudWatch Logs configuration.\u003c/p\u003e" }, "mergedApiExecutionRoleArn": { "type": "string", "description": "\u003cp\u003eThe Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the \u003ccode\u003eAUTO_MERGE\u003c/code\u003e to update the merged API endpoint with the source API changes automatically.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe API name.\u003c/p\u003e" }, "openIDConnectConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenIDConnectConfigResponse", "description": "\u003cp\u003eThe OpenID Connect configuration.\u003c/p\u003e" }, "owner": { "type": "string", "description": "\u003cp\u003eThe account owner of the GraphQL API.\u003c/p\u003e" }, "ownerContact": { "type": "string", "description": "\u003cp\u003eThe owner contact information for an API resource.\u003c/p\u003e \u003cp\u003eThis field accepts any string input with a length of 0 - 256 characters.\u003c/p\u003e" }, "queryDepthLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is \u003ccode\u003e0\u003c/code\u003e (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between \u003ccode\u003e1\u003c/code\u003e and \u003ccode\u003e75\u003c/code\u003e nested levels. This field will produce a limit error if the operation falls out of bounds.\u003c/p\u003e \u003cp\u003eNote that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.\u003c/p\u003e" }, "resolverCountLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum number of resolvers that can be invoked in a single request. The default value is \u003ccode\u003e0\u003c/code\u003e (or unspecified), which will set the limit to \u003ccode\u003e10000\u003c/code\u003e. When specified, the limit value can be between \u003ccode\u003e1\u003c/code\u003e and \u003ccode\u003e10000\u003c/code\u003e. This field will produce a limit error if the operation falls out of bounds.\u003c/p\u003e" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe tags.\u003c/p\u003e" }, "uris": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe URIs.\u003c/p\u003e" }, "userPoolConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UserPoolConfigResponse", "description": "\u003cp\u003eThe Amazon Cognito user pool configuration.\u003c/p\u003e" }, "visibility": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GraphQLApiVisibilityEnumValueResponse", "description": "\u003cp\u003eSets the value of the GraphQL API to public (\u003ccode\u003eGLOBAL\u003c/code\u003e) or private (\u003ccode\u003ePRIVATE\u003c/code\u003e). If no value is provided, the visibility will be set to \u003ccode\u003eGLOBAL\u003c/code\u003e by default. This value cannot be changed once the API has been created.\u003c/p\u003e" }, "wafWebAclArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the WAF access control list (ACL) associated with this \u003ccode\u003eGraphqlApi\u003c/code\u003e, if one exists.\u003c/p\u003e" }, "xrayEnabled": { "type": "boolean", "description": "\u003cp\u003eA flag indicating whether to use X-Ray tracing for this \u003ccode\u003eGraphqlApi\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsAutoScalingAutoScalingGroupProperties": { "description": "Definition of awsAutoScalingAutoScalingGroup", "properties": { "autoScalingGroupName": { "type": "string", "description": "The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name." }, "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template." }, "capacityRebalance": { "type": "boolean", "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*." }, "context": { "type": "string", "description": "Reserved." }, "cooldown": { "type": "string", "description": "*Only needed if you use simple scaling policies.* The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds" }, "defaultInstanceWarmup": { "type": "integer", "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None" }, "desiredCapacity": { "type": "string", "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price." }, "desiredCapacityType": { "type": "string", "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib``" }, "healthCheckGracePeriod": { "type": "integer", "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``0`` seconds" }, "healthCheckType": { "type": "string", "description": "A comma-separated value string of one or more health check types. The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set." }, "instanceId": { "type": "string", "description": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``." }, "instanceMaintenancePolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMaintenancePolicy", "description": "An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "launchConfigurationName": { "type": "string", "description": "The name of the launch configuration to use to launch instances. Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``." }, "launchTemplate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecification", "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." }, "lifecycleHookSpecificationList": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecycleHookSpecification" }, "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched." }, "loadBalancerNames": { "type": "array", "items": { "type": "string" }, "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead." }, "maxInstanceLifetime": { "type": "integer", "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "maxSize": { "type": "string", "description": "The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group)." }, "metricsCollection": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricsCollection" }, "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled." }, "minSize": { "type": "string", "description": "The minimum size of the group." }, "mixedInstancesPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MixedInstancesPolicy", "description": "An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration. There are key differences between Spot Instances and On-Demand Instances: + The price for Spot Instances varies based on demand + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource." }, "newInstancesProtectedFromScaleIn": { "type": "boolean", "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "notificationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoScalingGroupNotificationConfiguration", "description": "A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "notificationConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoScalingGroupNotificationConfiguration" }, "description": "Configures an Auto Scaling group to send notifications when specified events take place." }, "placementGroup": { "type": "string", "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*. A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group." }, "serviceLinkedRoleARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagProperty" }, "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "targetGroupARNs": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "terminationPolicies": { "type": "array", "items": { "type": "string" }, "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``" }, "vpcZoneIdentifier": { "type": "array", "items": { "type": "string" }, "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones." } }, "type": "object" }, "azure-native:awsconnector:AwsAutoScalingAutoScalingGroupPropertiesResponse": { "description": "Definition of awsAutoScalingAutoScalingGroup", "properties": { "autoScalingGroupName": { "type": "string", "description": "The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name." }, "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template." }, "capacityRebalance": { "type": "boolean", "description": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*." }, "context": { "type": "string", "description": "Reserved." }, "cooldown": { "type": "string", "description": "*Only needed if you use simple scaling policies.* The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds" }, "defaultInstanceWarmup": { "type": "integer", "description": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None" }, "desiredCapacity": { "type": "string", "description": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price." }, "desiredCapacityType": { "type": "string", "description": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib``" }, "healthCheckGracePeriod": { "type": "integer", "description": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``0`` seconds" }, "healthCheckType": { "type": "string", "description": "A comma-separated value string of one or more health check types. The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set." }, "instanceId": { "type": "string", "description": "The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``." }, "instanceMaintenancePolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMaintenancePolicyResponse", "description": "An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "launchConfigurationName": { "type": "string", "description": "The name of the launch configuration to use to launch instances. Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``." }, "launchTemplate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecificationResponse", "description": "Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." }, "lifecycleHookSpecificationList": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecycleHookSpecificationResponse" }, "description": "One or more lifecycle hooks to add to the Auto Scaling group before instances are launched." }, "loadBalancerNames": { "type": "array", "items": { "type": "string" }, "description": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead." }, "maxInstanceLifetime": { "type": "integer", "description": "The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "maxSize": { "type": "string", "description": "The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group)." }, "metricsCollection": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricsCollectionResponse" }, "description": "Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled." }, "minSize": { "type": "string", "description": "The minimum size of the group." }, "mixedInstancesPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MixedInstancesPolicyResponse", "description": "An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration. There are key differences between Spot Instances and On-Demand Instances: + The price for Spot Instances varies based on demand + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource." }, "newInstancesProtectedFromScaleIn": { "type": "boolean", "description": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "notificationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoScalingGroupNotificationConfigurationResponse", "description": "A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "notificationConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoScalingGroupNotificationConfigurationResponse" }, "description": "Configures an Auto Scaling group to send notifications when specified events take place." }, "placementGroup": { "type": "string", "description": "The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*. A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group." }, "serviceLinkedRoleARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagPropertyResponse" }, "description": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "targetGroupARNs": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*." }, "terminationPolicies": { "type": "array", "items": { "type": "string" }, "description": "A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias``" }, "vpcZoneIdentifier": { "type": "array", "items": { "type": "string" }, "description": "A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones." } }, "type": "object" }, "azure-native:awsconnector:AwsCloudFormationStackProperties": { "description": "Definition of awsCloudFormationStack", "properties": { "capabilities": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Capabilities" } ] }, "description": "Property capabilities" }, "changeSetId": { "type": "string", "description": "Property changeSetId" }, "creationTime": { "type": "string", "description": "Property creationTime" }, "description": { "type": "string", "description": "Property description" }, "disableRollback": { "type": "boolean", "description": "Property disableRollback" }, "enableTerminationProtection": { "type": "boolean", "description": "Property enableTerminationProtection" }, "lastUpdateTime": { "type": "string", "description": "Property lastUpdateTime" }, "notificationARNs": { "type": "array", "items": { "type": "string" }, "description": "Property notificationARNs" }, "outputs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Output" }, "description": "Property outputs" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Property parameters" }, "parentId": { "type": "string", "description": "Property parentId" }, "roleARN": { "type": "string", "description": "Property roleARN" }, "rootId": { "type": "string", "description": "Property rootId" }, "stackId": { "type": "string", "description": "Property stackId" }, "stackName": { "type": "string", "description": "Property stackName" }, "stackPolicyBody": { "$ref": "pulumi.json#/Any", "description": "Property stackPolicyBody" }, "stackPolicyURL": { "type": "string", "description": "Property stackPolicyURL" }, "stackStatus": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:StackStatus" } ], "description": "Property stackStatus" }, "stackStatusReason": { "type": "string", "description": "Property stackStatusReason" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "templateBody": { "$ref": "pulumi.json#/Any", "description": "Property templateBody" }, "templateURL": { "type": "string", "description": "Property templateURL" }, "timeoutInMinutes": { "type": "integer", "description": "Property timeoutInMinutes" } }, "type": "object" }, "azure-native:awsconnector:AwsCloudFormationStackPropertiesResponse": { "description": "Definition of awsCloudFormationStack", "properties": { "capabilities": { "type": "array", "items": { "type": "string" }, "description": "Property capabilities" }, "changeSetId": { "type": "string", "description": "Property changeSetId" }, "creationTime": { "type": "string", "description": "Property creationTime" }, "description": { "type": "string", "description": "Property description" }, "disableRollback": { "type": "boolean", "description": "Property disableRollback" }, "enableTerminationProtection": { "type": "boolean", "description": "Property enableTerminationProtection" }, "lastUpdateTime": { "type": "string", "description": "Property lastUpdateTime" }, "notificationARNs": { "type": "array", "items": { "type": "string" }, "description": "Property notificationARNs" }, "outputs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OutputResponse" }, "description": "Property outputs" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Property parameters" }, "parentId": { "type": "string", "description": "Property parentId" }, "roleARN": { "type": "string", "description": "Property roleARN" }, "rootId": { "type": "string", "description": "Property rootId" }, "stackId": { "type": "string", "description": "Property stackId" }, "stackName": { "type": "string", "description": "Property stackName" }, "stackPolicyBody": { "$ref": "pulumi.json#/Any", "description": "Property stackPolicyBody" }, "stackPolicyURL": { "type": "string", "description": "Property stackPolicyURL" }, "stackStatus": { "type": "string", "description": "Property stackStatus" }, "stackStatusReason": { "type": "string", "description": "Property stackStatusReason" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "templateBody": { "$ref": "pulumi.json#/Any", "description": "Property templateBody" }, "templateURL": { "type": "string", "description": "Property templateURL" }, "timeoutInMinutes": { "type": "integer", "description": "Property timeoutInMinutes" } }, "type": "object" }, "azure-native:awsconnector:AwsCloudFormationStackSetProperties": { "description": "Definition of awsCloudFormationStackSet", "properties": { "administrationRoleARN": { "type": "string", "description": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account." }, "autoDeployment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoDeployment", "description": "Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED." }, "callAs": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CallAs" } ], "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN." }, "capabilities": { "type": "array", "items": { "type": "string" }, "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances." }, "description": { "type": "string", "description": "A description of the stack set. You can use the description to identify the stack set's purpose or other important information." }, "executionRoleName": { "type": "string", "description": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation." }, "managedExecution": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActiveModel", "description": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations." }, "operationPreferences": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OperationPreferences", "description": "The user-specified preferences for how AWS CloudFormation performs a stack set operation." }, "parameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Parameter" }, "description": "The input parameters for the stack set template." }, "permissionModel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PermissionModel" } ], "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified." }, "stackInstancesGroup": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StackInstances" }, "description": "A group of stack instances with parameters in some specific accounts and regions." }, "stackSetId": { "type": "string", "description": "The ID of the stack set that you're creating." }, "stackSetName": { "type": "string", "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified." }, "templateBody": { "type": "string", "description": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes." }, "templateURL": { "type": "string", "description": "Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket." } }, "type": "object" }, "azure-native:awsconnector:AwsCloudFormationStackSetPropertiesResponse": { "description": "Definition of awsCloudFormationStackSet", "properties": { "administrationRoleARN": { "type": "string", "description": "The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account." }, "autoDeployment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoDeploymentResponse", "description": "Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED." }, "callAs": { "type": "string", "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN." }, "capabilities": { "type": "array", "items": { "type": "string" }, "description": "In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances." }, "description": { "type": "string", "description": "A description of the stack set. You can use the description to identify the stack set's purpose or other important information." }, "executionRoleName": { "type": "string", "description": "The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation." }, "managedExecution": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActiveModelResponse", "description": "Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations." }, "operationPreferences": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OperationPreferencesResponse", "description": "The user-specified preferences for how AWS CloudFormation performs a stack set operation." }, "parameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ParameterResponse" }, "description": "The input parameters for the stack set template." }, "permissionModel": { "type": "string", "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified." }, "stackInstancesGroup": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StackInstancesResponse" }, "description": "A group of stack instances with parameters in some specific accounts and regions." }, "stackSetId": { "type": "string", "description": "The ID of the stack set that you're creating." }, "stackSetName": { "type": "string", "description": "The name to associate with the stack set. The name must be unique in the Region where you create your stack set." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified." }, "templateBody": { "type": "string", "description": "The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes." }, "templateURL": { "type": "string", "description": "Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket." } }, "type": "object" }, "azure-native:awsconnector:AwsCloudFrontDistributionProperties": { "description": "Definition of awsCloudFrontDistribution", "properties": { "distributionConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DistributionConfig", "description": "The distribution's configuration. A distribution configuration." }, "domainName": { "type": "string", "description": "Property domainName" }, "id": { "type": "string", "description": "Property id" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A complex type that contains zero or more ``Tag`` elements." } }, "type": "object" }, "azure-native:awsconnector:AwsCloudFrontDistributionPropertiesResponse": { "description": "Definition of awsCloudFrontDistribution", "properties": { "distributionConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DistributionConfigResponse", "description": "The distribution's configuration. A distribution configuration." }, "domainName": { "type": "string", "description": "Property domainName" }, "id": { "type": "string", "description": "Property id" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A complex type that contains zero or more ``Tag`` elements." } }, "type": "object" }, "azure-native:awsconnector:AwsCloudTrailTrailProperties": { "description": "Definition of awsCloudTrailTrail", "properties": { "advancedEventSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdvancedEventSelector" }, "description": "The advanced event selectors that were used to select events for the data store." }, "arn": { "type": "string", "description": "Property arn" }, "cloudWatchLogsLogGroupArn": { "type": "string", "description": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn." }, "cloudWatchLogsRoleArn": { "type": "string", "description": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group." }, "enableLogFileValidation": { "type": "boolean", "description": "Specifies whether log file validation is enabled. The default is false." }, "eventSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EventSelector" }, "description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail." }, "includeGlobalServiceEvents": { "type": "boolean", "description": "Specifies whether the trail is publishing events from global services such as IAM to the log files." }, "insightSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InsightSelector" }, "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail." }, "isLogging": { "type": "boolean", "description": "Whether the CloudTrail is currently logging AWS API calls." }, "isMultiRegionTrail": { "type": "boolean", "description": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions." }, "isOrganizationTrail": { "type": "boolean", "description": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations." }, "kmsKeyId": { "type": "string", "description": "Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier." }, "s3BucketName": { "type": "string", "description": "Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements." }, "s3KeyPrefix": { "type": "string", "description": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters." }, "snsTopicArn": { "type": "string", "description": "Property snsTopicArn" }, "snsTopicName": { "type": "string", "description": "Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "trailName": { "type": "string", "description": "Property trailName" } }, "type": "object" }, "azure-native:awsconnector:AwsCloudTrailTrailPropertiesResponse": { "description": "Definition of awsCloudTrailTrail", "properties": { "advancedEventSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdvancedEventSelectorResponse" }, "description": "The advanced event selectors that were used to select events for the data store." }, "arn": { "type": "string", "description": "Property arn" }, "cloudWatchLogsLogGroupArn": { "type": "string", "description": "Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn." }, "cloudWatchLogsRoleArn": { "type": "string", "description": "Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group." }, "enableLogFileValidation": { "type": "boolean", "description": "Specifies whether log file validation is enabled. The default is false." }, "eventSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EventSelectorResponse" }, "description": "Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail." }, "includeGlobalServiceEvents": { "type": "boolean", "description": "Specifies whether the trail is publishing events from global services such as IAM to the log files." }, "insightSelectors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InsightSelectorResponse" }, "description": "Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail." }, "isLogging": { "type": "boolean", "description": "Whether the CloudTrail is currently logging AWS API calls." }, "isMultiRegionTrail": { "type": "boolean", "description": "Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions." }, "isOrganizationTrail": { "type": "boolean", "description": "Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations." }, "kmsKeyId": { "type": "string", "description": "Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier." }, "s3BucketName": { "type": "string", "description": "Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements." }, "s3KeyPrefix": { "type": "string", "description": "Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters." }, "snsTopicArn": { "type": "string", "description": "Property snsTopicArn" }, "snsTopicName": { "type": "string", "description": "Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "trailName": { "type": "string", "description": "Property trailName" } }, "type": "object" }, "azure-native:awsconnector:AwsCloudWatchAlarmProperties": { "description": "Definition of awsCloudWatchAlarm", "properties": { "actionsEnabled": { "type": "boolean", "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", "default": true }, "alarmActions": { "type": "array", "items": { "type": "string" }, "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*." }, "alarmDescription": { "type": "string", "description": "The description of the alarm." }, "alarmName": { "type": "string", "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "arn": { "type": "string", "description": "Property arn" }, "comparisonOperator": { "type": "string", "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand." }, "datapointsToAlarm": { "type": "integer", "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an 'M out of N' alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching." }, "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Dimension" }, "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``." }, "evaluateLowSampleCountPercentile": { "type": "string", "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available." }, "evaluationPeriods": { "type": "integer", "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an 'M out of N' alarm, this value is the N, and ``DatapointsToAlarm`` is the M. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*." }, "extendedStatistic": { "type": "string", "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``." }, "insufficientDataActions": { "type": "array", "items": { "type": "string" }, "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN)." }, "metricName": { "type": "string", "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``." }, "metrics": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricDataQuery" }, "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``." }, "namespace": { "type": "string", "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)" }, "okActions": { "type": "array", "items": { "type": "string" }, "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN)." }, "period": { "type": "integer", "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. *Minimum:* 10" }, "statistic": { "type": "string", "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "threshold": { "type": "number", "description": "The value to compare with the specified statistic." }, "thresholdMetricId": { "type": "string", "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm." }, "treatMissingData": { "type": "string", "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. If you omit this parameter, the default behavior of ``missing`` is used." }, "unit": { "type": "string", "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None." } }, "type": "object" }, "azure-native:awsconnector:AwsCloudWatchAlarmPropertiesResponse": { "description": "Definition of awsCloudWatchAlarm", "properties": { "actionsEnabled": { "type": "boolean", "description": "Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.", "default": true }, "alarmActions": { "type": "array", "items": { "type": "string" }, "description": "The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*." }, "alarmDescription": { "type": "string", "description": "The description of the alarm." }, "alarmName": { "type": "string", "description": "The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "arn": { "type": "string", "description": "Property arn" }, "comparisonOperator": { "type": "string", "description": "The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand." }, "datapointsToAlarm": { "type": "integer", "description": "The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an 'M out of N' alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching." }, "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DimensionResponse" }, "description": "The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``." }, "evaluateLowSampleCountPercentile": { "type": "string", "description": "Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available." }, "evaluationPeriods": { "type": "integer", "description": "The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an 'M out of N' alarm, this value is the N, and ``DatapointsToAlarm`` is the M. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*." }, "extendedStatistic": { "type": "string", "description": "The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``." }, "insufficientDataActions": { "type": "array", "items": { "type": "string" }, "description": "The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN)." }, "metricName": { "type": "string", "description": "The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``." }, "metrics": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricDataQueryResponse" }, "description": "An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``." }, "namespace": { "type": "string", "description": "The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html)" }, "okActions": { "type": "array", "items": { "type": "string" }, "description": "The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN)." }, "period": { "type": "integer", "description": "The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. *Minimum:* 10" }, "statistic": { "type": "string", "description": "The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "threshold": { "type": "number", "description": "The value to compare with the specified statistic." }, "thresholdMetricId": { "type": "string", "description": "In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm." }, "treatMissingData": { "type": "string", "description": "Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. If you omit this parameter, the default behavior of ``missing`` is used." }, "unit": { "type": "string", "description": "The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None." } }, "type": "object" }, "azure-native:awsconnector:AwsCodeBuildProjectProperties": { "description": "Definition of awsCodeBuildProject", "properties": { "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the build project.\u003c/p\u003e" }, "artifacts": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectArtifacts", "description": "\u003cp\u003eInformation about the build output artifacts for the build project.\u003c/p\u003e" }, "badge": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectBadge", "description": "\u003cp\u003eInformation about the build badge for the build project.\u003c/p\u003e" }, "buildBatchConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectBuildBatchConfig", "description": "\u003cp\u003eA \u003ca\u003eProjectBuildBatchConfig\u003c/a\u003e object that defines the batch build options for the project.\u003c/p\u003e" }, "cache": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectCache", "description": "\u003cp\u003eInformation about the cache for the build project.\u003c/p\u003e" }, "concurrentBuildLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum number of concurrent builds that are allowed for this project.\u003c/p\u003e \u003cp\u003eNew builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.\u003c/p\u003e" }, "created": { "type": "string", "description": "\u003cp\u003eWhen the build project was created, expressed in Unix time format.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description that makes the build project easy to identify.\u003c/p\u003e" }, "encryptionKey": { "type": "string", "description": "\u003cp\u003eThe Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eYou can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. \u003c/p\u003e \u003c/note\u003e \u003cp\u003eYou can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format \u003ccode\u003ealias/\u0026lt;alias-name\u0026gt;\u003c/code\u003e). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3). \u003c/p\u003e" }, "environment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectEnvironment", "description": "\u003cp\u003eInformation about the build environment for this build project.\u003c/p\u003e" }, "fileSystemLocations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectFileSystemLocation" }, "description": "\u003cp\u003e An array of \u003ccode\u003eProjectFileSystemLocation\u003c/code\u003e objects for a CodeBuild build project. A \u003ccode\u003eProjectFileSystemLocation\u003c/code\u003e object specifies the \u003ccode\u003eidentifier\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003emountOptions\u003c/code\u003e, \u003ccode\u003emountPoint\u003c/code\u003e, and \u003ccode\u003etype\u003c/code\u003e of a file system created using Amazon Elastic File System. \u003c/p\u003e" }, "lastModified": { "type": "string", "description": "\u003cp\u003eWhen the build project's settings were last modified, expressed in Unix time format.\u003c/p\u003e" }, "logsConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogsConfig", "description": "\u003cp\u003eInformation about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. \u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the build project.\u003c/p\u003e" }, "projectVisibility": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectVisibilityTypeEnumValue", "description": "Property projectVisibility" }, "publicProjectAlias": { "type": "string", "description": "\u003cp\u003eContains the project identifier used with the public build APIs. \u003c/p\u003e" }, "queuedTimeoutInMinutes": { "type": "integer", "description": "\u003cp\u003eThe number of minutes a build is allowed to be queued before it times out. \u003c/p\u003e" }, "resourceAccessRole": { "type": "string", "description": "\u003cp\u003eThe ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.\u003c/p\u003e" }, "secondaryArtifacts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectArtifacts" }, "description": "\u003cp\u003eAn array of \u003ccode\u003eProjectArtifacts\u003c/code\u003e objects. \u003c/p\u003e" }, "secondarySourceVersions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectSourceVersion" }, "description": "\u003cp\u003eAn array of \u003ccode\u003eProjectSourceVersion\u003c/code\u003e objects. If \u003ccode\u003esecondarySourceVersions\u003c/code\u003e is specified at the build level, then they take over these \u003ccode\u003esecondarySourceVersions\u003c/code\u003e (at the project level). \u003c/p\u003e" }, "secondarySources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectSource" }, "description": "\u003cp\u003eAn array of \u003ccode\u003eProjectSource\u003c/code\u003e objects. \u003c/p\u003e" }, "serviceRole": { "type": "string", "description": "\u003cp\u003eThe ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.\u003c/p\u003e" }, "source": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectSource", "description": "\u003cp\u003eInformation about the build input source code for this build project.\u003c/p\u003e" }, "sourceVersion": { "type": "string", "description": "\u003cp\u003eA version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor CodeCommit: the commit ID, branch, or Git tag to use.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format \u003ccode\u003epr/pull-request-ID\u003c/code\u003e (for example \u003ccode\u003epr/25\u003c/code\u003e). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Amazon S3: the version ID of the object that represents the build input ZIP file to use.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eIf \u003ccode\u003esourceVersion\u003c/code\u003e is specified at the build level, then that version takes precedence over this \u003ccode\u003esourceVersion\u003c/code\u003e (at the project level). \u003c/p\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'\u003eSource Version Sample with CodeBuild\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e. \u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eA list of tag key and value pairs associated with this build project.\u003c/p\u003e \u003cp\u003eThese tags are available for use by Amazon Web Services services that support CodeBuild build project tags.\u003c/p\u003e" }, "timeoutInMinutes": { "type": "integer", "description": "\u003cp\u003eHow long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.\u003c/p\u003e" }, "vpcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfig", "description": "\u003cp\u003eInformation about the VPC configuration that CodeBuild accesses.\u003c/p\u003e" }, "webhook": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Webhook", "description": "\u003cp\u003eInformation about a webhook that connects repository events to a build project in CodeBuild.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsCodeBuildProjectPropertiesResponse": { "description": "Definition of awsCodeBuildProject", "properties": { "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the build project.\u003c/p\u003e" }, "artifacts": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectArtifactsResponse", "description": "\u003cp\u003eInformation about the build output artifacts for the build project.\u003c/p\u003e" }, "badge": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectBadgeResponse", "description": "\u003cp\u003eInformation about the build badge for the build project.\u003c/p\u003e" }, "buildBatchConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectBuildBatchConfigResponse", "description": "\u003cp\u003eA \u003ca\u003eProjectBuildBatchConfig\u003c/a\u003e object that defines the batch build options for the project.\u003c/p\u003e" }, "cache": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectCacheResponse", "description": "\u003cp\u003eInformation about the cache for the build project.\u003c/p\u003e" }, "concurrentBuildLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum number of concurrent builds that are allowed for this project.\u003c/p\u003e \u003cp\u003eNew builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.\u003c/p\u003e" }, "created": { "type": "string", "description": "\u003cp\u003eWhen the build project was created, expressed in Unix time format.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description that makes the build project easy to identify.\u003c/p\u003e" }, "encryptionKey": { "type": "string", "description": "\u003cp\u003eThe Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eYou can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. \u003c/p\u003e \u003c/note\u003e \u003cp\u003eYou can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format \u003ccode\u003ealias/\u0026lt;alias-name\u0026gt;\u003c/code\u003e). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3). \u003c/p\u003e" }, "environment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectEnvironmentResponse", "description": "\u003cp\u003eInformation about the build environment for this build project.\u003c/p\u003e" }, "fileSystemLocations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectFileSystemLocationResponse" }, "description": "\u003cp\u003e An array of \u003ccode\u003eProjectFileSystemLocation\u003c/code\u003e objects for a CodeBuild build project. A \u003ccode\u003eProjectFileSystemLocation\u003c/code\u003e object specifies the \u003ccode\u003eidentifier\u003c/code\u003e, \u003ccode\u003elocation\u003c/code\u003e, \u003ccode\u003emountOptions\u003c/code\u003e, \u003ccode\u003emountPoint\u003c/code\u003e, and \u003ccode\u003etype\u003c/code\u003e of a file system created using Amazon Elastic File System. \u003c/p\u003e" }, "lastModified": { "type": "string", "description": "\u003cp\u003eWhen the build project's settings were last modified, expressed in Unix time format.\u003c/p\u003e" }, "logsConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogsConfigResponse", "description": "\u003cp\u003eInformation about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both. \u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the build project.\u003c/p\u003e" }, "projectVisibility": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectVisibilityTypeEnumValueResponse", "description": "Property projectVisibility" }, "publicProjectAlias": { "type": "string", "description": "\u003cp\u003eContains the project identifier used with the public build APIs. \u003c/p\u003e" }, "queuedTimeoutInMinutes": { "type": "integer", "description": "\u003cp\u003eThe number of minutes a build is allowed to be queued before it times out. \u003c/p\u003e" }, "resourceAccessRole": { "type": "string", "description": "\u003cp\u003eThe ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.\u003c/p\u003e" }, "secondaryArtifacts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectArtifactsResponse" }, "description": "\u003cp\u003eAn array of \u003ccode\u003eProjectArtifacts\u003c/code\u003e objects. \u003c/p\u003e" }, "secondarySourceVersions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectSourceVersionResponse" }, "description": "\u003cp\u003eAn array of \u003ccode\u003eProjectSourceVersion\u003c/code\u003e objects. If \u003ccode\u003esecondarySourceVersions\u003c/code\u003e is specified at the build level, then they take over these \u003ccode\u003esecondarySourceVersions\u003c/code\u003e (at the project level). \u003c/p\u003e" }, "secondarySources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectSourceResponse" }, "description": "\u003cp\u003eAn array of \u003ccode\u003eProjectSource\u003c/code\u003e objects. \u003c/p\u003e" }, "serviceRole": { "type": "string", "description": "\u003cp\u003eThe ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.\u003c/p\u003e" }, "source": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectSourceResponse", "description": "\u003cp\u003eInformation about the build input source code for this build project.\u003c/p\u003e" }, "sourceVersion": { "type": "string", "description": "\u003cp\u003eA version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor CodeCommit: the commit ID, branch, or Git tag to use.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format \u003ccode\u003epr/pull-request-ID\u003c/code\u003e (for example \u003ccode\u003epr/25\u003c/code\u003e). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Amazon S3: the version ID of the object that represents the build input ZIP file to use.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eIf \u003ccode\u003esourceVersion\u003c/code\u003e is specified at the build level, then that version takes precedence over this \u003ccode\u003esourceVersion\u003c/code\u003e (at the project level). \u003c/p\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'\u003eSource Version Sample with CodeBuild\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e. \u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eA list of tag key and value pairs associated with this build project.\u003c/p\u003e \u003cp\u003eThese tags are available for use by Amazon Web Services services that support CodeBuild build project tags.\u003c/p\u003e" }, "timeoutInMinutes": { "type": "integer", "description": "\u003cp\u003eHow long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.\u003c/p\u003e" }, "vpcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfigResponse", "description": "\u003cp\u003eInformation about the VPC configuration that CodeBuild accesses.\u003c/p\u003e" }, "webhook": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WebhookResponse", "description": "\u003cp\u003eInformation about a webhook that connects repository events to a build project in CodeBuild.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsCodeBuildSourceCredentialsInfoProperties": { "description": "Definition of awsCodeBuildSourceCredentialsInfo", "properties": { "arn": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) of the token. \u003c/p\u003e" }, "authType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthTypeEnumValue", "description": "\u003cp\u003e The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS. \u003c/p\u003e" }, "resource": { "type": "string", "description": "\u003cp\u003eThe connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.\u003c/p\u003e" }, "serverType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerTypeEnumValue", "description": "\u003cp\u003e The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsCodeBuildSourceCredentialsInfoPropertiesResponse": { "description": "Definition of awsCodeBuildSourceCredentialsInfo", "properties": { "arn": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) of the token. \u003c/p\u003e" }, "authType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthTypeEnumValueResponse", "description": "\u003cp\u003e The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS. \u003c/p\u003e" }, "resource": { "type": "string", "description": "\u003cp\u003eThe connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.\u003c/p\u003e" }, "serverType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerTypeEnumValueResponse", "description": "\u003cp\u003e The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsConfigServiceConfigurationRecorderProperties": { "description": "Definition of awsConfigServiceConfigurationRecorder", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name of the configuration recorder. Config automatically assigns the name of 'default' when creating the configuration recorder.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eYou cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name. \u003c/p\u003e \u003c/note\u003e" }, "recordingGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingGroup", "description": "\u003cp\u003eSpecifies which resource types Config records for configuration changes.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003e High Number of Config Evaluations\u003c/b\u003e \u003c/p\u003e \u003cp\u003eYou may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.\u003c/p\u003e \u003cp\u003eIf you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An \u003ci\u003eephemeral workload\u003c/i\u003e is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.\u003c/p\u003e \u003c/note\u003e" }, "recordingMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingMode", "description": "\u003cp\u003eSpecifies the default recording frequency that Config uses to record configuration changes. Config supports \u003ci\u003eContinuous recording\u003c/i\u003e and \u003ci\u003eDaily recording\u003c/i\u003e.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eContinuous recording allows you to record configuration changes continuously whenever a change occurs.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eDaily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eFirewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eYou can also override the recording frequency for specific resource types.\u003c/p\u003e" }, "roleARN": { "type": "string", "description": "\u003cp\u003eAmazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eWhile the API model does not require this field, the server will reject a request without a defined \u003ccode\u003eroleARN\u003c/code\u003e for the configuration recorder.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003ePre-existing Config role\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected. \u003c/p\u003e \u003cp\u003eFor example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html'\u003e \u003cb\u003eIdentity and Access Management for Config\u003c/b\u003e \u003c/a\u003e in the \u003ci\u003eConfig Developer Guide\u003c/i\u003e. \u003c/p\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsConfigServiceConfigurationRecorderPropertiesResponse": { "description": "Definition of awsConfigServiceConfigurationRecorder", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name of the configuration recorder. Config automatically assigns the name of 'default' when creating the configuration recorder.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eYou cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name. \u003c/p\u003e \u003c/note\u003e" }, "recordingGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingGroupResponse", "description": "\u003cp\u003eSpecifies which resource types Config records for configuration changes.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003e High Number of Config Evaluations\u003c/b\u003e \u003c/p\u003e \u003cp\u003eYou may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.\u003c/p\u003e \u003cp\u003eIf you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An \u003ci\u003eephemeral workload\u003c/i\u003e is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.\u003c/p\u003e \u003c/note\u003e" }, "recordingMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingModeResponse", "description": "\u003cp\u003eSpecifies the default recording frequency that Config uses to record configuration changes. Config supports \u003ci\u003eContinuous recording\u003c/i\u003e and \u003ci\u003eDaily recording\u003c/i\u003e.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eContinuous recording allows you to record configuration changes continuously whenever a change occurs.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eDaily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eFirewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eYou can also override the recording frequency for specific resource types.\u003c/p\u003e" }, "roleARN": { "type": "string", "description": "\u003cp\u003eAmazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eWhile the API model does not require this field, the server will reject a request without a defined \u003ccode\u003eroleARN\u003c/code\u003e for the configuration recorder.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003ePre-existing Config role\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected. \u003c/p\u003e \u003cp\u003eFor example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/security-iam.html'\u003e \u003cb\u003eIdentity and Access Management for Config\u003c/b\u003e \u003c/a\u003e in the \u003ci\u003eConfig Developer Guide\u003c/i\u003e. \u003c/p\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsConfigServiceConfigurationRecorderStatusProperties": { "description": "Definition of awsConfigServiceConfigurationRecorderStatus", "properties": { "lastErrorCode": { "type": "string", "description": "\u003cp\u003eThe latest error code from when the recorder last failed.\u003c/p\u003e" }, "lastErrorMessage": { "type": "string", "description": "\u003cp\u003eThe latest error message from when the recorder last failed.\u003c/p\u003e" }, "lastStartTime": { "type": "string", "description": "\u003cp\u003eThe time the recorder was last started.\u003c/p\u003e" }, "lastStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecorderStatusEnumValue", "description": "\u003cp\u003eThe status of the latest recording event processed by the recorder.\u003c/p\u003e" }, "lastStatusChangeTime": { "type": "string", "description": "\u003cp\u003eThe time of the latest change in status of an recording event processed by the recorder.\u003c/p\u003e" }, "lastStopTime": { "type": "string", "description": "\u003cp\u003eThe time the recorder was last stopped.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the configuration recorder.\u003c/p\u003e" }, "recording": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether or not the recorder is currently recording.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsConfigServiceConfigurationRecorderStatusPropertiesResponse": { "description": "Definition of awsConfigServiceConfigurationRecorderStatus", "properties": { "lastErrorCode": { "type": "string", "description": "\u003cp\u003eThe latest error code from when the recorder last failed.\u003c/p\u003e" }, "lastErrorMessage": { "type": "string", "description": "\u003cp\u003eThe latest error message from when the recorder last failed.\u003c/p\u003e" }, "lastStartTime": { "type": "string", "description": "\u003cp\u003eThe time the recorder was last started.\u003c/p\u003e" }, "lastStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecorderStatusEnumValueResponse", "description": "\u003cp\u003eThe status of the latest recording event processed by the recorder.\u003c/p\u003e" }, "lastStatusChangeTime": { "type": "string", "description": "\u003cp\u003eThe time of the latest change in status of an recording event processed by the recorder.\u003c/p\u003e" }, "lastStopTime": { "type": "string", "description": "\u003cp\u003eThe time the recorder was last stopped.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the configuration recorder.\u003c/p\u003e" }, "recording": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether or not the recorder is currently recording.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsConfigServiceDeliveryChannelProperties": { "description": "Definition of awsConfigServiceDeliveryChannel", "properties": { "configSnapshotDeliveryProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigSnapshotDeliveryProperties", "description": "\u003cp\u003eThe options for how often Config delivers configuration snapshots to the Amazon S3 bucket.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the delivery channel. By default, Config assigns the name 'default' when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.\u003c/p\u003e" }, "s3BucketName": { "type": "string", "description": "\u003cp\u003eThe name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.\u003c/p\u003e \u003cp\u003eIf you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html'\u003ePermissions for the Amazon S3 Bucket\u003c/a\u003e in the \u003ci\u003eConfig Developer Guide\u003c/i\u003e.\u003c/p\u003e" }, "s3KeyPrefix": { "type": "string", "description": "\u003cp\u003eThe prefix for the specified Amazon S3 bucket.\u003c/p\u003e" }, "s3KmsKeyArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.\u003c/p\u003e" }, "snsTopicARN": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.\u003c/p\u003e \u003cp\u003eIf you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html'\u003ePermissions for the Amazon SNS Topic\u003c/a\u003e in the \u003ci\u003eConfig Developer Guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsConfigServiceDeliveryChannelPropertiesResponse": { "description": "Definition of awsConfigServiceDeliveryChannel", "properties": { "configSnapshotDeliveryProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigSnapshotDeliveryPropertiesResponse", "description": "\u003cp\u003eThe options for how often Config delivers configuration snapshots to the Amazon S3 bucket.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the delivery channel. By default, Config assigns the name 'default' when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.\u003c/p\u003e" }, "s3BucketName": { "type": "string", "description": "\u003cp\u003eThe name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.\u003c/p\u003e \u003cp\u003eIf you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html'\u003ePermissions for the Amazon S3 Bucket\u003c/a\u003e in the \u003ci\u003eConfig Developer Guide\u003c/i\u003e.\u003c/p\u003e" }, "s3KeyPrefix": { "type": "string", "description": "\u003cp\u003eThe prefix for the specified Amazon S3 bucket.\u003c/p\u003e" }, "s3KmsKeyArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.\u003c/p\u003e" }, "snsTopicARN": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.\u003c/p\u003e \u003cp\u003eIf you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html'\u003ePermissions for the Amazon SNS Topic\u003c/a\u003e in the \u003ci\u003eConfig Developer Guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDatabaseMigrationServiceReplicationInstanceProperties": { "description": "Definition of awsDatabaseMigrationServiceReplicationInstance", "properties": { "allocatedStorage": { "type": "integer", "description": "\u003cp\u003eThe amount of storage (in gigabytes) that is allocated for the replication instance.\u003c/p\u003e" }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "\u003cp\u003eBoolean value indicating if minor version upgrades will be automatically applied to the instance.\u003c/p\u003e" }, "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone for the instance.\u003c/p\u003e" }, "dnsNameServers": { "type": "string", "description": "\u003cp\u003eThe DNS name servers supported for the replication instance to access your on-premise source or target database.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eThe engine version number of the replication instance.\u003c/p\u003e \u003cp\u003eIf an engine version number is not specified when a replication instance is created, the default is the latest engine version available.\u003c/p\u003e \u003cp\u003eWhen modifying a major engine version of an instance, also set \u003ccode\u003eAllowMajorVersionUpgrade\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e" }, "freeUntil": { "type": "string", "description": "\u003cp\u003e The expiration date of the free replication instance that is part of the Free DMS program. \u003c/p\u003e" }, "instanceCreateTime": { "type": "string", "description": "\u003cp\u003eThe time the replication instance was created.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eAn KMS key identifier that is used to encrypt the data on the replication instance.\u003c/p\u003e \u003cp\u003eIf you don't specify a value for the \u003ccode\u003eKmsKeyId\u003c/code\u003e parameter, then DMS uses your default encryption key.\u003c/p\u003e \u003cp\u003eKMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.\u003c/p\u003e" }, "multiAZ": { "type": "boolean", "description": "\u003cp\u003e Specifies whether the replication instance is a Multi-AZ deployment. You can't set the \u003ccode\u003eAvailabilityZone\u003c/code\u003e parameter if the Multi-AZ parameter is set to \u003ccode\u003etrue\u003c/code\u003e. \u003c/p\u003e" }, "networkType": { "type": "string", "description": "\u003cp\u003eThe type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.\u003c/p\u003e" }, "pendingModifiedValues": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationPendingModifiedValues", "description": "\u003cp\u003eThe pending modification values.\u003c/p\u003e" }, "preferredMaintenanceWindow": { "type": "string", "description": "\u003cp\u003eThe maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.\u003c/p\u003e" }, "publiclyAccessible": { "type": "boolean", "description": "\u003cp\u003e Specifies the accessibility options for the replication instance. A value of \u003ccode\u003etrue\u003c/code\u003e represents an instance with a public IP address. A value of \u003ccode\u003efalse\u003c/code\u003e represents an instance with a private IP address. The default value is \u003ccode\u003etrue\u003c/code\u003e. \u003c/p\u003e" }, "replicationInstanceArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the replication instance.\u003c/p\u003e" }, "replicationInstanceClass": { "type": "string", "description": "\u003cp\u003eThe compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.\u003c/p\u003e \u003cp\u003eFor more information on the settings and capacities for the available replication instance classes, see \u003ca href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'\u003e Selecting the right DMS replication instance for your migration\u003c/a\u003e. \u003c/p\u003e" }, "replicationInstanceIdentifier": { "type": "string", "description": "\u003cp\u003eThe replication instance identifier is a required parameter. This parameter is stored as a lowercase string.\u003c/p\u003e \u003cp\u003eConstraints:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eMust contain 1-63 alphanumeric characters or hyphens.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFirst character must be a letter.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCannot end with a hyphen or contain two consecutive hyphens.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eExample: \u003ccode\u003emyrepinstance\u003c/code\u003e \u003c/p\u003e" }, "replicationInstanceIpv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more IPv6 addresses for the replication instance.\u003c/p\u003e" }, "replicationInstancePrivateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IP address of the replication instance.\u003c/p\u003e" }, "replicationInstancePrivateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more private IP addresses for the replication instance.\u003c/p\u003e" }, "replicationInstancePublicIpAddress": { "type": "string", "description": "\u003cp\u003eThe public IP address of the replication instance.\u003c/p\u003e" }, "replicationInstancePublicIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more public IP addresses for the replication instance.\u003c/p\u003e" }, "replicationInstanceStatus": { "type": "string", "description": "\u003cp\u003eThe status of the replication instance. The possible return values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'available'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'creating'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'deleted'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'deleting'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'failed'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'modifying'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'upgrading'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'rebooting'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'resetting-master-credentials'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'storage-full'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'incompatible-credentials'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'incompatible-network'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'maintenance'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "replicationSubnetGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationSubnetGroup", "description": "\u003cp\u003eThe subnet group for the replication instance.\u003c/p\u003e" }, "secondaryAvailabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone of the standby replication instance in a Multi-AZ deployment.\u003c/p\u003e" }, "vpcSecurityGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcSecurityGroupMembership" }, "description": "\u003cp\u003eThe VPC security group for the instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDatabaseMigrationServiceReplicationInstancePropertiesResponse": { "description": "Definition of awsDatabaseMigrationServiceReplicationInstance", "properties": { "allocatedStorage": { "type": "integer", "description": "\u003cp\u003eThe amount of storage (in gigabytes) that is allocated for the replication instance.\u003c/p\u003e" }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "\u003cp\u003eBoolean value indicating if minor version upgrades will be automatically applied to the instance.\u003c/p\u003e" }, "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone for the instance.\u003c/p\u003e" }, "dnsNameServers": { "type": "string", "description": "\u003cp\u003eThe DNS name servers supported for the replication instance to access your on-premise source or target database.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eThe engine version number of the replication instance.\u003c/p\u003e \u003cp\u003eIf an engine version number is not specified when a replication instance is created, the default is the latest engine version available.\u003c/p\u003e \u003cp\u003eWhen modifying a major engine version of an instance, also set \u003ccode\u003eAllowMajorVersionUpgrade\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e" }, "freeUntil": { "type": "string", "description": "\u003cp\u003e The expiration date of the free replication instance that is part of the Free DMS program. \u003c/p\u003e" }, "instanceCreateTime": { "type": "string", "description": "\u003cp\u003eThe time the replication instance was created.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eAn KMS key identifier that is used to encrypt the data on the replication instance.\u003c/p\u003e \u003cp\u003eIf you don't specify a value for the \u003ccode\u003eKmsKeyId\u003c/code\u003e parameter, then DMS uses your default encryption key.\u003c/p\u003e \u003cp\u003eKMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.\u003c/p\u003e" }, "multiAZ": { "type": "boolean", "description": "\u003cp\u003e Specifies whether the replication instance is a Multi-AZ deployment. You can't set the \u003ccode\u003eAvailabilityZone\u003c/code\u003e parameter if the Multi-AZ parameter is set to \u003ccode\u003etrue\u003c/code\u003e. \u003c/p\u003e" }, "networkType": { "type": "string", "description": "\u003cp\u003eThe type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.\u003c/p\u003e" }, "pendingModifiedValues": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationPendingModifiedValuesResponse", "description": "\u003cp\u003eThe pending modification values.\u003c/p\u003e" }, "preferredMaintenanceWindow": { "type": "string", "description": "\u003cp\u003eThe maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.\u003c/p\u003e" }, "publiclyAccessible": { "type": "boolean", "description": "\u003cp\u003e Specifies the accessibility options for the replication instance. A value of \u003ccode\u003etrue\u003c/code\u003e represents an instance with a public IP address. A value of \u003ccode\u003efalse\u003c/code\u003e represents an instance with a private IP address. The default value is \u003ccode\u003etrue\u003c/code\u003e. \u003c/p\u003e" }, "replicationInstanceArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the replication instance.\u003c/p\u003e" }, "replicationInstanceClass": { "type": "string", "description": "\u003cp\u003eThe compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.\u003c/p\u003e \u003cp\u003eFor more information on the settings and capacities for the available replication instance classes, see \u003ca href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'\u003e Selecting the right DMS replication instance for your migration\u003c/a\u003e. \u003c/p\u003e" }, "replicationInstanceIdentifier": { "type": "string", "description": "\u003cp\u003eThe replication instance identifier is a required parameter. This parameter is stored as a lowercase string.\u003c/p\u003e \u003cp\u003eConstraints:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eMust contain 1-63 alphanumeric characters or hyphens.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFirst character must be a letter.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCannot end with a hyphen or contain two consecutive hyphens.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eExample: \u003ccode\u003emyrepinstance\u003c/code\u003e \u003c/p\u003e" }, "replicationInstanceIpv6Addresses": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more IPv6 addresses for the replication instance.\u003c/p\u003e" }, "replicationInstancePrivateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IP address of the replication instance.\u003c/p\u003e" }, "replicationInstancePrivateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more private IP addresses for the replication instance.\u003c/p\u003e" }, "replicationInstancePublicIpAddress": { "type": "string", "description": "\u003cp\u003eThe public IP address of the replication instance.\u003c/p\u003e" }, "replicationInstancePublicIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eOne or more public IP addresses for the replication instance.\u003c/p\u003e" }, "replicationInstanceStatus": { "type": "string", "description": "\u003cp\u003eThe status of the replication instance. The possible return values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'available'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'creating'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'deleted'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'deleting'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'failed'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'modifying'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'upgrading'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'rebooting'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'resetting-master-credentials'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'storage-full'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'incompatible-credentials'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'incompatible-network'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e'maintenance'\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "replicationSubnetGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationSubnetGroupResponse", "description": "\u003cp\u003eThe subnet group for the replication instance.\u003c/p\u003e" }, "secondaryAvailabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone of the standby replication instance in a Multi-AZ deployment.\u003c/p\u003e" }, "vpcSecurityGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcSecurityGroupMembershipResponse" }, "description": "\u003cp\u003eThe VPC security group for the instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDaxClusterProperties": { "description": "Definition of awsDaxCluster", "properties": { "activeNodes": { "type": "integer", "description": "\u003cp\u003eThe number of nodes in the cluster that are active (i.e., capable of serving requests).\u003c/p\u003e" }, "clusterArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) that uniquely identifies the cluster. \u003c/p\u003e" }, "clusterDiscoveryEndpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DaxClusterEndpoint", "description": "\u003cp\u003eThe endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.\u003c/p\u003e" }, "clusterEndpointEncryptionType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterEndpointEncryptionTypeEnumValue", "description": "\u003cp\u003eThe type of encryption supported by the cluster's endpoint. Values are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNONE\u003c/code\u003e for no encryption\u003c/p\u003e \u003cp\u003e \u003ccode\u003eTLS\u003c/code\u003e for Transport Layer Security\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "clusterName": { "type": "string", "description": "\u003cp\u003eThe name of the DAX cluster.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description of the cluster.\u003c/p\u003e" }, "iamRoleArn": { "type": "string", "description": "\u003cp\u003eA valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.\u003c/p\u003e" }, "nodeIdsToRemove": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of nodes to be removed from the cluster.\u003c/p\u003e" }, "nodeType": { "type": "string", "description": "\u003cp\u003eThe node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)\u003c/p\u003e" }, "nodes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Node" }, "description": "\u003cp\u003eA list of nodes that are currently in the cluster.\u003c/p\u003e" }, "notificationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DaxClusterNotificationConfiguration", "description": "\u003cp\u003eDescribes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).\u003c/p\u003e" }, "parameterGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ParameterGroupStatus", "description": "\u003cp\u003eThe parameter group being used by nodes in the cluster.\u003c/p\u003e" }, "preferredMaintenanceWindow": { "type": "string", "description": "\u003cp\u003eA range of time when maintenance of DAX cluster software will be performed. For example: \u003ccode\u003esun:01:00-sun:09:00\u003c/code\u003e. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.\u003c/p\u003e" }, "securityGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SecurityGroupMembership" }, "description": "\u003cp\u003eA list of security groups, and the status of each, for the nodes in the cluster.\u003c/p\u003e" }, "sseDescription": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSEDescription", "description": "\u003cp\u003eThe description of the server-side encryption status on the specified DAX cluster.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eThe current status of the cluster.\u003c/p\u003e" }, "subnetGroup": { "type": "string", "description": "\u003cp\u003eThe subnet group where the DAX cluster is running.\u003c/p\u003e" }, "totalNodes": { "type": "integer", "description": "\u003cp\u003eThe total number of nodes in the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDaxClusterPropertiesResponse": { "description": "Definition of awsDaxCluster", "properties": { "activeNodes": { "type": "integer", "description": "\u003cp\u003eThe number of nodes in the cluster that are active (i.e., capable of serving requests).\u003c/p\u003e" }, "clusterArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) that uniquely identifies the cluster. \u003c/p\u003e" }, "clusterDiscoveryEndpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DaxClusterEndpointResponse", "description": "\u003cp\u003eThe endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.\u003c/p\u003e" }, "clusterEndpointEncryptionType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterEndpointEncryptionTypeEnumValueResponse", "description": "\u003cp\u003eThe type of encryption supported by the cluster's endpoint. Values are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNONE\u003c/code\u003e for no encryption\u003c/p\u003e \u003cp\u003e \u003ccode\u003eTLS\u003c/code\u003e for Transport Layer Security\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "clusterName": { "type": "string", "description": "\u003cp\u003eThe name of the DAX cluster.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description of the cluster.\u003c/p\u003e" }, "iamRoleArn": { "type": "string", "description": "\u003cp\u003eA valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.\u003c/p\u003e" }, "nodeIdsToRemove": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of nodes to be removed from the cluster.\u003c/p\u003e" }, "nodeType": { "type": "string", "description": "\u003cp\u003eThe node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)\u003c/p\u003e" }, "nodes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NodeResponse" }, "description": "\u003cp\u003eA list of nodes that are currently in the cluster.\u003c/p\u003e" }, "notificationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DaxClusterNotificationConfigurationResponse", "description": "\u003cp\u003eDescribes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).\u003c/p\u003e" }, "parameterGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ParameterGroupStatusResponse", "description": "\u003cp\u003eThe parameter group being used by nodes in the cluster.\u003c/p\u003e" }, "preferredMaintenanceWindow": { "type": "string", "description": "\u003cp\u003eA range of time when maintenance of DAX cluster software will be performed. For example: \u003ccode\u003esun:01:00-sun:09:00\u003c/code\u003e. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.\u003c/p\u003e" }, "securityGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SecurityGroupMembershipResponse" }, "description": "\u003cp\u003eA list of security groups, and the status of each, for the nodes in the cluster.\u003c/p\u003e" }, "sseDescription": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSEDescriptionResponse", "description": "\u003cp\u003eThe description of the server-side encryption status on the specified DAX cluster.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eThe current status of the cluster.\u003c/p\u003e" }, "subnetGroup": { "type": "string", "description": "\u003cp\u003eThe subnet group where the DAX cluster is running.\u003c/p\u003e" }, "totalNodes": { "type": "integer", "description": "\u003cp\u003eThe total number of nodes in the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDynamoDBContinuousBackupsDescriptionProperties": { "description": "Definition of awsDynamoDBContinuousBackupsDescription", "properties": { "continuousBackupsStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContinuousBackupsStatusEnumValue", "description": "\u003cp\u003e \u003ccode\u003eContinuousBackupsStatus\u003c/code\u003e can be one of the following states: ENABLED, DISABLED\u003c/p\u003e" }, "pointInTimeRecoveryDescription": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoveryDescription", "description": "\u003cp\u003eThe description of the point in time recovery settings applied to the table.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDynamoDBContinuousBackupsDescriptionPropertiesResponse": { "description": "Definition of awsDynamoDBContinuousBackupsDescription", "properties": { "continuousBackupsStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContinuousBackupsStatusEnumValueResponse", "description": "\u003cp\u003e \u003ccode\u003eContinuousBackupsStatus\u003c/code\u003e can be one of the following states: ENABLED, DISABLED\u003c/p\u003e" }, "pointInTimeRecoveryDescription": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoveryDescriptionResponse", "description": "\u003cp\u003eThe description of the point in time recovery settings applied to the table.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsDynamoDBTableProperties": { "description": "Definition of awsDynamoDBTable", "properties": { "arn": { "type": "string", "description": "Property arn" }, "attributeDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AttributeDefinition" }, "description": "A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition." }, "billingMode": { "type": "string", "description": "Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). If not specified, the default is ``PROVISIONED``." }, "contributorInsightsSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContributorInsightsSpecification", "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights." }, "deletionProtectionEnabled": { "type": "boolean", "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*." }, "globalSecondaryIndexes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GlobalSecondaryIndex" }, "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails." }, "importSourceSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImportSourceSpecification", "description": "Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. Specifies the properties of data being imported from the S3 bucket source to the table." }, "keySchema": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeySchema" }, "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property." }, "kinesisStreamSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KinesisStreamSpecification", "description": "The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table." }, "localSecondaryIndexes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LocalSecondaryIndex" }, "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes." }, "pointInTimeRecoverySpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoverySpecification", "description": "The settings used to enable point in time recovery. The settings used to enable point in time recovery." }, "provisionedThroughput": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProvisionedThroughput", "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html)." }, "resourcePolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourcePolicy", "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." }, "sseSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSESpecification", "description": "Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption." }, "streamArn": { "type": "string", "description": "Property streamArn" }, "streamSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StreamSpecification", "description": "The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB." }, "tableClass": { "type": "string", "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``." }, "tableName": { "type": "string", "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." }, "timeToLiveSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TimeToLiveSpecification", "description": "Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table." } }, "type": "object" }, "azure-native:awsconnector:AwsDynamoDBTablePropertiesResponse": { "description": "Definition of awsDynamoDBTable", "properties": { "arn": { "type": "string", "description": "Property arn" }, "attributeDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AttributeDefinitionResponse" }, "description": "A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition." }, "billingMode": { "type": "string", "description": "Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). If not specified, the default is ``PROVISIONED``." }, "contributorInsightsSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContributorInsightsSpecificationResponse", "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights." }, "deletionProtectionEnabled": { "type": "boolean", "description": "Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*." }, "globalSecondaryIndexes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GlobalSecondaryIndexResponse" }, "description": "Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails." }, "importSourceSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImportSourceSpecificationResponse", "description": "Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. Specifies the properties of data being imported from the S3 bucket source to the table." }, "keySchema": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeySchemaResponse" }, "description": "Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property." }, "kinesisStreamSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KinesisStreamSpecificationResponse", "description": "The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table." }, "localSecondaryIndexes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LocalSecondaryIndexResponse" }, "description": "Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes." }, "pointInTimeRecoverySpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoverySpecificationResponse", "description": "The settings used to enable point in time recovery. The settings used to enable point in time recovery." }, "provisionedThroughput": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProvisionedThroughputResponse", "description": "Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html)." }, "resourcePolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourcePolicyResponse", "description": "A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html)." }, "sseSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSESpecificationResponse", "description": "Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption." }, "streamArn": { "type": "string", "description": "Property streamArn" }, "streamSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StreamSpecificationResponse", "description": "The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB." }, "tableClass": { "type": "string", "description": "The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``." }, "tableName": { "type": "string", "description": "A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." }, "timeToLiveSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TimeToLiveSpecificationResponse", "description": "Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2AccountAttributeProperties": { "description": "Definition of awsEc2AccountAttribute", "properties": { "attributeName": { "type": "string", "description": "\u003cp\u003eThe name of the account attribute.\u003c/p\u003e" }, "attributeValues": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccountAttributeValue" }, "description": "\u003cp\u003eThe values for the account attribute.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2AccountAttributePropertiesResponse": { "description": "Definition of awsEc2AccountAttribute", "properties": { "attributeName": { "type": "string", "description": "\u003cp\u003eThe name of the account attribute.\u003c/p\u003e" }, "attributeValues": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccountAttributeValueResponse" }, "description": "\u003cp\u003eThe values for the account attribute.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2AddressProperties": { "description": "Definition of awsEc2Address", "properties": { "allocationId": { "type": "string", "description": "\u003cp\u003eThe ID representing the allocation of the address.\u003c/p\u003e" }, "associationId": { "type": "string", "description": "\u003cp\u003eThe ID representing the association of the address with an instance.\u003c/p\u003e" }, "carrierIp": { "type": "string", "description": "\u003cp\u003eThe carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). \u003c/p\u003e" }, "customerOwnedIp": { "type": "string", "description": "\u003cp\u003eThe customer-owned IP address.\u003c/p\u003e" }, "customerOwnedIpv4Pool": { "type": "string", "description": "\u003cp\u003eThe ID of the customer-owned address pool.\u003c/p\u003e" }, "domain": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DomainTypeEnumValue", "description": "\u003cp\u003eThe network (\u003ccode\u003evpc\u003c/code\u003e).\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance that the address is associated with (if any).\u003c/p\u003e" }, "networkBorderGroup": { "type": "string", "description": "\u003cp\u003eThe name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.\u003c/p\u003e" }, "networkInterfaceId": { "type": "string", "description": "\u003cp\u003eThe ID of the network interface.\u003c/p\u003e" }, "networkInterfaceOwnerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the network interface.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IP address associated with the Elastic IP address.\u003c/p\u003e" }, "publicIp": { "type": "string", "description": "\u003cp\u003eThe Elastic IP address.\u003c/p\u003e" }, "publicIpv4Pool": { "type": "string", "description": "\u003cp\u003eThe ID of an address pool.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eAny tags assigned to the Elastic IP address.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2AddressPropertiesResponse": { "description": "Definition of awsEc2Address", "properties": { "allocationId": { "type": "string", "description": "\u003cp\u003eThe ID representing the allocation of the address.\u003c/p\u003e" }, "associationId": { "type": "string", "description": "\u003cp\u003eThe ID representing the association of the address with an instance.\u003c/p\u003e" }, "carrierIp": { "type": "string", "description": "\u003cp\u003eThe carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance). \u003c/p\u003e" }, "customerOwnedIp": { "type": "string", "description": "\u003cp\u003eThe customer-owned IP address.\u003c/p\u003e" }, "customerOwnedIpv4Pool": { "type": "string", "description": "\u003cp\u003eThe ID of the customer-owned address pool.\u003c/p\u003e" }, "domain": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DomainTypeEnumValueResponse", "description": "\u003cp\u003eThe network (\u003ccode\u003evpc\u003c/code\u003e).\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance that the address is associated with (if any).\u003c/p\u003e" }, "networkBorderGroup": { "type": "string", "description": "\u003cp\u003eThe name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.\u003c/p\u003e" }, "networkInterfaceId": { "type": "string", "description": "\u003cp\u003eThe ID of the network interface.\u003c/p\u003e" }, "networkInterfaceOwnerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the network interface.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IP address associated with the Elastic IP address.\u003c/p\u003e" }, "publicIp": { "type": "string", "description": "\u003cp\u003eThe Elastic IP address.\u003c/p\u003e" }, "publicIpv4Pool": { "type": "string", "description": "\u003cp\u003eThe ID of an address pool.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eAny tags assigned to the Elastic IP address.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2FlowLogProperties": { "description": "Definition of awsEc2FlowLog", "properties": { "deliverCrossAccountRole": { "type": "string", "description": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts." }, "deliverLogsPermissionArn": { "type": "string", "description": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." }, "destinationOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DestinationOptionsModelProperties", "description": "Property destinationOptions" }, "id": { "type": "string", "description": "The Flow Log ID" }, "logDestination": { "type": "string", "description": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType." }, "logDestinationType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LogDestinationType" } ], "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3." }, "logFormat": { "type": "string", "description": "The fields to include in the flow log record, in the order in which they should appear." }, "logGroupName": { "type": "string", "description": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." }, "maxAggregationInterval": { "type": "integer", "description": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes)." }, "resourceId": { "type": "string", "description": "The ID of the subnet, network interface, or VPC for which you want to create a flow log." }, "resourceType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceType" } ], "description": "The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags to apply to the flow logs." }, "trafficType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:TrafficType" } ], "description": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2FlowLogPropertiesResponse": { "description": "Definition of awsEc2FlowLog", "properties": { "deliverCrossAccountRole": { "type": "string", "description": "The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts." }, "deliverLogsPermissionArn": { "type": "string", "description": "The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." }, "destinationOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DestinationOptionsModelPropertiesResponse", "description": "Property destinationOptions" }, "id": { "type": "string", "description": "The Flow Log ID" }, "logDestination": { "type": "string", "description": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType." }, "logDestinationType": { "type": "string", "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3." }, "logFormat": { "type": "string", "description": "The fields to include in the flow log record, in the order in which they should appear." }, "logGroupName": { "type": "string", "description": "The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName." }, "maxAggregationInterval": { "type": "integer", "description": "The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes)." }, "resourceId": { "type": "string", "description": "The ID of the subnet, network interface, or VPC for which you want to create a flow log." }, "resourceType": { "type": "string", "description": "The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags to apply to the flow logs." }, "trafficType": { "type": "string", "description": "The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2ImageProperties": { "description": "Definition of awsEc2Image", "properties": { "architecture": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArchitectureValuesEnumValue", "description": "\u003cp\u003eThe architecture of the image.\u003c/p\u003e" }, "blockDeviceMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BlockDeviceMapping" }, "description": "\u003cp\u003eAny block device mapping entries.\u003c/p\u003e" }, "bootMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BootModeValuesEnumValue", "description": "\u003cp\u003eThe boot mode of the image. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'\u003eBoot modes\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "creationDate": { "type": "string", "description": "\u003cp\u003eThe date and time the image was created.\u003c/p\u003e" }, "deprecationTime": { "type": "string", "description": "\u003cp\u003eThe date and time to deprecate the AMI, in UTC, in the following format: \u003ci\u003eYYYY\u003c/i\u003e-\u003ci\u003eMM\u003c/i\u003e-\u003ci\u003eDD\u003c/i\u003eT\u003ci\u003eHH\u003c/i\u003e:\u003ci\u003eMM\u003c/i\u003e:\u003ci\u003eSS\u003c/i\u003eZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.\u003c/p\u003e" }, "deregistrationProtection": { "type": "string", "description": "\u003cp\u003eIndicates whether deregistration protection is enabled for the AMI.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description of the AMI that was provided during image creation.\u003c/p\u003e" }, "enaSupport": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether enhanced networking with ENA is enabled.\u003c/p\u003e" }, "hypervisor": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HypervisorTypeEnumValue", "description": "\u003cp\u003eThe hypervisor type of the image. Only \u003ccode\u003exen\u003c/code\u003e is supported. \u003ccode\u003eovm\u003c/code\u003e is not supported.\u003c/p\u003e" }, "imageId": { "type": "string", "description": "\u003cp\u003eThe ID of the AMI.\u003c/p\u003e" }, "imageLocation": { "type": "string", "description": "\u003cp\u003eThe location of the AMI.\u003c/p\u003e" }, "imageOwnerAlias": { "type": "string", "description": "\u003cp\u003eThe owner alias (\u003ccode\u003eamazon\u003c/code\u003e | \u003ccode\u003eaws-marketplace\u003c/code\u003e).\u003c/p\u003e" }, "imageType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageTypeValuesEnumValue", "description": "\u003cp\u003eThe type of image.\u003c/p\u003e" }, "imdsSupport": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImdsSupportValuesEnumValue", "description": "\u003cp\u003eIf \u003ccode\u003ev2.0\u003c/code\u003e, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have \u003ccode\u003eHttpTokens\u003c/code\u003e automatically set to \u003ccode\u003erequired\u003c/code\u003e so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, \u003ccode\u003eHttpPutResponseHopLimit\u003c/code\u003e is set to \u003ccode\u003e2\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'\u003eConfigure the AMI\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "kernelId": { "type": "string", "description": "\u003cp\u003eThe kernel associated with the image, if any. Only applicable for machine images.\u003c/p\u003e" }, "lastLaunchedTime": { "type": "string", "description": "\u003cp\u003eThe date and time, in \u003ca href='http://www.iso.org/iso/iso8601'\u003eISO 8601 date-time format\u003c/a\u003e, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003ccode\u003elastLaunchedTime\u003c/code\u003e data is available starting April 2017.\u003c/p\u003e \u003c/note\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the AMI that was provided during image creation.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the image.\u003c/p\u003e" }, "platform": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlatformValuesEnumValue", "description": "\u003cp\u003eThis value is set to \u003ccode\u003ewindows\u003c/code\u003e for Windows AMIs; otherwise, it is blank.\u003c/p\u003e" }, "platformDetails": { "type": "string", "description": "\u003cp\u003eThe platform details associated with the billing code of the AMI. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'\u003eUnderstand AMI billing information\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "productCodes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProductCode" }, "description": "\u003cp\u003eAny product codes associated with the AMI.\u003c/p\u003e" }, "public": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the image has public launch permissions. The value is \u003ccode\u003etrue\u003c/code\u003e if this image has public launch permissions or \u003ccode\u003efalse\u003c/code\u003e if it has only implicit and explicit launch permissions.\u003c/p\u003e" }, "ramdiskId": { "type": "string", "description": "\u003cp\u003eThe RAM disk associated with the image, if any. Only applicable for machine images.\u003c/p\u003e" }, "rootDeviceName": { "type": "string", "description": "\u003cp\u003eThe device name of the root device volume (for example, \u003ccode\u003e/dev/sda1\u003c/code\u003e).\u003c/p\u003e" }, "rootDeviceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeviceTypeEnumValue", "description": "\u003cp\u003eThe type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.\u003c/p\u003e" }, "sourceInstanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance that the AMI was created from if the AMI was created using \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'\u003eCreateImage\u003c/a\u003e. This field only appears if the AMI was created using CreateImage.\u003c/p\u003e" }, "sriovNetSupport": { "type": "string", "description": "\u003cp\u003eSpecifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageStateEnumValue", "description": "\u003cp\u003eThe current state of the AMI. If the state is \u003ccode\u003eavailable\u003c/code\u003e, the image is successfully registered and can be used to launch an instance.\u003c/p\u003e" }, "stateReason": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StateReason", "description": "\u003cp\u003eThe reason for the state change.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eAny tags assigned to the image.\u003c/p\u003e" }, "tpmSupport": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TpmSupportValuesEnumValue", "description": "\u003cp\u003eIf the image is configured for NitroTPM support, the value is \u003ccode\u003ev2.0\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'\u003eNitroTPM\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "usageOperation": { "type": "string", "description": "\u003cp\u003eThe operation of the Amazon EC2 instance and the billing code that is associated with the AMI. \u003ccode\u003eusageOperation\u003c/code\u003e corresponds to the \u003ca href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'\u003elineitem/Operation\u003c/a\u003e column on your Amazon Web Services Cost and Usage Report and in the \u003ca href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'\u003eAmazon Web Services Price List API\u003c/a\u003e. You can view these fields on the \u003cb\u003eInstances\u003c/b\u003e or \u003cb\u003eAMIs\u003c/b\u003e pages in the Amazon EC2 console, or in the responses that are returned by the \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'\u003eDescribeImages\u003c/a\u003e command in the Amazon EC2 API, or the \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'\u003edescribe-images\u003c/a\u003e command in the CLI.\u003c/p\u003e" }, "virtualizationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VirtualizationTypeEnumValue", "description": "\u003cp\u003eThe type of virtualization of the AMI.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2ImagePropertiesResponse": { "description": "Definition of awsEc2Image", "properties": { "architecture": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArchitectureValuesEnumValueResponse", "description": "\u003cp\u003eThe architecture of the image.\u003c/p\u003e" }, "blockDeviceMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BlockDeviceMappingResponse" }, "description": "\u003cp\u003eAny block device mapping entries.\u003c/p\u003e" }, "bootMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BootModeValuesEnumValueResponse", "description": "\u003cp\u003eThe boot mode of the image. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'\u003eBoot modes\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "creationDate": { "type": "string", "description": "\u003cp\u003eThe date and time the image was created.\u003c/p\u003e" }, "deprecationTime": { "type": "string", "description": "\u003cp\u003eThe date and time to deprecate the AMI, in UTC, in the following format: \u003ci\u003eYYYY\u003c/i\u003e-\u003ci\u003eMM\u003c/i\u003e-\u003ci\u003eDD\u003c/i\u003eT\u003ci\u003eHH\u003c/i\u003e:\u003ci\u003eMM\u003c/i\u003e:\u003ci\u003eSS\u003c/i\u003eZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.\u003c/p\u003e" }, "deregistrationProtection": { "type": "string", "description": "\u003cp\u003eIndicates whether deregistration protection is enabled for the AMI.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description of the AMI that was provided during image creation.\u003c/p\u003e" }, "enaSupport": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether enhanced networking with ENA is enabled.\u003c/p\u003e" }, "hypervisor": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HypervisorTypeEnumValueResponse", "description": "\u003cp\u003eThe hypervisor type of the image. Only \u003ccode\u003exen\u003c/code\u003e is supported. \u003ccode\u003eovm\u003c/code\u003e is not supported.\u003c/p\u003e" }, "imageId": { "type": "string", "description": "\u003cp\u003eThe ID of the AMI.\u003c/p\u003e" }, "imageLocation": { "type": "string", "description": "\u003cp\u003eThe location of the AMI.\u003c/p\u003e" }, "imageOwnerAlias": { "type": "string", "description": "\u003cp\u003eThe owner alias (\u003ccode\u003eamazon\u003c/code\u003e | \u003ccode\u003eaws-marketplace\u003c/code\u003e).\u003c/p\u003e" }, "imageType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageTypeValuesEnumValueResponse", "description": "\u003cp\u003eThe type of image.\u003c/p\u003e" }, "imdsSupport": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImdsSupportValuesEnumValueResponse", "description": "\u003cp\u003eIf \u003ccode\u003ev2.0\u003c/code\u003e, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have \u003ccode\u003eHttpTokens\u003c/code\u003e automatically set to \u003ccode\u003erequired\u003c/code\u003e so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, \u003ccode\u003eHttpPutResponseHopLimit\u003c/code\u003e is set to \u003ccode\u003e2\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration'\u003eConfigure the AMI\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "kernelId": { "type": "string", "description": "\u003cp\u003eThe kernel associated with the image, if any. Only applicable for machine images.\u003c/p\u003e" }, "lastLaunchedTime": { "type": "string", "description": "\u003cp\u003eThe date and time, in \u003ca href='http://www.iso.org/iso/iso8601'\u003eISO 8601 date-time format\u003c/a\u003e, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003ccode\u003elastLaunchedTime\u003c/code\u003e data is available starting April 2017.\u003c/p\u003e \u003c/note\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the AMI that was provided during image creation.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the image.\u003c/p\u003e" }, "platform": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlatformValuesEnumValueResponse", "description": "\u003cp\u003eThis value is set to \u003ccode\u003ewindows\u003c/code\u003e for Windows AMIs; otherwise, it is blank.\u003c/p\u003e" }, "platformDetails": { "type": "string", "description": "\u003cp\u003eThe platform details associated with the billing code of the AMI. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html'\u003eUnderstand AMI billing information\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "productCodes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProductCodeResponse" }, "description": "\u003cp\u003eAny product codes associated with the AMI.\u003c/p\u003e" }, "public": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the image has public launch permissions. The value is \u003ccode\u003etrue\u003c/code\u003e if this image has public launch permissions or \u003ccode\u003efalse\u003c/code\u003e if it has only implicit and explicit launch permissions.\u003c/p\u003e" }, "ramdiskId": { "type": "string", "description": "\u003cp\u003eThe RAM disk associated with the image, if any. Only applicable for machine images.\u003c/p\u003e" }, "rootDeviceName": { "type": "string", "description": "\u003cp\u003eThe device name of the root device volume (for example, \u003ccode\u003e/dev/sda1\u003c/code\u003e).\u003c/p\u003e" }, "rootDeviceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeviceTypeEnumValueResponse", "description": "\u003cp\u003eThe type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.\u003c/p\u003e" }, "sourceInstanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance that the AMI was created from if the AMI was created using \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'\u003eCreateImage\u003c/a\u003e. This field only appears if the AMI was created using CreateImage.\u003c/p\u003e" }, "sriovNetSupport": { "type": "string", "description": "\u003cp\u003eSpecifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageStateEnumValueResponse", "description": "\u003cp\u003eThe current state of the AMI. If the state is \u003ccode\u003eavailable\u003c/code\u003e, the image is successfully registered and can be used to launch an instance.\u003c/p\u003e" }, "stateReason": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StateReasonResponse", "description": "\u003cp\u003eThe reason for the state change.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eAny tags assigned to the image.\u003c/p\u003e" }, "tpmSupport": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TpmSupportValuesEnumValueResponse", "description": "\u003cp\u003eIf the image is configured for NitroTPM support, the value is \u003ccode\u003ev2.0\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'\u003eNitroTPM\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "usageOperation": { "type": "string", "description": "\u003cp\u003eThe operation of the Amazon EC2 instance and the billing code that is associated with the AMI. \u003ccode\u003eusageOperation\u003c/code\u003e corresponds to the \u003ca href='https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation'\u003elineitem/Operation\u003c/a\u003e column on your Amazon Web Services Cost and Usage Report and in the \u003ca href='https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html'\u003eAmazon Web Services Price List API\u003c/a\u003e. You can view these fields on the \u003cb\u003eInstances\u003c/b\u003e or \u003cb\u003eAMIs\u003c/b\u003e pages in the Amazon EC2 console, or in the responses that are returned by the \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html'\u003eDescribeImages\u003c/a\u003e command in the Amazon EC2 API, or the \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html'\u003edescribe-images\u003c/a\u003e command in the CLI.\u003c/p\u003e" }, "virtualizationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VirtualizationTypeEnumValueResponse", "description": "\u003cp\u003eThe type of virtualization of the AMI.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2InstanceProperties": { "description": "Definition of awsEc2Instance", "properties": { "amiLaunchIndex": { "type": "integer", "description": "\u003cp\u003eThe AMI launch index, which can be used to find this instance in the launch group.\u003c/p\u003e" }, "architecture": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArchitectureValuesEnumValue", "description": "\u003cp\u003eThe architecture of the image.\u003c/p\u003e" }, "blockDeviceMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceBlockDeviceMapping" }, "description": "\u003cp\u003eAny block device mapping entries for the instance.\u003c/p\u003e" }, "bootMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BootModeValuesEnumValue", "description": "\u003cp\u003eThe boot mode that was specified by the AMI. If the value is \u003ccode\u003euefi-preferred\u003c/code\u003e, the AMI supports both UEFI and Legacy BIOS. The \u003ccode\u003ecurrentInstanceBootMode\u003c/code\u003e parameter is the boot mode that is used to boot the instance at launch or start.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe operating system contained in the AMI must be configured to support the specified boot mode.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'\u003eBoot modes\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "capacityReservationId": { "type": "string", "description": "\u003cp\u003eThe ID of the Capacity Reservation.\u003c/p\u003e" }, "capacityReservationSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityReservationSpecificationResponse", "description": "\u003cp\u003eInformation about the Capacity Reservation targeting option.\u003c/p\u003e" }, "clientToken": { "type": "string", "description": "\u003cp\u003eThe idempotency token you provided when you launched the instance, if applicable.\u003c/p\u003e" }, "cpuOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CpuOptions", "description": "\u003cp\u003eThe CPU options for the instance.\u003c/p\u003e" }, "currentInstanceBootMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceBootModeValuesEnumValue", "description": "\u003cp\u003eThe boot mode that is used to boot the instance at launch or start. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'\u003eBoot modes\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "ebsOptimized": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.\u003c/p\u003e" }, "elasticGpuAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ElasticGpuAssociation" }, "description": "\u003cp\u003eDeprecated.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eAmazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.\u003c/p\u003e \u003c/note\u003e" }, "elasticInferenceAcceleratorAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ElasticInferenceAcceleratorAssociation" }, "description": "\u003cp\u003eThe elastic inference accelerator associated with the instance.\u003c/p\u003e" }, "enaSupport": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether enhanced networking with ENA is enabled.\u003c/p\u003e" }, "enclaveOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnclaveOptions", "description": "\u003cp\u003eIndicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\u003c/p\u003e" }, "hibernationOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HibernationOptions", "description": "\u003cp\u003eIndicates whether the instance is enabled for hibernation.\u003c/p\u003e" }, "hypervisor": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HypervisorTypeEnumValue", "description": "\u003cp\u003eThe hypervisor type of the instance. The value \u003ccode\u003exen\u003c/code\u003e is used for both Xen and Nitro hypervisors.\u003c/p\u003e" }, "iamInstanceProfile": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IamInstanceProfile", "description": "\u003cp\u003eThe IAM instance profile associated with the instance, if applicable.\u003c/p\u003e" }, "imageId": { "type": "string", "description": "\u003cp\u003eThe ID of the AMI used to launch the instance.\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance.\u003c/p\u003e" }, "instanceLifecycle": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceLifecycleTypeEnumValue", "description": "\u003cp\u003eIndicates whether this is a Spot Instance or a Scheduled Instance.\u003c/p\u003e" }, "instanceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceTypeEnumValue", "description": "\u003cp\u003eThe instance type.\u003c/p\u003e" }, "ipv6Address": { "type": "string", "description": "\u003cp\u003eThe IPv6 address assigned to the instance.\u003c/p\u003e" }, "kernelId": { "type": "string", "description": "\u003cp\u003eThe kernel associated with this instance, if applicable.\u003c/p\u003e" }, "keyName": { "type": "string", "description": "\u003cp\u003eThe name of the key pair, if this instance was launched with an associated key pair.\u003c/p\u003e" }, "launchTime": { "type": "string", "description": "\u003cp\u003eThe time the instance was launched.\u003c/p\u003e" }, "licenses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LicenseConfiguration" }, "description": "\u003cp\u003eThe license configurations for the instance.\u003c/p\u003e" }, "maintenanceOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMaintenanceOptions", "description": "\u003cp\u003eProvides information on the recovery and maintenance options of your instance.\u003c/p\u003e" }, "metadataOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataOptionsResponse", "description": "\u003cp\u003eThe metadata options for the instance.\u003c/p\u003e" }, "monitoring": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Monitoring", "description": "\u003cp\u003eThe monitoring for the instance.\u003c/p\u003e" }, "networkInterfaces": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterface" }, "description": "\u003cp\u003eThe network interfaces for the instance.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Outpost.\u003c/p\u003e" }, "placement": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Placement", "description": "\u003cp\u003eThe location where the instance launched, if applicable.\u003c/p\u003e" }, "platform": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlatformValuesEnumValue", "description": "\u003cp\u003eThe platform. This value is \u003ccode\u003ewindows\u003c/code\u003e for Windows instances; otherwise, it is empty.\u003c/p\u003e" }, "platformDetails": { "type": "string", "description": "\u003cp\u003eThe platform details value for the instance. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'\u003eAMI billing information fields\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "privateDnsName": { "type": "string", "description": "\u003cp\u003e[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the \u003ccode\u003erunning\u003c/code\u003e state. \u003c/p\u003e \u003cp\u003eThe Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.\u003c/p\u003e" }, "privateDnsNameOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrivateDnsNameOptionsResponse", "description": "\u003cp\u003eThe options for the instance hostname.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IPv4 address assigned to the instance.\u003c/p\u003e" }, "productCodes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProductCode" }, "description": "\u003cp\u003eThe product codes attached to this instance, if applicable.\u003c/p\u003e" }, "publicDnsName": { "type": "string", "description": "\u003cp\u003e[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the \u003ccode\u003erunning\u003c/code\u003e state. This name is only available if you've enabled DNS hostnames for your VPC.\u003c/p\u003e" }, "publicIpAddress": { "type": "string", "description": "\u003cp\u003eThe public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.\u003c/p\u003e \u003cp\u003eA Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.\u003c/p\u003e" }, "ramdiskId": { "type": "string", "description": "\u003cp\u003eThe RAM disk associated with this instance, if applicable.\u003c/p\u003e" }, "rootDeviceName": { "type": "string", "description": "\u003cp\u003eThe device name of the root device volume (for example, \u003ccode\u003e/dev/sda1\u003c/code\u003e).\u003c/p\u003e" }, "rootDeviceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeviceTypeEnumValue", "description": "\u003cp\u003eThe root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.\u003c/p\u003e" }, "securityGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GroupIdentifier" }, "description": "\u003cp\u003eThe security groups for the instance.\u003c/p\u003e" }, "sourceDestCheck": { "type": "boolean", "description": "\u003cp\u003eIndicates whether source/destination checking is enabled.\u003c/p\u003e" }, "spotInstanceRequestId": { "type": "string", "description": "\u003cp\u003eIf the request is a Spot Instance request, the ID of the request.\u003c/p\u003e" }, "sriovNetSupport": { "type": "string", "description": "\u003cp\u003eSpecifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceState", "description": "\u003cp\u003eThe current state of the instance.\u003c/p\u003e" }, "stateReason": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StateReason", "description": "\u003cp\u003eThe reason for the most recent state transition.\u003c/p\u003e" }, "stateTransitionReason": { "type": "string", "description": "\u003cp\u003eThe reason for the most recent state transition. This might be an empty string.\u003c/p\u003e" }, "subnetId": { "type": "string", "description": "\u003cp\u003eThe ID of the subnet in which the instance is running.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eAny tags assigned to the instance.\u003c/p\u003e" }, "tpmSupport": { "type": "string", "description": "\u003cp\u003eIf the instance is configured for NitroTPM support, the value is \u003ccode\u003ev2.0\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'\u003eNitroTPM\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "usageOperation": { "type": "string", "description": "\u003cp\u003eThe usage operation value for the instance. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'\u003eAMI billing information fields\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "usageOperationUpdateTime": { "type": "string", "description": "\u003cp\u003eThe time that the usage operation was last updated.\u003c/p\u003e" }, "virtualizationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VirtualizationTypeEnumValue", "description": "\u003cp\u003eThe virtualization type of the instance.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC in which the instance is running.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2InstancePropertiesResponse": { "description": "Definition of awsEc2Instance", "properties": { "amiLaunchIndex": { "type": "integer", "description": "\u003cp\u003eThe AMI launch index, which can be used to find this instance in the launch group.\u003c/p\u003e" }, "architecture": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArchitectureValuesEnumValueResponse", "description": "\u003cp\u003eThe architecture of the image.\u003c/p\u003e" }, "blockDeviceMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceBlockDeviceMappingResponse" }, "description": "\u003cp\u003eAny block device mapping entries for the instance.\u003c/p\u003e" }, "bootMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BootModeValuesEnumValueResponse", "description": "\u003cp\u003eThe boot mode that was specified by the AMI. If the value is \u003ccode\u003euefi-preferred\u003c/code\u003e, the AMI supports both UEFI and Legacy BIOS. The \u003ccode\u003ecurrentInstanceBootMode\u003c/code\u003e parameter is the boot mode that is used to boot the instance at launch or start.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe operating system contained in the AMI must be configured to support the specified boot mode.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'\u003eBoot modes\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "capacityReservationId": { "type": "string", "description": "\u003cp\u003eThe ID of the Capacity Reservation.\u003c/p\u003e" }, "capacityReservationSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityReservationSpecificationResponseResponse", "description": "\u003cp\u003eInformation about the Capacity Reservation targeting option.\u003c/p\u003e" }, "clientToken": { "type": "string", "description": "\u003cp\u003eThe idempotency token you provided when you launched the instance, if applicable.\u003c/p\u003e" }, "cpuOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CpuOptionsResponse", "description": "\u003cp\u003eThe CPU options for the instance.\u003c/p\u003e" }, "currentInstanceBootMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceBootModeValuesEnumValueResponse", "description": "\u003cp\u003eThe boot mode that is used to boot the instance at launch or start. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html'\u003eBoot modes\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "ebsOptimized": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.\u003c/p\u003e" }, "elasticGpuAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ElasticGpuAssociationResponse" }, "description": "\u003cp\u003eDeprecated.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eAmazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.\u003c/p\u003e \u003c/note\u003e" }, "elasticInferenceAcceleratorAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ElasticInferenceAcceleratorAssociationResponse" }, "description": "\u003cp\u003eThe elastic inference accelerator associated with the instance.\u003c/p\u003e" }, "enaSupport": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether enhanced networking with ENA is enabled.\u003c/p\u003e" }, "enclaveOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnclaveOptionsResponse", "description": "\u003cp\u003eIndicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.\u003c/p\u003e" }, "hibernationOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HibernationOptionsResponse", "description": "\u003cp\u003eIndicates whether the instance is enabled for hibernation.\u003c/p\u003e" }, "hypervisor": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HypervisorTypeEnumValueResponse", "description": "\u003cp\u003eThe hypervisor type of the instance. The value \u003ccode\u003exen\u003c/code\u003e is used for both Xen and Nitro hypervisors.\u003c/p\u003e" }, "iamInstanceProfile": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IamInstanceProfileResponse", "description": "\u003cp\u003eThe IAM instance profile associated with the instance, if applicable.\u003c/p\u003e" }, "imageId": { "type": "string", "description": "\u003cp\u003eThe ID of the AMI used to launch the instance.\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance.\u003c/p\u003e" }, "instanceLifecycle": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceLifecycleTypeEnumValueResponse", "description": "\u003cp\u003eIndicates whether this is a Spot Instance or a Scheduled Instance.\u003c/p\u003e" }, "instanceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceTypeEnumValueResponse", "description": "\u003cp\u003eThe instance type.\u003c/p\u003e" }, "ipv6Address": { "type": "string", "description": "\u003cp\u003eThe IPv6 address assigned to the instance.\u003c/p\u003e" }, "kernelId": { "type": "string", "description": "\u003cp\u003eThe kernel associated with this instance, if applicable.\u003c/p\u003e" }, "keyName": { "type": "string", "description": "\u003cp\u003eThe name of the key pair, if this instance was launched with an associated key pair.\u003c/p\u003e" }, "launchTime": { "type": "string", "description": "\u003cp\u003eThe time the instance was launched.\u003c/p\u003e" }, "licenses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LicenseConfigurationResponse" }, "description": "\u003cp\u003eThe license configurations for the instance.\u003c/p\u003e" }, "maintenanceOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMaintenanceOptionsResponse", "description": "\u003cp\u003eProvides information on the recovery and maintenance options of your instance.\u003c/p\u003e" }, "metadataOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataOptionsResponseResponse", "description": "\u003cp\u003eThe metadata options for the instance.\u003c/p\u003e" }, "monitoring": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MonitoringResponse", "description": "\u003cp\u003eThe monitoring for the instance.\u003c/p\u003e" }, "networkInterfaces": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceResponse" }, "description": "\u003cp\u003eThe network interfaces for the instance.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Outpost.\u003c/p\u003e" }, "placement": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementResponse", "description": "\u003cp\u003eThe location where the instance launched, if applicable.\u003c/p\u003e" }, "platform": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlatformValuesEnumValueResponse", "description": "\u003cp\u003eThe platform. This value is \u003ccode\u003ewindows\u003c/code\u003e for Windows instances; otherwise, it is empty.\u003c/p\u003e" }, "platformDetails": { "type": "string", "description": "\u003cp\u003eThe platform details value for the instance. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'\u003eAMI billing information fields\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "privateDnsName": { "type": "string", "description": "\u003cp\u003e[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the \u003ccode\u003erunning\u003c/code\u003e state. \u003c/p\u003e \u003cp\u003eThe Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.\u003c/p\u003e" }, "privateDnsNameOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrivateDnsNameOptionsResponseResponse", "description": "\u003cp\u003eThe options for the instance hostname.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IPv4 address assigned to the instance.\u003c/p\u003e" }, "productCodes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProductCodeResponse" }, "description": "\u003cp\u003eThe product codes attached to this instance, if applicable.\u003c/p\u003e" }, "publicDnsName": { "type": "string", "description": "\u003cp\u003e[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the \u003ccode\u003erunning\u003c/code\u003e state. This name is only available if you've enabled DNS hostnames for your VPC.\u003c/p\u003e" }, "publicIpAddress": { "type": "string", "description": "\u003cp\u003eThe public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.\u003c/p\u003e \u003cp\u003eA Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.\u003c/p\u003e" }, "ramdiskId": { "type": "string", "description": "\u003cp\u003eThe RAM disk associated with this instance, if applicable.\u003c/p\u003e" }, "rootDeviceName": { "type": "string", "description": "\u003cp\u003eThe device name of the root device volume (for example, \u003ccode\u003e/dev/sda1\u003c/code\u003e).\u003c/p\u003e" }, "rootDeviceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeviceTypeEnumValueResponse", "description": "\u003cp\u003eThe root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.\u003c/p\u003e" }, "securityGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GroupIdentifierResponse" }, "description": "\u003cp\u003eThe security groups for the instance.\u003c/p\u003e" }, "sourceDestCheck": { "type": "boolean", "description": "\u003cp\u003eIndicates whether source/destination checking is enabled.\u003c/p\u003e" }, "spotInstanceRequestId": { "type": "string", "description": "\u003cp\u003eIf the request is a Spot Instance request, the ID of the request.\u003c/p\u003e" }, "sriovNetSupport": { "type": "string", "description": "\u003cp\u003eSpecifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStateResponse", "description": "\u003cp\u003eThe current state of the instance.\u003c/p\u003e" }, "stateReason": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StateReasonResponse", "description": "\u003cp\u003eThe reason for the most recent state transition.\u003c/p\u003e" }, "stateTransitionReason": { "type": "string", "description": "\u003cp\u003eThe reason for the most recent state transition. This might be an empty string.\u003c/p\u003e" }, "subnetId": { "type": "string", "description": "\u003cp\u003eThe ID of the subnet in which the instance is running.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eAny tags assigned to the instance.\u003c/p\u003e" }, "tpmSupport": { "type": "string", "description": "\u003cp\u003eIf the instance is configured for NitroTPM support, the value is \u003ccode\u003ev2.0\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html'\u003eNitroTPM\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "usageOperation": { "type": "string", "description": "\u003cp\u003eThe usage operation value for the instance. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html'\u003eAMI billing information fields\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "usageOperationUpdateTime": { "type": "string", "description": "\u003cp\u003eThe time that the usage operation was last updated.\u003c/p\u003e" }, "virtualizationType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VirtualizationTypeEnumValueResponse", "description": "\u003cp\u003eThe virtualization type of the instance.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC in which the instance is running.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2InstanceStatusProperties": { "description": "Definition of awsEc2InstanceStatus", "properties": { "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone of the instance.\u003c/p\u003e" }, "events": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusEvent" }, "description": "\u003cp\u003eAny scheduled events associated with the instance.\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance.\u003c/p\u003e" }, "instanceState": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceState", "description": "\u003cp\u003eThe intended state of the instance. \u003ca\u003eDescribeInstanceStatus\u003c/a\u003e requires that an instance be in the \u003ccode\u003erunning\u003c/code\u003e state.\u003c/p\u003e" }, "instanceStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusSummary", "description": "\u003cp\u003eReports impaired functionality that stems from issues internal to the instance, such as impaired reachability.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Outpost.\u003c/p\u003e" }, "systemStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusSummary", "description": "\u003cp\u003eReports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2InstanceStatusPropertiesResponse": { "description": "Definition of awsEc2InstanceStatus", "properties": { "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone of the instance.\u003c/p\u003e" }, "events": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusEventResponse" }, "description": "\u003cp\u003eAny scheduled events associated with the instance.\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe ID of the instance.\u003c/p\u003e" }, "instanceState": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStateResponse", "description": "\u003cp\u003eThe intended state of the instance. \u003ca\u003eDescribeInstanceStatus\u003c/a\u003e requires that an instance be in the \u003ccode\u003erunning\u003c/code\u003e state.\u003c/p\u003e" }, "instanceStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusSummaryResponse", "description": "\u003cp\u003eReports impaired functionality that stems from issues internal to the instance, such as impaired reachability.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Outpost.\u003c/p\u003e" }, "systemStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusSummaryResponse", "description": "\u003cp\u003eReports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2IpamProperties": { "description": "Definition of awsEc2Ipam", "properties": { "defaultResourceDiscoveryAssociationId": { "type": "string", "description": "\u003cp\u003eThe IPAM's default resource discovery association ID.\u003c/p\u003e" }, "defaultResourceDiscoveryId": { "type": "string", "description": "\u003cp\u003eThe IPAM's default resource discovery ID.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description for the IPAM.\u003c/p\u003e" }, "ipamArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the IPAM.\u003c/p\u003e" }, "ipamId": { "type": "string", "description": "\u003cp\u003eThe ID of the IPAM.\u003c/p\u003e" }, "ipamRegion": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region of the IPAM.\u003c/p\u003e" }, "operatingRegions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpamOperatingRegion" }, "description": "\u003cp\u003eThe operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.\u003c/p\u003e \u003cp\u003eFor more information about operating Regions, see \u003ca href='https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html'\u003eCreate an IPAM\u003c/a\u003e in the \u003ci\u003eAmazon VPC IPAM User Guide\u003c/i\u003e.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services account ID of the owner of the IPAM.\u003c/p\u003e" }, "privateDefaultScopeId": { "type": "string", "description": "\u003cp\u003eThe ID of the IPAM's default private scope.\u003c/p\u003e" }, "publicDefaultScopeId": { "type": "string", "description": "\u003cp\u003eThe ID of the IPAM's default public scope.\u003c/p\u003e" }, "resourceDiscoveryAssociationCount": { "type": "integer", "description": "\u003cp\u003eThe IPAM's resource discovery association count.\u003c/p\u003e" }, "scopeCount": { "type": "integer", "description": "\u003cp\u003eThe number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see \u003ca href='https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html'\u003eQuotas in IPAM\u003c/a\u003e in the \u003ci\u003eAmazon VPC IPAM User Guide\u003c/i\u003e. \u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpamStateEnumValue", "description": "\u003cp\u003eThe state of the IPAM.\u003c/p\u003e" }, "stateMessage": { "type": "string", "description": "\u003cp\u003eThe state message.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eThe key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key \u003ccode\u003eOwner\u003c/code\u003e and the value \u003ccode\u003eTeamA\u003c/code\u003e, specify \u003ccode\u003etag:Owner\u003c/code\u003e for the filter name and \u003ccode\u003eTeamA\u003c/code\u003e for the filter value.\u003c/p\u003e" }, "tier": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpamTierEnumValue", "description": "\u003cp\u003eIPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see \u003ca href='http://aws.amazon.com/vpc/pricing/'\u003eAmazon VPC pricing \u0026gt; IPAM tab\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2IpamPropertiesResponse": { "description": "Definition of awsEc2Ipam", "properties": { "defaultResourceDiscoveryAssociationId": { "type": "string", "description": "\u003cp\u003eThe IPAM's default resource discovery association ID.\u003c/p\u003e" }, "defaultResourceDiscoveryId": { "type": "string", "description": "\u003cp\u003eThe IPAM's default resource discovery ID.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description for the IPAM.\u003c/p\u003e" }, "ipamArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the IPAM.\u003c/p\u003e" }, "ipamId": { "type": "string", "description": "\u003cp\u003eThe ID of the IPAM.\u003c/p\u003e" }, "ipamRegion": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region of the IPAM.\u003c/p\u003e" }, "operatingRegions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpamOperatingRegionResponse" }, "description": "\u003cp\u003eThe operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.\u003c/p\u003e \u003cp\u003eFor more information about operating Regions, see \u003ca href='https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html'\u003eCreate an IPAM\u003c/a\u003e in the \u003ci\u003eAmazon VPC IPAM User Guide\u003c/i\u003e.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services account ID of the owner of the IPAM.\u003c/p\u003e" }, "privateDefaultScopeId": { "type": "string", "description": "\u003cp\u003eThe ID of the IPAM's default private scope.\u003c/p\u003e" }, "publicDefaultScopeId": { "type": "string", "description": "\u003cp\u003eThe ID of the IPAM's default public scope.\u003c/p\u003e" }, "resourceDiscoveryAssociationCount": { "type": "integer", "description": "\u003cp\u003eThe IPAM's resource discovery association count.\u003c/p\u003e" }, "scopeCount": { "type": "integer", "description": "\u003cp\u003eThe number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see \u003ca href='https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html'\u003eQuotas in IPAM\u003c/a\u003e in the \u003ci\u003eAmazon VPC IPAM User Guide\u003c/i\u003e. \u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpamStateEnumValueResponse", "description": "\u003cp\u003eThe state of the IPAM.\u003c/p\u003e" }, "stateMessage": { "type": "string", "description": "\u003cp\u003eThe state message.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eThe key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key \u003ccode\u003eOwner\u003c/code\u003e and the value \u003ccode\u003eTeamA\u003c/code\u003e, specify \u003ccode\u003etag:Owner\u003c/code\u003e for the filter name and \u003ccode\u003eTeamA\u003c/code\u003e for the filter value.\u003c/p\u003e" }, "tier": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpamTierEnumValueResponse", "description": "\u003cp\u003eIPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see \u003ca href='http://aws.amazon.com/vpc/pricing/'\u003eAmazon VPC pricing \u0026gt; IPAM tab\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2KeyPairProperties": { "description": "Definition of awsEc2KeyPair", "properties": { "keyFingerprint": { "type": "string", "description": "Property keyFingerprint" }, "keyFormat": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KeyFormat" } ], "description": "The format of the key pair. Default: ``pem``", "default": "pem" }, "keyName": { "type": "string", "description": "A unique name for the key pair. Constraints: Up to 255 ASCII characters" }, "keyPairId": { "type": "string", "description": "Property keyPairId" }, "keyType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KeyType" } ], "description": "The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. Default: ``rsa``", "default": "rsa" }, "publicKeyMaterial": { "type": "string", "description": "The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags to apply to the key pair." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2KeyPairPropertiesResponse": { "description": "Definition of awsEc2KeyPair", "properties": { "keyFingerprint": { "type": "string", "description": "Property keyFingerprint" }, "keyFormat": { "type": "string", "description": "The format of the key pair. Default: ``pem``", "default": "pem" }, "keyName": { "type": "string", "description": "A unique name for the key pair. Constraints: Up to 255 ASCII characters" }, "keyPairId": { "type": "string", "description": "Property keyPairId" }, "keyType": { "type": "string", "description": "The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. Default: ``rsa``", "default": "rsa" }, "publicKeyMaterial": { "type": "string", "description": "The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags to apply to the key pair." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2NetworkAclProperties": { "description": "Definition of awsEc2NetworkAcl", "properties": { "id": { "type": "string", "description": "Property id" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags for the network ACL." }, "vpcId": { "type": "string", "description": "The ID of the VPC for the network ACL." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2NetworkAclPropertiesResponse": { "description": "Definition of awsEc2NetworkAcl", "properties": { "id": { "type": "string", "description": "Property id" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags for the network ACL." }, "vpcId": { "type": "string", "description": "The ID of the VPC for the network ACL." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2NetworkInterfaceProperties": { "description": "Definition of awsEc2NetworkInterface", "properties": { "connectionTrackingSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConnectionTrackingSpecification", "description": "Property connectionTrackingSpecification" }, "description": { "type": "string", "description": "A description for the network interface." }, "enablePrimaryIpv6": { "type": "boolean", "description": "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address." }, "groupSet": { "type": "array", "items": { "type": "string" }, "description": "A list of security group IDs associated with this network interface." }, "id": { "type": "string", "description": "Network interface id." }, "interfaceType": { "type": "string", "description": "Indicates the type of network interface." }, "ipv4PrefixCount": { "type": "integer", "description": "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses." }, "ipv4Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ipv4PrefixSpecification" }, "description": "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses." }, "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property." }, "ipv6Addresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv6Address" }, "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property." }, "ipv6PrefixCount": { "type": "integer", "description": "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." }, "ipv6Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ipv6PrefixSpecification" }, "description": "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." }, "primaryIpv6Address": { "type": "string", "description": "The primary IPv6 address" }, "primaryPrivateIpAddress": { "type": "string", "description": "Returns the primary private IP address of the network interface." }, "privateIpAddress": { "type": "string", "description": "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property." }, "privateIpAddresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrivateIpAddressSpecification" }, "description": "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property." }, "secondaryPrivateIpAddressCount": { "type": "integer", "description": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses" }, "secondaryPrivateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Returns the secondary private IP addresses of the network interface." }, "sourceDestCheck": { "type": "boolean", "description": "Indicates whether traffic to or from the instance is validated." }, "subnetId": { "type": "string", "description": "The ID of the subnet to associate with the network interface." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An arbitrary set of tags (key-value pairs) for this network interface." }, "vpcId": { "type": "string", "description": "The ID of the VPC" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2NetworkInterfacePropertiesResponse": { "description": "Definition of awsEc2NetworkInterface", "properties": { "connectionTrackingSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConnectionTrackingSpecificationResponse", "description": "Property connectionTrackingSpecification" }, "description": { "type": "string", "description": "A description for the network interface." }, "enablePrimaryIpv6": { "type": "boolean", "description": "If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address." }, "groupSet": { "type": "array", "items": { "type": "string" }, "description": "A list of security group IDs associated with this network interface." }, "id": { "type": "string", "description": "Network interface id." }, "interfaceType": { "type": "string", "description": "Indicates the type of network interface." }, "ipv4PrefixCount": { "type": "integer", "description": "The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses." }, "ipv4Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ipv4PrefixSpecificationResponse" }, "description": "Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses." }, "ipv6AddressCount": { "type": "integer", "description": "The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property." }, "ipv6Addresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv6AddressResponseV1" }, "description": "One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property." }, "ipv6PrefixCount": { "type": "integer", "description": "The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." }, "ipv6Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ipv6PrefixSpecificationResponse" }, "description": "Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses." }, "primaryIpv6Address": { "type": "string", "description": "The primary IPv6 address" }, "primaryPrivateIpAddress": { "type": "string", "description": "Returns the primary private IP address of the network interface." }, "privateIpAddress": { "type": "string", "description": "Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property." }, "privateIpAddresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrivateIpAddressSpecificationResponse" }, "description": "Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property." }, "secondaryPrivateIpAddressCount": { "type": "integer", "description": "The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses" }, "secondaryPrivateIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "Returns the secondary private IP addresses of the network interface." }, "sourceDestCheck": { "type": "boolean", "description": "Indicates whether traffic to or from the instance is validated." }, "subnetId": { "type": "string", "description": "The ID of the subnet to associate with the network interface." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An arbitrary set of tags (key-value pairs) for this network interface." }, "vpcId": { "type": "string", "description": "The ID of the VPC" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2RouteTableProperties": { "description": "Definition of awsEc2RouteTable", "properties": { "routeTableId": { "type": "string", "description": "Property routeTableId" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Any tags assigned to the route table." }, "vpcId": { "type": "string", "description": "The ID of the VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2RouteTablePropertiesResponse": { "description": "Definition of awsEc2RouteTable", "properties": { "routeTableId": { "type": "string", "description": "Property routeTableId" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Any tags assigned to the route table." }, "vpcId": { "type": "string", "description": "The ID of the VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2SecurityGroupProperties": { "description": "Definition of awsEc2SecurityGroup", "properties": { "description": { "type": "string", "description": "\u003cp\u003eA description of the security group.\u003c/p\u003e" }, "groupId": { "type": "string", "description": "\u003cp\u003eThe ID of the security group.\u003c/p\u003e" }, "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the security group.\u003c/p\u003e" }, "ipPermissions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpPermission" }, "description": "\u003cp\u003eThe inbound rules associated with the security group.\u003c/p\u003e" }, "ipPermissionsEgress": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpPermission" }, "description": "\u003cp\u003eThe outbound rules associated with the security group.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services account ID of the owner of the security group.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eAny tags assigned to the security group.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC for the security group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2SecurityGroupPropertiesResponse": { "description": "Definition of awsEc2SecurityGroup", "properties": { "description": { "type": "string", "description": "\u003cp\u003eA description of the security group.\u003c/p\u003e" }, "groupId": { "type": "string", "description": "\u003cp\u003eThe ID of the security group.\u003c/p\u003e" }, "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the security group.\u003c/p\u003e" }, "ipPermissions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpPermissionResponse" }, "description": "\u003cp\u003eThe inbound rules associated with the security group.\u003c/p\u003e" }, "ipPermissionsEgress": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpPermissionResponse" }, "description": "\u003cp\u003eThe outbound rules associated with the security group.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services account ID of the owner of the security group.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eAny tags assigned to the security group.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC for the security group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2SnapshotProperties": { "description": "Definition of awsEc2Snapshot", "properties": { "dataEncryptionKeyId": { "type": "string", "description": "\u003cp\u003eThe data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by \u003ca\u003eDescribeSnapshots\u003c/a\u003e.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description for the snapshot.\u003c/p\u003e" }, "encrypted": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the snapshot is encrypted.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the Outpost on which the snapshot is stored. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html'\u003eAmazon EBS local snapshots on Outposts\u003c/a\u003e in the \u003ci\u003eAmazon EBS User Guide\u003c/i\u003e.\u003c/p\u003e" }, "ownerAlias": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services owner alias, from an Amazon-maintained list (\u003ccode\u003eamazon\u003c/code\u003e). This is not the user-configured Amazon Web Services account alias set using the IAM console.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the EBS snapshot.\u003c/p\u003e" }, "progress": { "type": "string", "description": "\u003cp\u003eThe progress of the snapshot, as a percentage.\u003c/p\u003e" }, "restoreExpiryTime": { "type": "string", "description": "\u003cp\u003eOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.\u003c/p\u003e" }, "snapshotId": { "type": "string", "description": "\u003cp\u003eThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.\u003c/p\u003e" }, "sseType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSETypeEnumValue", "description": "\u003cp\u003eReserved for future use.\u003c/p\u003e" }, "startTime": { "type": "string", "description": "\u003cp\u003eThe time stamp when the snapshot was initiated.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapshotStateEnumValue", "description": "\u003cp\u003eThe snapshot state.\u003c/p\u003e" }, "stateMessage": { "type": "string", "description": "\u003cp\u003eEncrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by \u003ca\u003eDescribeSnapshots\u003c/a\u003e.\u003c/p\u003e" }, "storageTier": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StorageTierEnumValue", "description": "\u003cp\u003eThe storage tier in which the snapshot is stored. \u003ccode\u003estandard\u003c/code\u003e indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. \u003ccode\u003earchive\u003c/code\u003e indicates that the snapshot is currently archived and that it must be restored before it can be used.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eAny tags assigned to the snapshot.\u003c/p\u003e" }, "volumeId": { "type": "string", "description": "\u003cp\u003eThe ID of the volume that was used to create the snapshot. Snapshots created by the \u003ca\u003eCopySnapshot\u003c/a\u003e action have an arbitrary volume ID that should not be used for any purpose.\u003c/p\u003e" }, "volumeSize": { "type": "integer", "description": "\u003cp\u003eThe size of the volume, in GiB.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2SnapshotPropertiesResponse": { "description": "Definition of awsEc2Snapshot", "properties": { "dataEncryptionKeyId": { "type": "string", "description": "\u003cp\u003eThe data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by \u003ca\u003eDescribeSnapshots\u003c/a\u003e.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description for the snapshot.\u003c/p\u003e" }, "encrypted": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the snapshot is encrypted.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the Outpost on which the snapshot is stored. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html'\u003eAmazon EBS local snapshots on Outposts\u003c/a\u003e in the \u003ci\u003eAmazon EBS User Guide\u003c/i\u003e.\u003c/p\u003e" }, "ownerAlias": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services owner alias, from an Amazon-maintained list (\u003ccode\u003eamazon\u003c/code\u003e). This is not the user-configured Amazon Web Services account alias set using the IAM console.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the EBS snapshot.\u003c/p\u003e" }, "progress": { "type": "string", "description": "\u003cp\u003eThe progress of the snapshot, as a percentage.\u003c/p\u003e" }, "restoreExpiryTime": { "type": "string", "description": "\u003cp\u003eOnly for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.\u003c/p\u003e" }, "snapshotId": { "type": "string", "description": "\u003cp\u003eThe ID of the snapshot. Each snapshot receives a unique identifier when it is created.\u003c/p\u003e" }, "sseType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSETypeEnumValueResponse", "description": "\u003cp\u003eReserved for future use.\u003c/p\u003e" }, "startTime": { "type": "string", "description": "\u003cp\u003eThe time stamp when the snapshot was initiated.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapshotStateEnumValueResponse", "description": "\u003cp\u003eThe snapshot state.\u003c/p\u003e" }, "stateMessage": { "type": "string", "description": "\u003cp\u003eEncrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by \u003ca\u003eDescribeSnapshots\u003c/a\u003e.\u003c/p\u003e" }, "storageTier": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StorageTierEnumValueResponse", "description": "\u003cp\u003eThe storage tier in which the snapshot is stored. \u003ccode\u003estandard\u003c/code\u003e indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. \u003ccode\u003earchive\u003c/code\u003e indicates that the snapshot is currently archived and that it must be restored before it can be used.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eAny tags assigned to the snapshot.\u003c/p\u003e" }, "volumeId": { "type": "string", "description": "\u003cp\u003eThe ID of the volume that was used to create the snapshot. Snapshots created by the \u003ca\u003eCopySnapshot\u003c/a\u003e action have an arbitrary volume ID that should not be used for any purpose.\u003c/p\u003e" }, "volumeSize": { "type": "integer", "description": "\u003cp\u003eThe size of the volume, in GiB.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2SubnetProperties": { "description": "Definition of awsEc2Subnet", "properties": { "assignIpv6AddressOnCreation": { "type": "boolean", "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." }, "availabilityZone": { "type": "string", "description": "The Availability Zone of the subnet. If you update this property, you must also update the ``CidrBlock`` property." }, "availabilityZoneId": { "type": "string", "description": "The AZ ID of the subnet." }, "cidrBlock": { "type": "string", "description": "The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one." }, "enableDns64": { "type": "boolean", "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*." }, "enableLniAtDeviceIndex": { "type": "integer", "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1)." }, "ipv4IpamPoolId": { "type": "string", "description": "An IPv4 IPAM pool ID for the subnet." }, "ipv4NetmaskLength": { "type": "integer", "description": "An IPv4 netmask length for the subnet." }, "ipv6CidrBlock": { "type": "string", "description": "The IPv6 CIDR block. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "The IPv6 network ranges for the subnet, in CIDR notation." }, "ipv6IpamPoolId": { "type": "string", "description": "An IPv6 IPAM pool ID for the subnet." }, "ipv6Native": { "type": "boolean", "description": "Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*." }, "ipv6NetmaskLength": { "type": "integer", "description": "An IPv6 netmask length for the subnet." }, "mapPublicIpOnLaunch": { "type": "boolean", "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://aws.amazon.com/vpc/pricing/)." }, "networkAclAssociationId": { "type": "string", "description": "Property networkAclAssociationId" }, "outpostArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Outpost." }, "privateDnsNameOptionsOnLaunch": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrivateDnsNameOptionsOnLaunchModelProperties", "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. Available options: + EnableResourceNameDnsAAAARecord (true | false) + EnableResourceNameDnsARecord (true | false) + HostnameType (ip-name | resource-name)" }, "subnetId": { "type": "string", "description": "Property subnetId" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Any tags assigned to the subnet." }, "vpcId": { "type": "string", "description": "The ID of the VPC the subnet is in. If you update this property, you must also update the ``CidrBlock`` property." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2SubnetPropertiesResponse": { "description": "Definition of awsEc2Subnet", "properties": { "assignIpv6AddressOnCreation": { "type": "boolean", "description": "Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." }, "availabilityZone": { "type": "string", "description": "The Availability Zone of the subnet. If you update this property, you must also update the ``CidrBlock`` property." }, "availabilityZoneId": { "type": "string", "description": "The AZ ID of the subnet." }, "cidrBlock": { "type": "string", "description": "The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one." }, "enableDns64": { "type": "boolean", "description": "Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*." }, "enableLniAtDeviceIndex": { "type": "integer", "description": "Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1)." }, "ipv4IpamPoolId": { "type": "string", "description": "An IPv4 IPAM pool ID for the subnet." }, "ipv4NetmaskLength": { "type": "integer", "description": "An IPv4 netmask length for the subnet." }, "ipv6CidrBlock": { "type": "string", "description": "The IPv6 CIDR block. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block." }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "The IPv6 network ranges for the subnet, in CIDR notation." }, "ipv6IpamPoolId": { "type": "string", "description": "An IPv6 IPAM pool ID for the subnet." }, "ipv6Native": { "type": "boolean", "description": "Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*." }, "ipv6NetmaskLength": { "type": "integer", "description": "An IPv6 netmask length for the subnet." }, "mapPublicIpOnLaunch": { "type": "boolean", "description": "Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://aws.amazon.com/vpc/pricing/)." }, "networkAclAssociationId": { "type": "string", "description": "Property networkAclAssociationId" }, "outpostArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Outpost." }, "privateDnsNameOptionsOnLaunch": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrivateDnsNameOptionsOnLaunchModelPropertiesResponse", "description": "The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. Available options: + EnableResourceNameDnsAAAARecord (true | false) + EnableResourceNameDnsARecord (true | false) + HostnameType (ip-name | resource-name)" }, "subnetId": { "type": "string", "description": "Property subnetId" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Any tags assigned to the subnet." }, "vpcId": { "type": "string", "description": "The ID of the VPC the subnet is in. If you update this property, you must also update the ``CidrBlock`` property." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VPCEndpointProperties": { "description": "Definition of awsEc2VPCEndpoint", "properties": { "creationTimestamp": { "type": "string", "description": "Property creationTimestamp" }, "dnsEntries": { "type": "array", "items": { "type": "string" }, "description": "Property dnsEntries" }, "id": { "type": "string", "description": "Property id" }, "networkInterfaceIds": { "type": "array", "items": { "type": "string" }, "description": "Property networkInterfaceIds" }, "policyDocument": { "$ref": "pulumi.json#/Any", "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint." }, "privateDnsEnabled": { "type": "boolean", "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. This property is supported only for interface endpoints. Default: ``false``" }, "routeTableIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the route tables. Routing is supported only for gateway endpoints." }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints." }, "serviceName": { "type": "string", "description": "The name of the endpoint service." }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet." }, "vpcEndpointType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:VpcEndpointType" } ], "description": "The type of endpoint. Default: Gateway" }, "vpcId": { "type": "string", "description": "The ID of the VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VPCEndpointPropertiesResponse": { "description": "Definition of awsEc2VPCEndpoint", "properties": { "creationTimestamp": { "type": "string", "description": "Property creationTimestamp" }, "dnsEntries": { "type": "array", "items": { "type": "string" }, "description": "Property dnsEntries" }, "id": { "type": "string", "description": "Property id" }, "networkInterfaceIds": { "type": "array", "items": { "type": "string" }, "description": "Property networkInterfaceIds" }, "policyDocument": { "$ref": "pulumi.json#/Any", "description": "An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint." }, "privateDnsEnabled": { "type": "boolean", "description": "Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. This property is supported only for interface endpoints. Default: ``false``" }, "routeTableIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the route tables. Routing is supported only for gateway endpoints." }, "securityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints." }, "serviceName": { "type": "string", "description": "The name of the endpoint service." }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet." }, "vpcEndpointType": { "type": "string", "description": "The type of endpoint. Default: Gateway" }, "vpcId": { "type": "string", "description": "The ID of the VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VPCPeeringConnectionProperties": { "description": "Definition of awsEc2VPCPeeringConnection", "properties": { "id": { "type": "string", "description": "Property id" }, "peerOwnerId": { "type": "string", "description": "The AWS account ID of the owner of the accepter VPC." }, "peerRegion": { "type": "string", "description": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request." }, "peerRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account." }, "peerVpcId": { "type": "string", "description": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "vpcId": { "type": "string", "description": "The ID of the VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VPCPeeringConnectionPropertiesResponse": { "description": "Definition of awsEc2VPCPeeringConnection", "properties": { "id": { "type": "string", "description": "Property id" }, "peerOwnerId": { "type": "string", "description": "The AWS account ID of the owner of the accepter VPC." }, "peerRegion": { "type": "string", "description": "The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request." }, "peerRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account." }, "peerVpcId": { "type": "string", "description": "The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "vpcId": { "type": "string", "description": "The ID of the VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VolumeProperties": { "description": "Definition of awsEc2Volume", "properties": { "autoEnableIO": { "type": "boolean", "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O." }, "availabilityZone": { "type": "string", "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``." }, "encrypted": { "type": "boolean", "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances)." }, "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes." }, "kmsKeyId": { "type": "string", "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias." }, "multiAttachEnabled": { "type": "boolean", "description": "Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume." }, "outpostArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Outpost." }, "size": { "type": "integer", "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + ``gp2`` and ``gp3``: 1 - 16,384 GiB + ``io1``: 4 - 16,384 GiB + ``io2``: 4 - 65,536 GiB + ``st1`` and ``sc1``: 125 - 16,384 GiB + ``standard``: 1 - 1024 GiB" }, "snapshotId": { "type": "string", "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags to apply to the volume during creation." }, "throughput": { "type": "integer", "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for ``gp3`` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000." }, "volumeId": { "type": "string", "description": "Property volumeId" }, "volumeType": { "type": "string", "description": "The volume type. This parameter can be one of the following values: + General Purpose SSD: ``gp2`` | ``gp3`` + Provisioned IOPS SSD: ``io1`` | ``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. Default: ``gp2``" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VolumePropertiesResponse": { "description": "Definition of awsEc2Volume", "properties": { "autoEnableIO": { "type": "boolean", "description": "Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O." }, "availabilityZone": { "type": "string", "description": "The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``." }, "encrypted": { "type": "boolean", "description": "Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances)." }, "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes." }, "kmsKeyId": { "type": "string", "description": "The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias." }, "multiAttachEnabled": { "type": "boolean", "description": "Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume." }, "outpostArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Outpost." }, "size": { "type": "integer", "description": "The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + ``gp2`` and ``gp3``: 1 - 16,384 GiB + ``io1``: 4 - 16,384 GiB + ``io2``: 4 - 65,536 GiB + ``st1`` and ``sc1``: 125 - 16,384 GiB + ``standard``: 1 - 1024 GiB" }, "snapshotId": { "type": "string", "description": "The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags to apply to the volume during creation." }, "throughput": { "type": "integer", "description": "The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for ``gp3`` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000." }, "volumeId": { "type": "string", "description": "Property volumeId" }, "volumeType": { "type": "string", "description": "The volume type. This parameter can be one of the following values: + General Purpose SSD: ``gp2`` | ``gp3`` + Provisioned IOPS SSD: ``io1`` | ``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. Default: ``gp2``" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VpcProperties": { "description": "Definition of awsEc2Vpc", "properties": { "cidrBlock": { "type": "string", "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." }, "cidrBlockAssociations": { "type": "array", "items": { "type": "string" }, "description": "Property cidrBlockAssociations" }, "defaultNetworkAcl": { "type": "string", "description": "Property defaultNetworkAcl" }, "defaultSecurityGroup": { "type": "string", "description": "Property defaultSecurityGroup" }, "enableDnsHostnames": { "type": "boolean", "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). You can only enable DNS hostnames if you've enabled DNS support." }, "enableDnsSupport": { "type": "boolean", "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range 'plus two' succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support)." }, "instanceTenancy": { "type": "string", "description": "The allowed tenancy of instances launched into the VPC. + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement." }, "ipv4IpamPoolId": { "type": "string", "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." }, "ipv4NetmaskLength": { "type": "integer", "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*." }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Property ipv6CidrBlocks" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags for the VPC." }, "vpcId": { "type": "string", "description": "Property vpcId" } }, "type": "object" }, "azure-native:awsconnector:AwsEc2VpcPropertiesResponse": { "description": "Definition of awsEc2Vpc", "properties": { "cidrBlock": { "type": "string", "description": "The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." }, "cidrBlockAssociations": { "type": "array", "items": { "type": "string" }, "description": "Property cidrBlockAssociations" }, "defaultNetworkAcl": { "type": "string", "description": "Property defaultNetworkAcl" }, "defaultSecurityGroup": { "type": "string", "description": "Property defaultSecurityGroup" }, "enableDnsHostnames": { "type": "boolean", "description": "Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). You can only enable DNS hostnames if you've enabled DNS support." }, "enableDnsSupport": { "type": "boolean", "description": "Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range 'plus two' succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support)." }, "instanceTenancy": { "type": "string", "description": "The allowed tenancy of instances launched into the VPC. + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement." }, "ipv4IpamPoolId": { "type": "string", "description": "The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``." }, "ipv4NetmaskLength": { "type": "integer", "description": "The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*." }, "ipv6CidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "Property ipv6CidrBlocks" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags for the VPC." }, "vpcId": { "type": "string", "description": "Property vpcId" } }, "type": "object" }, "azure-native:awsconnector:AwsEcrImageDetailProperties": { "description": "Definition of awsEcrImageDetail", "properties": { "artifactMediaType": { "type": "string", "description": "\u003cp\u003eThe artifact media type of the image.\u003c/p\u003e" }, "imageDigest": { "type": "string", "description": "\u003cp\u003eThe \u003ccode\u003esha256\u003c/code\u003e digest of the image manifest.\u003c/p\u003e" }, "imageManifestMediaType": { "type": "string", "description": "\u003cp\u003eThe media type of the image manifest.\u003c/p\u003e" }, "imagePushedAt": { "type": "string", "description": "\u003cp\u003eThe date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. \u003c/p\u003e" }, "imageScanFindingsSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageScanFindingsSummary", "description": "\u003cp\u003eA summary of the last completed image scan.\u003c/p\u003e" }, "imageScanStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageScanStatus", "description": "\u003cp\u003eThe current state of the scan.\u003c/p\u003e" }, "imageSizeInBytes": { "type": "number", "description": "\u003cp\u003eThe size, in bytes, of the image in the repository.\u003c/p\u003e \u003cp\u003eIf the image is a manifest list, this will be the max size of all manifests in the list.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eBeginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the \u003ccode\u003edocker images\u003c/code\u003e command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by \u003ca\u003eDescribeImages\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e" }, "imageTags": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe list of tags associated with this image.\u003c/p\u003e" }, "lastRecordedPullTime": { "type": "string", "description": "\u003cp\u003eThe date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eAmazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the \u003ccode\u003elastRecordedPullTime\u003c/code\u003e timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the \u003ccode\u003elastRecordedPullTime\u003c/code\u003e timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.\u003c/p\u003e \u003c/note\u003e" }, "registryId": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services account ID associated with the registry to which this image belongs.\u003c/p\u003e" }, "repositoryName": { "type": "string", "description": "\u003cp\u003eThe name of the repository to which this image belongs.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEcrImageDetailPropertiesResponse": { "description": "Definition of awsEcrImageDetail", "properties": { "artifactMediaType": { "type": "string", "description": "\u003cp\u003eThe artifact media type of the image.\u003c/p\u003e" }, "imageDigest": { "type": "string", "description": "\u003cp\u003eThe \u003ccode\u003esha256\u003c/code\u003e digest of the image manifest.\u003c/p\u003e" }, "imageManifestMediaType": { "type": "string", "description": "\u003cp\u003eThe media type of the image manifest.\u003c/p\u003e" }, "imagePushedAt": { "type": "string", "description": "\u003cp\u003eThe date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository. \u003c/p\u003e" }, "imageScanFindingsSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageScanFindingsSummaryResponse", "description": "\u003cp\u003eA summary of the last completed image scan.\u003c/p\u003e" }, "imageScanStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageScanStatusResponse", "description": "\u003cp\u003eThe current state of the scan.\u003c/p\u003e" }, "imageSizeInBytes": { "type": "number", "description": "\u003cp\u003eThe size, in bytes, of the image in the repository.\u003c/p\u003e \u003cp\u003eIf the image is a manifest list, this will be the max size of all manifests in the list.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eBeginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the \u003ccode\u003edocker images\u003c/code\u003e command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by \u003ca\u003eDescribeImages\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e" }, "imageTags": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe list of tags associated with this image.\u003c/p\u003e" }, "lastRecordedPullTime": { "type": "string", "description": "\u003cp\u003eThe date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eAmazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the \u003ccode\u003elastRecordedPullTime\u003c/code\u003e timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the \u003ccode\u003elastRecordedPullTime\u003c/code\u003e timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.\u003c/p\u003e \u003c/note\u003e" }, "registryId": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services account ID associated with the registry to which this image belongs.\u003c/p\u003e" }, "repositoryName": { "type": "string", "description": "\u003cp\u003eThe name of the repository to which this image belongs.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEcrRepositoryProperties": { "description": "Definition of awsEcrRepository", "properties": { "arn": { "type": "string", "description": "Property arn" }, "emptyOnDelete": { "type": "boolean", "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories." }, "encryptionConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionConfiguration", "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part. For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*." }, "imageScanningConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageScanningConfiguration", "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. The image scanning configuration for a repository." }, "imageTagMutability": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ImageTagMutability" } ], "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten." }, "lifecyclePolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecyclePolicy", "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*." }, "repositoryName": { "type": "string", "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "repositoryPolicyText": { "$ref": "pulumi.json#/Any", "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*." }, "repositoryUri": { "type": "string", "description": "Property repositoryUri" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." } }, "type": "object" }, "azure-native:awsconnector:AwsEcrRepositoryPropertiesResponse": { "description": "Definition of awsEcrRepository", "properties": { "arn": { "type": "string", "description": "Property arn" }, "emptyOnDelete": { "type": "boolean", "description": "If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories." }, "encryptionConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionConfigurationResponse", "description": "The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part. For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*." }, "imageScanningConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageScanningConfigurationResponse", "description": "The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. The image scanning configuration for a repository." }, "imageTagMutability": { "type": "string", "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten." }, "lifecyclePolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecyclePolicyResponse", "description": "Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*." }, "repositoryName": { "type": "string", "description": "The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "repositoryPolicyText": { "$ref": "pulumi.json#/Any", "description": "The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*." }, "repositoryUri": { "type": "string", "description": "Property repositoryUri" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." } }, "type": "object" }, "azure-native:awsconnector:AwsEcsClusterProperties": { "description": "Definition of awsEcsCluster", "properties": { "arn": { "type": "string", "description": "Property arn" }, "capacityProviders": { "type": "array", "items": { "type": "string" }, "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation. To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created." }, "clusterName": { "type": "string", "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name." }, "clusterSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterSettings" }, "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster." }, "configuration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterConfiguration", "description": "The execute command configuration for the cluster. The execute command configuration for the cluster." }, "defaultCapacityProviderStrategy": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityProviderStrategyItem" }, "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used." }, "serviceConnectDefaults": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectDefaults", "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." } }, "type": "object" }, "azure-native:awsconnector:AwsEcsClusterPropertiesResponse": { "description": "Definition of awsEcsCluster", "properties": { "arn": { "type": "string", "description": "Property arn" }, "capacityProviders": { "type": "array", "items": { "type": "string" }, "description": "The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation. To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created." }, "clusterName": { "type": "string", "description": "A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name." }, "clusterSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterSettingsResponse" }, "description": "The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster." }, "configuration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterConfigurationResponse", "description": "The execute command configuration for the cluster. The execute command configuration for the cluster." }, "defaultCapacityProviderStrategy": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityProviderStrategyItemResponse" }, "description": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used." }, "serviceConnectDefaults": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectDefaultsResponse", "description": "Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." } }, "type": "object" }, "azure-native:awsconnector:AwsEcsServiceProperties": { "description": "Definition of awsEcsService", "properties": { "capacityProviderStrategy": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityProviderStrategyItem" }, "description": "The capacity provider strategy to use for the service. If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers." }, "cluster": { "type": "string", "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed." }, "deploymentConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentConfiguration", "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." }, "deploymentController": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentController", "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used. The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*." }, "desiredCount": { "type": "integer", "description": "The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. For existing services, if a desired count is not specified, it is omitted from the operation." }, "enableECSManagedTags": { "type": "boolean", "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter." }, "enableExecuteCommand": { "type": "boolean", "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service." }, "healthCheckGracePeriodSeconds": { "type": "integer", "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used. If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up." }, "launchType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LaunchType" } ], "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." }, "loadBalancers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoadBalancer" }, "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*." }, "name": { "type": "string", "description": "Property name" }, "networkConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkConfiguration", "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service." }, "placementConstraints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementConstraint" }, "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime." }, "placementStrategies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementStrategy" }, "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service." }, "platformVersion": { "type": "string", "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.", "default": "LATEST" }, "propagateTags": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PropagateTags" } ], "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. The default is ``NONE``." }, "role": { "type": "string", "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*." }, "schedulingStrategy": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SchedulingStrategy" } ], "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). There are two service scheduler strategies available: + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy." }, "serviceArn": { "type": "string", "description": "Property serviceArn" }, "serviceConnectConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectConfiguration", "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "serviceName": { "type": "string", "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster." }, "serviceRegistries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceRegistry" }, "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). Each service may be associated with one service registry. Multiple service registries for each service isn't supported." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." }, "taskDefinition": { "type": "string", "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)." }, "volumeConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceVolumeConfiguration" }, "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume." } }, "type": "object" }, "azure-native:awsconnector:AwsEcsServicePropertiesResponse": { "description": "Definition of awsEcsService", "properties": { "capacityProviderStrategy": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityProviderStrategyItemResponse" }, "description": "The capacity provider strategy to use for the service. If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers." }, "cluster": { "type": "string", "description": "The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed." }, "deploymentConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentConfigurationResponse", "description": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks." }, "deploymentController": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentControllerResponse", "description": "The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used. The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*." }, "desiredCount": { "type": "integer", "description": "The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. For existing services, if a desired count is not specified, it is omitted from the operation." }, "enableECSManagedTags": { "type": "boolean", "description": "Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter." }, "enableExecuteCommand": { "type": "boolean", "description": "Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service." }, "healthCheckGracePeriodSeconds": { "type": "integer", "description": "The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used. If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up." }, "launchType": { "type": "string", "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." }, "loadBalancers": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoadBalancerResponse" }, "description": "A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*." }, "name": { "type": "string", "description": "Property name" }, "networkConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkConfigurationResponse", "description": "The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service." }, "placementConstraints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementConstraintResponse" }, "description": "An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime." }, "placementStrategies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementStrategyResponse" }, "description": "The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service." }, "platformVersion": { "type": "string", "description": "The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*.", "default": "LATEST" }, "propagateTags": { "type": "string", "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. The default is ``NONE``." }, "role": { "type": "string", "description": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*." }, "schedulingStrategy": { "type": "string", "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). There are two service scheduler strategies available: + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy." }, "serviceArn": { "type": "string", "description": "Property serviceArn" }, "serviceConnectConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectConfigurationResponse", "description": "The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "serviceName": { "type": "string", "description": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster." }, "serviceRegistries": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceRegistryResponse" }, "description": "The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). Each service may be associated with one service registry. Multiple service registries for each service isn't supported." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." }, "taskDefinition": { "type": "string", "description": "The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)." }, "volumeConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceVolumeConfigurationResponse" }, "description": "The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume." } }, "type": "object" }, "azure-native:awsconnector:AwsEcsTaskDefinitionProperties": { "description": "Definition of awsEcsTaskDefinition", "properties": { "containerDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContainerDefinition" }, "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*." }, "cpu": { "type": "string", "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later." }, "ephemeralStorage": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EphemeralStorage", "description": "The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version ``1.4.0`` or later. + Windows platform version ``1.0.0`` or later." }, "executionRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*." }, "family": { "type": "string", "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it." }, "inferenceAccelerators": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InferenceAccelerator" }, "description": "The Elastic Inference accelerators to use for the containers in the task." }, "ipcMode": { "type": "string", "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.docker.com/engine/security/security/). If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong." }, "memory": { "type": "string", "description": "The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) This option requires Linux platform ``1.4.0`` or later. + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) This option requires Linux platform ``1.4.0`` or later." }, "networkMode": { "type": "string", "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``\u003cdefault\u003e`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. For more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*." }, "pidMode": { "type": "string", "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.docker.com/engine/security/security/). This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate." }, "placementConstraints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TaskDefinitionPlacementConstraint" }, "description": "An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong." }, "proxyConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProxyConfiguration", "description": "The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)" }, "requiresCompatibilities": { "type": "array", "items": { "type": "string" }, "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." }, "runtimePlatform": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuntimePlatform", "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. Information about the platform for the Amazon ECS service or task. For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." }, "taskDefinitionArn": { "type": "string", "description": "Property taskDefinitionArn" }, "taskRoleArn": { "type": "string", "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*." }, "volumes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Volume" }, "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong." } }, "type": "object" }, "azure-native:awsconnector:AwsEcsTaskDefinitionPropertiesResponse": { "description": "Definition of awsEcsTaskDefinition", "properties": { "containerDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContainerDefinitionResponse" }, "description": "A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*." }, "cpu": { "type": "string", "description": "The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later." }, "ephemeralStorage": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EphemeralStorageResponse", "description": "The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version ``1.4.0`` or later. + Windows platform version ``1.0.0`` or later." }, "executionRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*." }, "family": { "type": "string", "description": "The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it." }, "inferenceAccelerators": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InferenceAcceleratorResponse" }, "description": "The Elastic Inference accelerators to use for the containers in the task." }, "ipcMode": { "type": "string", "description": "The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.docker.com/engine/security/security/). If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong." }, "memory": { "type": "string", "description": "The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) This option requires Linux platform ``1.4.0`` or later. + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) This option requires Linux platform ``1.4.0`` or later." }, "networkMode": { "type": "string", "description": "The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ``\u003cdefault\u003e`` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. For more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*." }, "pidMode": { "type": "string", "description": "The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.docker.com/engine/security/security/). This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate." }, "placementConstraints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TaskDefinitionPlacementConstraintResponse" }, "description": "An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong." }, "proxyConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProxyConfigurationResponse", "description": "The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html)" }, "requiresCompatibilities": { "type": "array", "items": { "type": "string" }, "description": "The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*." }, "runtimePlatform": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuntimePlatformResponse", "description": "The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. Information about the platform for the Amazon ECS service or task. For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit." }, "taskDefinitionArn": { "type": "string", "description": "Property taskDefinitionArn" }, "taskRoleArn": { "type": "string", "description": "The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*." }, "volumes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeResponse" }, "description": "The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong." } }, "type": "object" }, "azure-native:awsconnector:AwsEfsFileSystemProperties": { "description": "Definition of awsEfsFileSystem", "properties": { "arn": { "type": "string", "description": "Property arn" }, "availabilityZoneName": { "type": "string", "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available." }, "backupPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BackupPolicy", "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. The backup policy turns automatic backups for the file system on or off." }, "bypassPolicyLockoutSafetyCheck": { "type": "boolean", "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``." }, "encrypted": { "type": "boolean", "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system." }, "fileSystemId": { "type": "string", "description": "Property fileSystemId" }, "fileSystemPolicy": { "$ref": "pulumi.json#/Any", "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*." }, "fileSystemProtection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FileSystemProtection", "description": "Describes the protection on the file system. Describes the protection on the file system." }, "fileSystemTags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ElasticFileSystemTag" }, "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``'Key':'Name','Value':'{value}'`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*." }, "kmsKeyId": { "type": "string", "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true." }, "lifecyclePolicies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecyclePolicy" }, "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + When to move files in the file system from primary storage to IA storage. + When to move files in the file system from primary storage or IA storage to Archive storage. + When to move files that are in IA or Archive storage to primary storage. EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information." }, "performanceMode": { "type": "string", "description": "The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is ``generalPurpose``." }, "provisionedThroughputInMibps": { "type": "integer", "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*." }, "replicationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationConfiguration", "description": "Describes the replication configuration for a specific file system. Describes the replication configuration for a specific file system." }, "throughputMode": { "type": "string", "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. Default is ``bursting``." } }, "type": "object" }, "azure-native:awsconnector:AwsEfsFileSystemPropertiesResponse": { "description": "Definition of awsEfsFileSystem", "properties": { "arn": { "type": "string", "description": "Property arn" }, "availabilityZoneName": { "type": "string", "description": "For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available." }, "backupPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BackupPolicyResponse", "description": "Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. The backup policy turns automatic backups for the file system on or off." }, "bypassPolicyLockoutSafetyCheck": { "type": "boolean", "description": "(Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``." }, "encrypted": { "type": "boolean", "description": "A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system." }, "fileSystemId": { "type": "string", "description": "Property fileSystemId" }, "fileSystemPolicy": { "$ref": "pulumi.json#/Any", "description": "The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*." }, "fileSystemProtection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FileSystemProtectionResponse", "description": "Describes the protection on the file system. Describes the protection on the file system." }, "fileSystemTags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ElasticFileSystemTagResponse" }, "description": "Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``'Key':'Name','Value':'{value}'`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*." }, "kmsKeyId": { "type": "string", "description": "The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true." }, "lifecyclePolicies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecyclePolicyResponseV1" }, "description": "An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + When to move files in the file system from primary storage to IA storage. + When to move files in the file system from primary storage or IA storage to Archive storage. + When to move files that are in IA or Archive storage to primary storage. EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information." }, "performanceMode": { "type": "string", "description": "The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is ``generalPurpose``." }, "provisionedThroughputInMibps": { "type": "integer", "description": "The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*." }, "replicationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationConfigurationResponse", "description": "Describes the replication configuration for a specific file system. Describes the replication configuration for a specific file system." }, "throughputMode": { "type": "string", "description": "Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. Default is ``bursting``." } }, "type": "object" }, "azure-native:awsconnector:AwsEfsMountTargetProperties": { "description": "Definition of awsEfsMountTarget", "properties": { "fileSystemId": { "type": "string", "description": "The ID of the file system for which to create the mount target." }, "id": { "type": "string", "description": "Property id" }, "ipAddress": { "type": "string", "description": "Valid IPv4 address within the address range of the specified subnet." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified." }, "subnetId": { "type": "string", "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone." } }, "type": "object" }, "azure-native:awsconnector:AwsEfsMountTargetPropertiesResponse": { "description": "Definition of awsEfsMountTarget", "properties": { "fileSystemId": { "type": "string", "description": "The ID of the file system for which to create the mount target." }, "id": { "type": "string", "description": "Property id" }, "ipAddress": { "type": "string", "description": "Valid IPv4 address within the address range of the specified subnet." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified." }, "subnetId": { "type": "string", "description": "The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone." } }, "type": "object" }, "azure-native:awsconnector:AwsEksClusterProperties": { "description": "Definition of awsEksCluster", "properties": { "accessConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessConfigResponse", "description": "\u003cp\u003eThe access configuration for the cluster.\u003c/p\u003e" }, "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the cluster.\u003c/p\u003e" }, "certificateAuthority": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Certificate", "description": "\u003cp\u003eThe \u003ccode\u003ecertificate-authority-data\u003c/code\u003e for your cluster.\u003c/p\u003e" }, "clientRequestToken": { "type": "string", "description": "\u003cp\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\u003c/p\u003e" }, "connectorConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConnectorConfigResponse", "description": "\u003cp\u003eThe configuration used to connect to a cluster for registration.\u003c/p\u003e" }, "createdAt": { "type": "string", "description": "\u003cp\u003eThe Unix epoch timestamp at object creation.\u003c/p\u003e" }, "encryptionConfig": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionConfig" }, "description": "\u003cp\u003eThe encryption configuration for the cluster.\u003c/p\u003e" }, "endpoint": { "type": "string", "description": "\u003cp\u003eThe endpoint for your Kubernetes API server.\u003c/p\u003e" }, "health": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterHealth", "description": "\u003cp\u003eAn object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.\u003c/p\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.\u003c/p\u003e" }, "identity": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Identity", "description": "\u003cp\u003eThe identity provider information for the cluster.\u003c/p\u003e" }, "kubernetesNetworkConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KubernetesNetworkConfigResponse", "description": "\u003cp\u003eThe Kubernetes network configuration for the cluster.\u003c/p\u003e" }, "logging": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Logging", "description": "\u003cp\u003eThe logging configuration for your cluster.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of your cluster.\u003c/p\u003e" }, "outpostConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OutpostConfigResponse", "description": "\u003cp\u003eAn object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.\u003c/p\u003e" }, "platformVersion": { "type": "string", "description": "\u003cp\u003eThe platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html'\u003ePlatform versions\u003c/a\u003e in the \u003ci\u003e \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e \u003c/i\u003e. For more information about local clusters deployed on an Outpost, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html'\u003eAmazon EKS local cluster platform versions\u003c/a\u003e in the \u003ci\u003e \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e \u003c/i\u003e.\u003c/p\u003e" }, "resourcesVpcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfigResponse", "description": "\u003cp\u003eThe VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html'\u003eCluster VPC considerations\u003c/a\u003e and \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html'\u003eCluster security group considerations\u003c/a\u003e in the \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e.\u003c/p\u003e" }, "roleArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStatusEnumValue", "description": "\u003cp\u003eThe current status of the cluster.\u003c/p\u003e" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eMetadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.\u003c/p\u003e" }, "version": { "type": "string", "description": "\u003cp\u003eThe Kubernetes server version for the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEksClusterPropertiesResponse": { "description": "Definition of awsEksCluster", "properties": { "accessConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessConfigResponseResponse", "description": "\u003cp\u003eThe access configuration for the cluster.\u003c/p\u003e" }, "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the cluster.\u003c/p\u003e" }, "certificateAuthority": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateResponse", "description": "\u003cp\u003eThe \u003ccode\u003ecertificate-authority-data\u003c/code\u003e for your cluster.\u003c/p\u003e" }, "clientRequestToken": { "type": "string", "description": "\u003cp\u003eA unique, case-sensitive identifier that you provide to ensure the idempotency of the request.\u003c/p\u003e" }, "connectorConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConnectorConfigResponseResponse", "description": "\u003cp\u003eThe configuration used to connect to a cluster for registration.\u003c/p\u003e" }, "createdAt": { "type": "string", "description": "\u003cp\u003eThe Unix epoch timestamp at object creation.\u003c/p\u003e" }, "encryptionConfig": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionConfigResponse" }, "description": "\u003cp\u003eThe encryption configuration for the cluster.\u003c/p\u003e" }, "endpoint": { "type": "string", "description": "\u003cp\u003eThe endpoint for your Kubernetes API server.\u003c/p\u003e" }, "health": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterHealthResponse", "description": "\u003cp\u003eAn object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.\u003c/p\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.\u003c/p\u003e" }, "identity": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IdentityResponse", "description": "\u003cp\u003eThe identity provider information for the cluster.\u003c/p\u003e" }, "kubernetesNetworkConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KubernetesNetworkConfigResponseResponse", "description": "\u003cp\u003eThe Kubernetes network configuration for the cluster.\u003c/p\u003e" }, "logging": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingResponseV1", "description": "\u003cp\u003eThe logging configuration for your cluster.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of your cluster.\u003c/p\u003e" }, "outpostConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OutpostConfigResponseResponse", "description": "\u003cp\u003eAn object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.\u003c/p\u003e" }, "platformVersion": { "type": "string", "description": "\u003cp\u003eThe platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html'\u003ePlatform versions\u003c/a\u003e in the \u003ci\u003e \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e \u003c/i\u003e. For more information about local clusters deployed on an Outpost, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html'\u003eAmazon EKS local cluster platform versions\u003c/a\u003e in the \u003ci\u003e \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e \u003c/i\u003e.\u003c/p\u003e" }, "resourcesVpcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfigResponseResponse", "description": "\u003cp\u003eThe VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html'\u003eCluster VPC considerations\u003c/a\u003e and \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html'\u003eCluster security group considerations\u003c/a\u003e in the \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e.\u003c/p\u003e" }, "roleArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStatusEnumValueResponse", "description": "\u003cp\u003eThe current status of the cluster.\u003c/p\u003e" }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eMetadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.\u003c/p\u003e" }, "version": { "type": "string", "description": "\u003cp\u003eThe Kubernetes server version for the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEksNodegroupProperties": { "description": "Definition of awsEksNodegroup", "properties": { "amiType": { "type": "string", "description": "The AMI type for your node group." }, "arn": { "type": "string", "description": "Property arn" }, "capacityType": { "type": "string", "description": "The capacity type of your managed node group." }, "clusterName": { "type": "string", "description": "Name of the cluster to create the node group in." }, "diskSize": { "type": "integer", "description": "The root device disk size (in GiB) for your node group instances." }, "forceUpdateEnabled": { "type": "boolean", "description": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue." }, "id": { "type": "string", "description": "Property id" }, "instanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Specify the instance types for a node group." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The Kubernetes labels to be applied to the nodes in the node group when they are created." }, "launchTemplate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecification", "description": "An object representing a node group's launch template specification. An object representing a launch template specification for AWS EKS Nodegroup." }, "nodeRole": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role to associate with your node group." }, "nodegroupName": { "type": "string", "description": "The unique name to give your node group." }, "releaseVersion": { "type": "string", "description": "The AMI version of the Amazon EKS-optimized AMI to use with your node group." }, "remoteAccess": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RemoteAccess", "description": "The remote access (SSH) configuration to use with your node group. An object representing a remote access configuration specification for AWS EKS Nodegroup." }, "scalingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScalingConfig", "description": "The scaling configuration details for the Auto Scaling group that is created for your node group. An object representing a auto scaling group specification for AWS EKS Nodegroup." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The subnets to use for the Auto Scaling group that is created for your node group." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency." }, "taints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Taint" }, "description": "The Kubernetes taints to be applied to the nodes in the node group when they are created." }, "updateConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UpdateConfig", "description": "The node group update configuration. The node group update configuration." }, "version": { "type": "string", "description": "The Kubernetes version to use for your managed nodes." } }, "type": "object" }, "azure-native:awsconnector:AwsEksNodegroupPropertiesResponse": { "description": "Definition of awsEksNodegroup", "properties": { "amiType": { "type": "string", "description": "The AMI type for your node group." }, "arn": { "type": "string", "description": "Property arn" }, "capacityType": { "type": "string", "description": "The capacity type of your managed node group." }, "clusterName": { "type": "string", "description": "Name of the cluster to create the node group in." }, "diskSize": { "type": "integer", "description": "The root device disk size (in GiB) for your node group instances." }, "forceUpdateEnabled": { "type": "boolean", "description": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue." }, "id": { "type": "string", "description": "Property id" }, "instanceTypes": { "type": "array", "items": { "type": "string" }, "description": "Specify the instance types for a node group." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The Kubernetes labels to be applied to the nodes in the node group when they are created." }, "launchTemplate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecificationResponseV1", "description": "An object representing a node group's launch template specification. An object representing a launch template specification for AWS EKS Nodegroup." }, "nodeRole": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role to associate with your node group." }, "nodegroupName": { "type": "string", "description": "The unique name to give your node group." }, "releaseVersion": { "type": "string", "description": "The AMI version of the Amazon EKS-optimized AMI to use with your node group." }, "remoteAccess": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RemoteAccessResponse", "description": "The remote access (SSH) configuration to use with your node group. An object representing a remote access configuration specification for AWS EKS Nodegroup." }, "scalingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScalingConfigResponse", "description": "The scaling configuration details for the Auto Scaling group that is created for your node group. An object representing a auto scaling group specification for AWS EKS Nodegroup." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The subnets to use for the Auto Scaling group that is created for your node group." }, "tags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency." }, "taints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TaintResponse" }, "description": "The Kubernetes taints to be applied to the nodes in the node group when they are created." }, "updateConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UpdateConfigResponse", "description": "The node group update configuration. The node group update configuration." }, "version": { "type": "string", "description": "The Kubernetes version to use for your managed nodes." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticBeanstalkApplicationProperties": { "description": "Definition of awsElasticBeanstalkApplication", "properties": { "applicationName": { "type": "string", "description": "A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name." }, "description": { "type": "string", "description": "Your description of the application." }, "resourceLifecycleConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ApplicationResourceLifecycleConfig", "description": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticBeanstalkApplicationPropertiesResponse": { "description": "Definition of awsElasticBeanstalkApplication", "properties": { "applicationName": { "type": "string", "description": "A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name." }, "description": { "type": "string", "description": "Your description of the application." }, "resourceLifecycleConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ApplicationResourceLifecycleConfigResponse", "description": "Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticBeanstalkConfigurationTemplateProperties": { "description": "Definition of awsElasticBeanstalkConfigurationTemplate", "properties": { "applicationName": { "type": "string", "description": "The name of the Elastic Beanstalk application to associate with this configuration template." }, "description": { "type": "string", "description": "An optional description for this configuration." }, "environmentId": { "type": "string", "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration." }, "optionSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigurationOptionSetting" }, "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide." }, "platformArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide." }, "solutionStackName": { "type": "string", "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks." }, "sourceConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceConfiguration", "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in OptionSettings override any values obtained from the SourceConfiguration.You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name." }, "templateName": { "type": "string", "description": "The name of the configuration template" } }, "type": "object" }, "azure-native:awsconnector:AwsElasticBeanstalkConfigurationTemplatePropertiesResponse": { "description": "Definition of awsElasticBeanstalkConfigurationTemplate", "properties": { "applicationName": { "type": "string", "description": "The name of the Elastic Beanstalk application to associate with this configuration template." }, "description": { "type": "string", "description": "An optional description for this configuration." }, "environmentId": { "type": "string", "description": "The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration." }, "optionSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigurationOptionSettingResponse" }, "description": "Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide." }, "platformArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide." }, "solutionStackName": { "type": "string", "description": "The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks." }, "sourceConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceConfigurationResponse", "description": "An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in OptionSettings override any values obtained from the SourceConfiguration.You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name." }, "templateName": { "type": "string", "description": "The name of the configuration template" } }, "type": "object" }, "azure-native:awsconnector:AwsElasticBeanstalkEnvironmentProperties": { "description": "Definition of awsElasticBeanstalkEnvironment", "properties": { "applicationName": { "type": "string", "description": "The name of the application that is associated with this environment." }, "cnamePrefix": { "type": "string", "description": "If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name." }, "description": { "type": "string", "description": "Your description for this environment." }, "endpointURL": { "type": "string", "description": "Property endpointURL" }, "environmentName": { "type": "string", "description": "A unique name for the environment." }, "operationsRole": { "type": "string", "description": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role." }, "optionSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OptionSetting" }, "description": "Key-value pairs defining configuration options for this environment, such as the instance type." }, "platformArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the custom platform to use with the environment." }, "solutionStackName": { "type": "string", "description": "The name of an Elastic Beanstalk solution stack (platform version) to use with the environment." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Specifies the tags applied to resources in the environment." }, "templateName": { "type": "string", "description": "The name of the Elastic Beanstalk configuration template to use with the environment." }, "tier": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tier", "description": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks." }, "versionLabel": { "type": "string", "description": "The name of the application version to deploy." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticBeanstalkEnvironmentPropertiesResponse": { "description": "Definition of awsElasticBeanstalkEnvironment", "properties": { "applicationName": { "type": "string", "description": "The name of the application that is associated with this environment." }, "cnamePrefix": { "type": "string", "description": "If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name." }, "description": { "type": "string", "description": "Your description for this environment." }, "endpointURL": { "type": "string", "description": "Property endpointURL" }, "environmentName": { "type": "string", "description": "A unique name for the environment." }, "operationsRole": { "type": "string", "description": "The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role." }, "optionSettings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OptionSettingResponse" }, "description": "Key-value pairs defining configuration options for this environment, such as the instance type." }, "platformArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the custom platform to use with the environment." }, "solutionStackName": { "type": "string", "description": "The name of an Elastic Beanstalk solution stack (platform version) to use with the environment." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Specifies the tags applied to resources in the environment." }, "templateName": { "type": "string", "description": "The name of the Elastic Beanstalk configuration template to use with the environment." }, "tier": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TierResponse", "description": "Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks." }, "versionLabel": { "type": "string", "description": "The name of the application version to deploy." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingV2ListenerProperties": { "description": "Definition of awsElasticLoadBalancingV2Listener", "properties": { "alpnPolicy": { "type": "array", "items": { "type": "string" }, "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy." }, "certificates": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Certificate" }, "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html)." }, "defaultActions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Action" }, "description": "The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html)." }, "listenerArn": { "type": "string", "description": "Property listenerArn" }, "loadBalancerArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the load balancer." }, "mutualAuthentication": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MutualAuthentication", "description": "The mutual authentication configuration information. Specifies the configuration information for mutual authentication." }, "port": { "type": "integer", "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer." }, "protocol": { "type": "string", "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer." }, "sslPolicy": { "type": "string", "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingV2ListenerPropertiesResponse": { "description": "Definition of awsElasticLoadBalancingV2Listener", "properties": { "alpnPolicy": { "type": "array", "items": { "type": "string" }, "description": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy." }, "certificates": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateResponseV1" }, "description": "The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html)." }, "defaultActions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActionResponse" }, "description": "The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html)." }, "listenerArn": { "type": "string", "description": "Property listenerArn" }, "loadBalancerArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the load balancer." }, "mutualAuthentication": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MutualAuthenticationResponse", "description": "The mutual authentication configuration information. Specifies the configuration information for mutual authentication." }, "port": { "type": "integer", "description": "The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer." }, "protocol": { "type": "string", "description": "The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer." }, "sslPolicy": { "type": "string", "description": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingV2LoadBalancerProperties": { "description": "Definition of awsElasticLoadBalancingV2LoadBalancer", "properties": { "canonicalHostedZoneID": { "type": "string", "description": "Property canonicalHostedZoneID" }, "dnsName": { "type": "string", "description": "Property dnsName" }, "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "type": "string", "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink." }, "ipAddressType": { "type": "string", "description": "The IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener." }, "loadBalancerArn": { "type": "string", "description": "Property loadBalancerArn" }, "loadBalancerAttributes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoadBalancerAttribute" }, "description": "The load balancer attributes." }, "loadBalancerFullName": { "type": "string", "description": "Property loadBalancerFullName" }, "loadBalancerName": { "type": "string", "description": "Property loadBalancerName" }, "name": { "type": "string", "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name." }, "scheme": { "type": "string", "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer." }, "subnetMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SubnetMapping" }, "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags to assign to the load balancer." }, "type": { "type": "string", "description": "The type of load balancer. The default is ``application``." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingV2LoadBalancerPropertiesResponse": { "description": "Definition of awsElasticLoadBalancingV2LoadBalancer", "properties": { "canonicalHostedZoneID": { "type": "string", "description": "Property canonicalHostedZoneID" }, "dnsName": { "type": "string", "description": "Property dnsName" }, "enforceSecurityGroupInboundRulesOnPrivateLinkTraffic": { "type": "string", "description": "Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink." }, "ipAddressType": { "type": "string", "description": "The IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener." }, "loadBalancerArn": { "type": "string", "description": "Property loadBalancerArn" }, "loadBalancerAttributes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoadBalancerAttributeResponse" }, "description": "The load balancer attributes." }, "loadBalancerFullName": { "type": "string", "description": "Property loadBalancerFullName" }, "loadBalancerName": { "type": "string", "description": "Property loadBalancerName" }, "name": { "type": "string", "description": "The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name." }, "scheme": { "type": "string", "description": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "[Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer." }, "subnetMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SubnetMappingResponse" }, "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags to assign to the load balancer." }, "type": { "type": "string", "description": "The type of load balancer. The default is ``application``." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingV2TargetGroupProperties": { "description": "Definition of awsElasticLoadBalancingV2TargetGroup", "properties": { "healthCheckEnabled": { "type": "boolean", "description": "Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled." }, "healthCheckIntervalSeconds": { "type": "integer", "description": "The approximate amount of time, in seconds, between health checks of an individual target." }, "healthCheckPath": { "type": "string", "description": "[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck." }, "healthCheckPort": { "type": "string", "description": "The port the load balancer uses when performing health checks on targets." }, "healthCheckProtocol": { "type": "string", "description": "The protocol the load balancer uses when performing health checks on targets." }, "healthCheckTimeoutSeconds": { "type": "integer", "description": "The amount of time, in seconds, during which no response from a target means a failed health check." }, "healthyThresholdCount": { "type": "integer", "description": "The number of consecutive health checks successes required before considering an unhealthy target healthy." }, "ipAddressType": { "type": "string", "description": "The type of IP address used for this target group. The possible values are ipv4 and ipv6." }, "loadBalancerArns": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group." }, "matcher": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Matcher", "description": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target." }, "name": { "type": "string", "description": "The name of the target group." }, "port": { "type": "integer", "description": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081." }, "protocol": { "type": "string", "description": "The protocol to use for routing traffic to the targets." }, "protocolVersion": { "type": "string", "description": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags." }, "targetGroupArn": { "type": "string", "description": "The ARN of the Target Group" }, "targetGroupAttributes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetGroupAttribute" }, "description": "The attributes." }, "targetGroupFullName": { "type": "string", "description": "The full name of the target group." }, "targetGroupName": { "type": "string", "description": "The name of the target group." }, "targetType": { "type": "string", "description": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type." }, "targets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetDescription" }, "description": "The targets." }, "unhealthyThresholdCount": { "type": "integer", "description": "The number of consecutive health check failures required before considering a target unhealthy." }, "vpcId": { "type": "string", "description": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingV2TargetGroupPropertiesResponse": { "description": "Definition of awsElasticLoadBalancingV2TargetGroup", "properties": { "healthCheckEnabled": { "type": "boolean", "description": "Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled." }, "healthCheckIntervalSeconds": { "type": "integer", "description": "The approximate amount of time, in seconds, between health checks of an individual target." }, "healthCheckPath": { "type": "string", "description": "[HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck." }, "healthCheckPort": { "type": "string", "description": "The port the load balancer uses when performing health checks on targets." }, "healthCheckProtocol": { "type": "string", "description": "The protocol the load balancer uses when performing health checks on targets." }, "healthCheckTimeoutSeconds": { "type": "integer", "description": "The amount of time, in seconds, during which no response from a target means a failed health check." }, "healthyThresholdCount": { "type": "integer", "description": "The number of consecutive health checks successes required before considering an unhealthy target healthy." }, "ipAddressType": { "type": "string", "description": "The type of IP address used for this target group. The possible values are ipv4 and ipv6." }, "loadBalancerArns": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group." }, "matcher": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MatcherResponse", "description": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target." }, "name": { "type": "string", "description": "The name of the target group." }, "port": { "type": "integer", "description": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081." }, "protocol": { "type": "string", "description": "The protocol to use for routing traffic to the targets." }, "protocolVersion": { "type": "string", "description": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags." }, "targetGroupArn": { "type": "string", "description": "The ARN of the Target Group" }, "targetGroupAttributes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetGroupAttributeResponse" }, "description": "The attributes." }, "targetGroupFullName": { "type": "string", "description": "The full name of the target group." }, "targetGroupName": { "type": "string", "description": "The name of the target group." }, "targetType": { "type": "string", "description": "The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type." }, "targets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetDescriptionResponse" }, "description": "The targets." }, "unhealthyThresholdCount": { "type": "integer", "description": "The number of consecutive health check failures required before considering a target unhealthy." }, "vpcId": { "type": "string", "description": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply." } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingv2TargetHealthDescriptionProperties": { "description": "Definition of awsElasticLoadBalancingv2TargetHealthDescription", "properties": { "anomalyDetection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AnomalyDetection", "description": "\u003cp\u003eThe anomaly detection result for the target.\u003c/p\u003e \u003cp\u003eIf no anomalies were detected, the result is \u003ccode\u003enormal\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eIf anomalies were detected, the result is \u003ccode\u003eanomalous\u003c/code\u003e.\u003c/p\u003e" }, "healthCheckPort": { "type": "string", "description": "\u003cp\u003eThe port to use to connect with the target.\u003c/p\u003e" }, "target": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetDescription", "description": "\u003cp\u003eThe description of the target.\u003c/p\u003e" }, "targetHealth": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetHealth", "description": "\u003cp\u003eThe health information for the target.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsElasticLoadBalancingv2TargetHealthDescriptionPropertiesResponse": { "description": "Definition of awsElasticLoadBalancingv2TargetHealthDescription", "properties": { "anomalyDetection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AnomalyDetectionResponse", "description": "\u003cp\u003eThe anomaly detection result for the target.\u003c/p\u003e \u003cp\u003eIf no anomalies were detected, the result is \u003ccode\u003enormal\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eIf anomalies were detected, the result is \u003ccode\u003eanomalous\u003c/code\u003e.\u003c/p\u003e" }, "healthCheckPort": { "type": "string", "description": "\u003cp\u003eThe port to use to connect with the target.\u003c/p\u003e" }, "target": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetDescriptionResponse", "description": "\u003cp\u003eThe description of the target.\u003c/p\u003e" }, "targetHealth": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetHealthResponse", "description": "\u003cp\u003eThe health information for the target.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEmrClusterProperties": { "description": "Definition of awsEmrCluster", "properties": { "applications": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Application" }, "description": "\u003cp\u003eThe applications installed on this cluster.\u003c/p\u003e" }, "autoScalingRole": { "type": "string", "description": "\u003cp\u003eAn IAM role for automatic scaling policies. The default role is \u003ccode\u003eEMR_AutoScaling_DefaultRole\u003c/code\u003e. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.\u003c/p\u003e" }, "autoTerminate": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether the cluster should terminate after completing all steps.\u003c/p\u003e" }, "clusterArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name of the cluster.\u003c/p\u003e" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Configuration" }, "description": "\u003cp\u003eApplies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.\u003c/p\u003e" }, "customAmiId": { "type": "string", "description": "\u003cp\u003eAvailable only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.\u003c/p\u003e" }, "ebsRootVolumeIops": { "type": "integer", "description": "\u003cp\u003eThe IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.\u003c/p\u003e" }, "ebsRootVolumeSize": { "type": "integer", "description": "\u003cp\u003eThe size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.\u003c/p\u003e" }, "ebsRootVolumeThroughput": { "type": "integer", "description": "\u003cp\u003eThe throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.\u003c/p\u003e" }, "ec2InstanceAttributes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ec2InstanceAttributes", "description": "\u003cp\u003eProvides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.\u003c/p\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe unique identifier for the cluster.\u003c/p\u003e" }, "instanceCollectionType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceCollectionTypeEnumValue", "description": "\u003cnote\u003e \u003cp\u003eThe instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eThe instance group configuration of the cluster. A value of \u003ccode\u003eINSTANCE_GROUP\u003c/code\u003e indicates a uniform instance group configuration. A value of \u003ccode\u003eINSTANCE_FLEET\u003c/code\u003e indicates an instance fleets configuration.\u003c/p\u003e" }, "kerberosAttributes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KerberosAttributes", "description": "\u003cp\u003eAttributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see \u003ca href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html'\u003eUse Kerberos Authentication\u003c/a\u003e in the \u003ci\u003eAmazon EMR Management Guide\u003c/i\u003e.\u003c/p\u003e" }, "logEncryptionKmsKeyId": { "type": "string", "description": "\u003cp\u003e The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0. \u003c/p\u003e" }, "logUri": { "type": "string", "description": "\u003cp\u003eThe path to the Amazon S3 location where logs for this cluster are stored.\u003c/p\u003e" }, "masterPublicDnsName": { "type": "string", "description": "\u003cp\u003eThe DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the cluster. This parameter can't contain the characters \u0026lt;, \u0026gt;, $, |, or ` (backtick).\u003c/p\u003e" }, "normalizedInstanceHours": { "type": "integer", "description": "\u003cp\u003eAn approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.\u003c/p\u003e" }, "osReleaseLabel": { "type": "string", "description": "\u003cp\u003eThe Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. \u003c/p\u003e" }, "placementGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementGroupConfig" }, "description": "\u003cp\u003ePlacement group configured for an Amazon EMR cluster.\u003c/p\u003e" }, "releaseLabel": { "type": "string", "description": "\u003cp\u003eThe Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form \u003ccode\u003eemr-x.x.x\u003c/code\u003e, where x.x.x is an Amazon EMR release version such as \u003ccode\u003eemr-5.14.0\u003c/code\u003e. For more information about Amazon EMR release versions and included application versions and features, see \u003ca href='https://docs.aws.amazon.com/emr/latest/ReleaseGuide/'\u003ehttps://docs.aws.amazon.com/emr/latest/ReleaseGuide/\u003c/a\u003e. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use \u003ccode\u003eAmiVersion\u003c/code\u003e.\u003c/p\u003e" }, "repoUpgradeOnBoot": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RepoUpgradeOnBootEnumValue", "description": "\u003cp\u003eApplies only when \u003ccode\u003eCustomAmiID\u003c/code\u003e is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.\u003c/p\u003e" }, "requestedAmiVersion": { "type": "string", "description": "\u003cp\u003eThe AMI version requested for this cluster.\u003c/p\u003e" }, "runningAmiVersion": { "type": "string", "description": "\u003cp\u003eThe AMI version running on this cluster.\u003c/p\u003e" }, "scaleDownBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScaleDownBehaviorEnumValue", "description": "\u003cp\u003eThe way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. \u003ccode\u003eTERMINATE_AT_INSTANCE_HOUR\u003c/code\u003e indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. \u003ccode\u003eTERMINATE_AT_TASK_COMPLETION\u003c/code\u003e indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. \u003ccode\u003eTERMINATE_AT_TASK_COMPLETION\u003c/code\u003e is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.\u003c/p\u003e" }, "securityConfiguration": { "type": "string", "description": "\u003cp\u003eThe name of the security configuration applied to the cluster.\u003c/p\u003e" }, "serviceRole": { "type": "string", "description": "\u003cp\u003eThe IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EmrClusterStatus", "description": "\u003cp\u003eThe current status details about the cluster.\u003c/p\u003e" }, "stepConcurrencyLevel": { "type": "integer", "description": "\u003cp\u003eSpecifies the number of steps that can be executed concurrently.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "\u003cp\u003eA list of tags associated with a cluster.\u003c/p\u003e" }, "terminationProtected": { "type": "boolean", "description": "\u003cp\u003eIndicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.\u003c/p\u003e" }, "unhealthyNodeReplacement": { "type": "boolean", "description": "\u003cp\u003eIndicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.\u003c/p\u003e" }, "visibleToAllUsers": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When \u003ccode\u003etrue\u003c/code\u003e, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When \u003ccode\u003efalse\u003c/code\u003e, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.\u003c/p\u003e \u003cp\u003eThe default value is \u003ccode\u003etrue\u003c/code\u003e if a value is not provided when creating a cluster using the Amazon EMR API \u003ca\u003eRunJobFlow\u003c/a\u003e command, the CLI \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html'\u003ecreate-cluster\u003c/a\u003e command, or the Amazon Web Services Management Console.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsEmrClusterPropertiesResponse": { "description": "Definition of awsEmrCluster", "properties": { "applications": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ApplicationResponse" }, "description": "\u003cp\u003eThe applications installed on this cluster.\u003c/p\u003e" }, "autoScalingRole": { "type": "string", "description": "\u003cp\u003eAn IAM role for automatic scaling policies. The default role is \u003ccode\u003eEMR_AutoScaling_DefaultRole\u003c/code\u003e. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.\u003c/p\u003e" }, "autoTerminate": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether the cluster should terminate after completing all steps.\u003c/p\u003e" }, "clusterArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name of the cluster.\u003c/p\u003e" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigurationResponse" }, "description": "\u003cp\u003eApplies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.\u003c/p\u003e" }, "customAmiId": { "type": "string", "description": "\u003cp\u003eAvailable only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.\u003c/p\u003e" }, "ebsRootVolumeIops": { "type": "integer", "description": "\u003cp\u003eThe IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.\u003c/p\u003e" }, "ebsRootVolumeSize": { "type": "integer", "description": "\u003cp\u003eThe size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.\u003c/p\u003e" }, "ebsRootVolumeThroughput": { "type": "integer", "description": "\u003cp\u003eThe throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.\u003c/p\u003e" }, "ec2InstanceAttributes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ec2InstanceAttributesResponse", "description": "\u003cp\u003eProvides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.\u003c/p\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe unique identifier for the cluster.\u003c/p\u003e" }, "instanceCollectionType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceCollectionTypeEnumValueResponse", "description": "\u003cnote\u003e \u003cp\u003eThe instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eThe instance group configuration of the cluster. A value of \u003ccode\u003eINSTANCE_GROUP\u003c/code\u003e indicates a uniform instance group configuration. A value of \u003ccode\u003eINSTANCE_FLEET\u003c/code\u003e indicates an instance fleets configuration.\u003c/p\u003e" }, "kerberosAttributes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KerberosAttributesResponse", "description": "\u003cp\u003eAttributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see \u003ca href='https://docs.aws.amazon.com/emr/latest/ManagementGuide/emr-kerberos.html'\u003eUse Kerberos Authentication\u003c/a\u003e in the \u003ci\u003eAmazon EMR Management Guide\u003c/i\u003e.\u003c/p\u003e" }, "logEncryptionKmsKeyId": { "type": "string", "description": "\u003cp\u003e The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0. \u003c/p\u003e" }, "logUri": { "type": "string", "description": "\u003cp\u003eThe path to the Amazon S3 location where logs for this cluster are stored.\u003c/p\u003e" }, "masterPublicDnsName": { "type": "string", "description": "\u003cp\u003eThe DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the cluster. This parameter can't contain the characters \u0026lt;, \u0026gt;, $, |, or ` (backtick).\u003c/p\u003e" }, "normalizedInstanceHours": { "type": "integer", "description": "\u003cp\u003eAn approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.\u003c/p\u003e" }, "osReleaseLabel": { "type": "string", "description": "\u003cp\u003eThe Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) of the Outpost where the cluster is launched. \u003c/p\u003e" }, "placementGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementGroupConfigResponse" }, "description": "\u003cp\u003ePlacement group configured for an Amazon EMR cluster.\u003c/p\u003e" }, "releaseLabel": { "type": "string", "description": "\u003cp\u003eThe Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form \u003ccode\u003eemr-x.x.x\u003c/code\u003e, where x.x.x is an Amazon EMR release version such as \u003ccode\u003eemr-5.14.0\u003c/code\u003e. For more information about Amazon EMR release versions and included application versions and features, see \u003ca href='https://docs.aws.amazon.com/emr/latest/ReleaseGuide/'\u003ehttps://docs.aws.amazon.com/emr/latest/ReleaseGuide/\u003c/a\u003e. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use \u003ccode\u003eAmiVersion\u003c/code\u003e.\u003c/p\u003e" }, "repoUpgradeOnBoot": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RepoUpgradeOnBootEnumValueResponse", "description": "\u003cp\u003eApplies only when \u003ccode\u003eCustomAmiID\u003c/code\u003e is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.\u003c/p\u003e" }, "requestedAmiVersion": { "type": "string", "description": "\u003cp\u003eThe AMI version requested for this cluster.\u003c/p\u003e" }, "runningAmiVersion": { "type": "string", "description": "\u003cp\u003eThe AMI version running on this cluster.\u003c/p\u003e" }, "scaleDownBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScaleDownBehaviorEnumValueResponse", "description": "\u003cp\u003eThe way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. \u003ccode\u003eTERMINATE_AT_INSTANCE_HOUR\u003c/code\u003e indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. \u003ccode\u003eTERMINATE_AT_TASK_COMPLETION\u003c/code\u003e indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. \u003ccode\u003eTERMINATE_AT_TASK_COMPLETION\u003c/code\u003e is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.\u003c/p\u003e" }, "securityConfiguration": { "type": "string", "description": "\u003cp\u003eThe name of the security configuration applied to the cluster.\u003c/p\u003e" }, "serviceRole": { "type": "string", "description": "\u003cp\u003eThe IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EmrClusterStatusResponse", "description": "\u003cp\u003eThe current status details about the cluster.\u003c/p\u003e" }, "stepConcurrencyLevel": { "type": "integer", "description": "\u003cp\u003eSpecifies the number of steps that can be executed concurrently.\u003c/p\u003e" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "\u003cp\u003eA list of tags associated with a cluster.\u003c/p\u003e" }, "terminationProtected": { "type": "boolean", "description": "\u003cp\u003eIndicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.\u003c/p\u003e" }, "unhealthyNodeReplacement": { "type": "boolean", "description": "\u003cp\u003eIndicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.\u003c/p\u003e" }, "visibleToAllUsers": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When \u003ccode\u003etrue\u003c/code\u003e, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When \u003ccode\u003efalse\u003c/code\u003e, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.\u003c/p\u003e \u003cp\u003eThe default value is \u003ccode\u003etrue\u003c/code\u003e if a value is not provided when creating a cluster using the Amazon EMR API \u003ca\u003eRunJobFlow\u003c/a\u003e command, the CLI \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/emr/create-cluster.html'\u003ecreate-cluster\u003c/a\u003e command, or the Amazon Web Services Management Console.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsGuardDutyDetectorProperties": { "description": "Definition of awsGuardDutyDetector", "properties": { "dataSources": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNDataSourceConfigurations", "description": "Property dataSources" }, "enable": { "type": "boolean", "description": "Property enable" }, "features": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNFeatureConfiguration" }, "description": "Property features" }, "findingPublishingFrequency": { "type": "string", "description": "Property findingPublishingFrequency" }, "id": { "type": "string", "description": "Property id" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagItem" }, "description": "Property tags" } }, "type": "object" }, "azure-native:awsconnector:AwsGuardDutyDetectorPropertiesResponse": { "description": "Definition of awsGuardDutyDetector", "properties": { "dataSources": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNDataSourceConfigurationsResponse", "description": "Property dataSources" }, "enable": { "type": "boolean", "description": "Property enable" }, "features": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNFeatureConfigurationResponse" }, "description": "Property features" }, "findingPublishingFrequency": { "type": "string", "description": "Property findingPublishingFrequency" }, "id": { "type": "string", "description": "Property id" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagItemResponse" }, "description": "Property tags" } }, "type": "object" }, "azure-native:awsconnector:AwsIamAccessKeyLastUsedProperties": { "description": "Definition of awsIamAccessKeyLastUsed", "properties": { "lastUsedDate": { "type": "string", "description": "\u003cp\u003eThe date and time, in \u003ca href='http://www.iso.org/iso/iso8601'\u003eISO 8601 date-time format\u003c/a\u003e, when the access key was most recently used. This field is null in the following situations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe user does not have an access key.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAn access key exists but has not been used since IAM began tracking this information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThere is no sign-in data associated with the user.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "region": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region where this access key was most recently used. The value for this field is 'N/A' in the following situations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe user does not have an access key.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAn access key exists but has not been used since IAM began tracking this information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThere is no sign-in data associated with the user.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor more information about Amazon Web Services Regions, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/rande.html'\u003eRegions and endpoints\u003c/a\u003e in the Amazon Web Services General Reference.\u003c/p\u003e" }, "serviceName": { "type": "string", "description": "\u003cp\u003eThe name of the Amazon Web Services service with which this access key was most recently used. The value of this field is 'N/A' in the following situations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe user does not have an access key.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAn access key exists but has not been used since IAM started tracking this information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThere is no sign-in data associated with the user.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamAccessKeyLastUsedPropertiesResponse": { "description": "Definition of awsIamAccessKeyLastUsed", "properties": { "lastUsedDate": { "type": "string", "description": "\u003cp\u003eThe date and time, in \u003ca href='http://www.iso.org/iso/iso8601'\u003eISO 8601 date-time format\u003c/a\u003e, when the access key was most recently used. This field is null in the following situations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe user does not have an access key.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAn access key exists but has not been used since IAM began tracking this information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThere is no sign-in data associated with the user.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "region": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region where this access key was most recently used. The value for this field is 'N/A' in the following situations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe user does not have an access key.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAn access key exists but has not been used since IAM began tracking this information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThere is no sign-in data associated with the user.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor more information about Amazon Web Services Regions, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/rande.html'\u003eRegions and endpoints\u003c/a\u003e in the Amazon Web Services General Reference.\u003c/p\u003e" }, "serviceName": { "type": "string", "description": "\u003cp\u003eThe name of the Amazon Web Services service with which this access key was most recently used. The value of this field is 'N/A' in the following situations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe user does not have an access key.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAn access key exists but has not been used since IAM started tracking this information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThere is no sign-in data associated with the user.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamAccessKeyMetadataProperties": { "description": "Definition of awsIamAccessKeyMetadata", "properties": { "accessKeyId": { "type": "string", "description": "\u003cp\u003eThe ID for this access key.\u003c/p\u003e" }, "createDate": { "type": "string", "description": "\u003cp\u003eThe date when the access key was created.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusTypeEnumValue", "description": "\u003cp\u003eThe status of the access key. \u003ccode\u003eActive\u003c/code\u003e means that the key is valid for API calls; \u003ccode\u003eInactive\u003c/code\u003e means it is not.\u003c/p\u003e" }, "userName": { "type": "string", "description": "\u003cp\u003eThe name of the IAM user that the key is associated with.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamAccessKeyMetadataPropertiesResponse": { "description": "Definition of awsIamAccessKeyMetadata", "properties": { "accessKeyId": { "type": "string", "description": "\u003cp\u003eThe ID for this access key.\u003c/p\u003e" }, "createDate": { "type": "string", "description": "\u003cp\u003eThe date when the access key was created.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusTypeEnumValueResponse", "description": "\u003cp\u003eThe status of the access key. \u003ccode\u003eActive\u003c/code\u003e means that the key is valid for API calls; \u003ccode\u003eInactive\u003c/code\u003e means it is not.\u003c/p\u003e" }, "userName": { "type": "string", "description": "\u003cp\u003eThe name of the IAM user that the key is associated with.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamGroupProperties": { "description": "Definition of awsIamGroup", "properties": { "arn": { "type": "string", "description": "Property arn" }, "groupName": { "type": "string", "description": "The name of the group to create. Do not include the path in this value. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both 'ADMINS' and 'admins'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{'Fn::Join': ['', [{'Ref': 'AWS::Region'}, {'Ref': 'MyResourceName'}]]}``." }, "managedPolicyArns": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." }, "path": { "type": "string", "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." }, "policies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Policy" }, "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsIamGroupPropertiesResponse": { "description": "Definition of awsIamGroup", "properties": { "arn": { "type": "string", "description": "Property arn" }, "groupName": { "type": "string", "description": "The name of the group to create. Do not include the path in this value. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both 'ADMINS' and 'admins'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{'Fn::Join': ['', [{'Ref': 'AWS::Region'}, {'Ref': 'MyResourceName'}]]}``." }, "managedPolicyArns": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." }, "path": { "type": "string", "description": "The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." }, "policies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PolicyResponse" }, "description": "Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsIamInstanceProfileProperties": { "description": "Definition of awsIamInstanceProfile", "properties": { "arn": { "type": "string", "description": "Property arn" }, "instanceProfileName": { "type": "string", "description": "The name of the instance profile to create. This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" }, "path": { "type": "string", "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions." } }, "type": "object" }, "azure-native:awsconnector:AwsIamInstanceProfilePropertiesResponse": { "description": "Definition of awsIamInstanceProfile", "properties": { "arn": { "type": "string", "description": "Property arn" }, "instanceProfileName": { "type": "string", "description": "The name of the instance profile to create. This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-" }, "path": { "type": "string", "description": "The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions." } }, "type": "object" }, "azure-native:awsconnector:AwsIamMFADeviceProperties": { "description": "Definition of awsIamMFADevice", "properties": { "enableDate": { "type": "string", "description": "\u003cp\u003eThe date when the MFA device was enabled for the user.\u003c/p\u003e" }, "serialNumber": { "type": "string", "description": "\u003cp\u003eThe serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.\u003c/p\u003e" }, "userName": { "type": "string", "description": "\u003cp\u003eThe user with whom the MFA device is associated.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamMFADevicePropertiesResponse": { "description": "Definition of awsIamMFADevice", "properties": { "enableDate": { "type": "string", "description": "\u003cp\u003eThe date when the MFA device was enabled for the user.\u003c/p\u003e" }, "serialNumber": { "type": "string", "description": "\u003cp\u003eThe serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.\u003c/p\u003e" }, "userName": { "type": "string", "description": "\u003cp\u003eThe user with whom the MFA device is associated.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamPasswordPolicyProperties": { "description": "Definition of awsIamPasswordPolicy", "properties": { "allowUsersToChangePassword": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM users are allowed to change their own password. Gives IAM users permissions to \u003ccode\u003eiam:ChangePassword\u003c/code\u003e for only their user and to the \u003ccode\u003eiam:GetAccountPasswordPolicy\u003c/code\u003e action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.\u003c/p\u003e" }, "expirePasswords": { "type": "boolean", "description": "\u003cp\u003eIndicates whether passwords in the account expire. Returns true if \u003ccode\u003eMaxPasswordAge\u003c/code\u003e contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.\u003c/p\u003e" }, "hardExpiry": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with \u003ccode\u003eiam:ChangePassword\u003c/code\u003e permission and active access keys can reset their own expired console password using the CLI or API.\u003c/p\u003e" }, "maxPasswordAge": { "type": "integer", "description": "\u003cp\u003eThe number of days that an IAM user password is valid.\u003c/p\u003e" }, "minimumPasswordLength": { "type": "integer", "description": "\u003cp\u003eMinimum length to require for IAM user passwords.\u003c/p\u003e" }, "passwordReusePrevention": { "type": "integer", "description": "\u003cp\u003eSpecifies the number of previous passwords that IAM users are prevented from reusing.\u003c/p\u003e" }, "requireLowercaseCharacters": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one lowercase character (a to z).\u003c/p\u003e" }, "requireNumbers": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one numeric character (0 to 9).\u003c/p\u003e" }, "requireSymbols": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one of the following symbols:\u003c/p\u003e \u003cp\u003e! @ # $ % ^ \u0026amp; * ( ) _ + - = [ ] { } | '\u003c/p\u003e" }, "requireUppercaseCharacters": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one uppercase character (A to Z).\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamPasswordPolicyPropertiesResponse": { "description": "Definition of awsIamPasswordPolicy", "properties": { "allowUsersToChangePassword": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM users are allowed to change their own password. Gives IAM users permissions to \u003ccode\u003eiam:ChangePassword\u003c/code\u003e for only their user and to the \u003ccode\u003eiam:GetAccountPasswordPolicy\u003c/code\u003e action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.\u003c/p\u003e" }, "expirePasswords": { "type": "boolean", "description": "\u003cp\u003eIndicates whether passwords in the account expire. Returns true if \u003ccode\u003eMaxPasswordAge\u003c/code\u003e contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.\u003c/p\u003e" }, "hardExpiry": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with \u003ccode\u003eiam:ChangePassword\u003c/code\u003e permission and active access keys can reset their own expired console password using the CLI or API.\u003c/p\u003e" }, "maxPasswordAge": { "type": "integer", "description": "\u003cp\u003eThe number of days that an IAM user password is valid.\u003c/p\u003e" }, "minimumPasswordLength": { "type": "integer", "description": "\u003cp\u003eMinimum length to require for IAM user passwords.\u003c/p\u003e" }, "passwordReusePrevention": { "type": "integer", "description": "\u003cp\u003eSpecifies the number of previous passwords that IAM users are prevented from reusing.\u003c/p\u003e" }, "requireLowercaseCharacters": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one lowercase character (a to z).\u003c/p\u003e" }, "requireNumbers": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one numeric character (0 to 9).\u003c/p\u003e" }, "requireSymbols": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one of the following symbols:\u003c/p\u003e \u003cp\u003e! @ # $ % ^ \u0026amp; * ( ) _ + - = [ ] { } | '\u003c/p\u003e" }, "requireUppercaseCharacters": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether IAM user passwords must contain at least one uppercase character (A to Z).\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamPolicyVersionProperties": { "description": "Definition of awsIamPolicyVersion", "properties": { "createDate": { "type": "string", "description": "\u003cp\u003eThe date and time, in \u003ca href='http://www.iso.org/iso/iso8601'\u003eISO 8601 date-time format\u003c/a\u003e, when the policy version was created.\u003c/p\u003e" }, "document": { "type": "string", "description": "\u003cp\u003eThe policy document.\u003c/p\u003e \u003cp\u003eThe policy document is returned in the response to the \u003ca\u003eGetPolicyVersion\u003c/a\u003e and \u003ca\u003eGetAccountAuthorizationDetails\u003c/a\u003e operations. It is not returned in the response to the \u003ca\u003eCreatePolicyVersion\u003c/a\u003e or \u003ca\u003eListPolicyVersions\u003c/a\u003e operations. \u003c/p\u003e \u003cp\u003eThe policy document returned in this structure is URL-encoded compliant with \u003ca href='https://tools.ietf.org/html/rfc3986'\u003eRFC 3986\u003c/a\u003e. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the \u003ccode\u003edecode\u003c/code\u003e method of the \u003ccode\u003ejava.net.URLDecoder\u003c/code\u003e utility class in the Java SDK. Other languages and SDKs provide similar functionality.\u003c/p\u003e" }, "isDefaultVersion": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether the policy version is set as the policy's default version.\u003c/p\u003e" }, "versionId": { "type": "string", "description": "\u003cp\u003eThe identifier for the policy version.\u003c/p\u003e \u003cp\u003ePolicy version identifiers always begin with \u003ccode\u003ev\u003c/code\u003e (always lowercase). When a policy is created, the first policy version is \u003ccode\u003ev1\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamPolicyVersionPropertiesResponse": { "description": "Definition of awsIamPolicyVersion", "properties": { "createDate": { "type": "string", "description": "\u003cp\u003eThe date and time, in \u003ca href='http://www.iso.org/iso/iso8601'\u003eISO 8601 date-time format\u003c/a\u003e, when the policy version was created.\u003c/p\u003e" }, "document": { "type": "string", "description": "\u003cp\u003eThe policy document.\u003c/p\u003e \u003cp\u003eThe policy document is returned in the response to the \u003ca\u003eGetPolicyVersion\u003c/a\u003e and \u003ca\u003eGetAccountAuthorizationDetails\u003c/a\u003e operations. It is not returned in the response to the \u003ca\u003eCreatePolicyVersion\u003c/a\u003e or \u003ca\u003eListPolicyVersions\u003c/a\u003e operations. \u003c/p\u003e \u003cp\u003eThe policy document returned in this structure is URL-encoded compliant with \u003ca href='https://tools.ietf.org/html/rfc3986'\u003eRFC 3986\u003c/a\u003e. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the \u003ccode\u003edecode\u003c/code\u003e method of the \u003ccode\u003ejava.net.URLDecoder\u003c/code\u003e utility class in the Java SDK. Other languages and SDKs provide similar functionality.\u003c/p\u003e" }, "isDefaultVersion": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether the policy version is set as the policy's default version.\u003c/p\u003e" }, "versionId": { "type": "string", "description": "\u003cp\u003eThe identifier for the policy version.\u003c/p\u003e \u003cp\u003ePolicy version identifiers always begin with \u003ccode\u003ev\u003c/code\u003e (always lowercase). When a policy is created, the first policy version is \u003ccode\u003ev1\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsIamRoleProperties": { "description": "Definition of awsIamRole", "properties": { "arn": { "type": "string", "description": "Property arn" }, "assumeRolePolicyDocument": { "$ref": "pulumi.json#/Any", "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*." }, "description": { "type": "string", "description": "A description of the role that you provide." }, "managedPolicyArns": { "type": "array", "items": { "type": "string" }, "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." }, "maxSessionDuration": { "type": "integer", "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*." }, "path": { "type": "string", "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", "default": "/" }, "permissionsBoundary": { "type": "string", "description": "The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*." }, "policies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Policy" }, "description": "Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. If an external policy (such as ``AWS::IAM::Policy`` or" }, "roleId": { "type": "string", "description": "Property roleId" }, "roleName": { "type": "string", "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. This parameter allows (per its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both 'Role1' and 'role1'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Finding and Acknowledging Application Capabilities (Console)](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html#acknowledging-application-capabilities-console)." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsIamRolePropertiesResponse": { "description": "Definition of awsIamRole", "properties": { "arn": { "type": "string", "description": "Property arn" }, "assumeRolePolicyDocument": { "$ref": "pulumi.json#/Any", "description": "The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*." }, "description": { "type": "string", "description": "A description of the role that you provide." }, "managedPolicyArns": { "type": "array", "items": { "type": "string" }, "description": "A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*." }, "maxSessionDuration": { "type": "integer", "description": "The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*." }, "path": { "type": "string", "description": "The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\\u0021``) through the DEL character (``\\u007F``), including most punctuation characters, digits, and upper and lowercased letters.", "default": "/" }, "permissionsBoundary": { "type": "string", "description": "The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*." }, "policies": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PolicyResponse" }, "description": "Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. If an external policy (such as ``AWS::IAM::Policy`` or" }, "roleId": { "type": "string", "description": "Property roleId" }, "roleName": { "type": "string", "description": "A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. This parameter allows (per its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both 'Role1' and 'role1'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Finding and Acknowledging Application Capabilities (Console)](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html#acknowledging-application-capabilities-console)." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsIamServerCertificateProperties": { "description": "Definition of awsIamServerCertificate", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN) of the server certificate" }, "certificateBody": { "type": "string", "description": "Property certificateBody" }, "certificateChain": { "type": "string", "description": "Property certificateChain" }, "path": { "type": "string", "description": "Property path" }, "privateKey": { "type": "string", "description": "Property privateKey" }, "serverCertificateName": { "type": "string", "description": "Property serverCertificateName" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" } }, "type": "object" }, "azure-native:awsconnector:AwsIamServerCertificatePropertiesResponse": { "description": "Definition of awsIamServerCertificate", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN) of the server certificate" }, "certificateBody": { "type": "string", "description": "Property certificateBody" }, "certificateChain": { "type": "string", "description": "Property certificateChain" }, "path": { "type": "string", "description": "Property path" }, "privateKey": { "type": "string", "description": "Property privateKey" }, "serverCertificateName": { "type": "string", "description": "Property serverCertificateName" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" } }, "type": "object" }, "azure-native:awsconnector:AwsIamVirtualMFADeviceProperties": { "description": "Definition of awsIamVirtualMFADevice", "properties": { "path": { "type": "string", "description": "Property path" }, "serialNumber": { "type": "string", "description": "Property serialNumber" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "users": { "type": "array", "items": { "type": "string" }, "description": "Property users" }, "virtualMfaDeviceName": { "type": "string", "description": "Property virtualMfaDeviceName" } }, "type": "object" }, "azure-native:awsconnector:AwsIamVirtualMFADevicePropertiesResponse": { "description": "Definition of awsIamVirtualMFADevice", "properties": { "path": { "type": "string", "description": "Property path" }, "serialNumber": { "type": "string", "description": "Property serialNumber" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "users": { "type": "array", "items": { "type": "string" }, "description": "Property users" }, "virtualMfaDeviceName": { "type": "string", "description": "Property virtualMfaDeviceName" } }, "type": "object" }, "azure-native:awsconnector:AwsKmsAliasProperties": { "description": "Definition of awsKmsAlias", "properties": { "aliasName": { "type": "string", "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)." }, "targetKeyId": { "type": "string", "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)." } }, "type": "object" }, "azure-native:awsconnector:AwsKmsAliasPropertiesResponse": { "description": "Definition of awsKmsAlias", "properties": { "aliasName": { "type": "string", "description": "Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk)." }, "targetKeyId": { "type": "string", "description": "Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html)." } }, "type": "object" }, "azure-native:awsconnector:AwsKmsKeyProperties": { "description": "Definition of awsKmsKey", "properties": { "arn": { "type": "string", "description": "Property arn" }, "bypassPolicyLockoutSafetyCheck": { "type": "boolean", "description": "Skips ('bypasses') the key policy lockout safety check. The default value is false. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key." }, "description": { "type": "string", "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use." }, "enableKeyRotation": { "type": "boolean", "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*." }, "enabled": { "type": "boolean", "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*." }, "keyId": { "type": "string", "description": "Property keyId" }, "keyPolicy": { "$ref": "pulumi.json#/Any", "description": "The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. A key policy document can include only the following characters: + Printable ASCII characters + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters *Minimum*: ``1`` *Maximum*: ``32768``" }, "keySpec": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KeySpec" } ], "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [Services that are integrated with](https://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + HMAC keys (symmetric) + ``HMAC_224`` + ``HMAC_256`` + ``HMAC_384`` + ``HMAC_512`` + Asymmetric RSA key pairs + ``RSA_2048`` + ``RSA_3072`` + ``RSA_4096`` + Asymmetric NIST-recommended elliptic curve key pairs + ``ECC_NIST_P256`` (secp256r1) + ``ECC_NIST_P384`` (secp384r1) + ``ECC_NIST_P521`` (secp521r1) + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + SM2 key pairs (China Regions only) + ``SM2``", "default": "SYMMETRIC_DEFAULT" }, "keyUsage": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KeyUsage" } ], "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.", "default": "ENCRYPT_DECRYPT" }, "multiRegion": { "type": "boolean", "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key." }, "origin": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Origin" } ], "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", "default": "AWS_KMS" }, "pendingWindowInDays": { "type": "integer", "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*." }, "rotationPeriodInDays": { "type": "integer", "description": "Property rotationPeriodInDays", "default": 365 }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Assigns one or more tags to the replica key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." } }, "type": "object" }, "azure-native:awsconnector:AwsKmsKeyPropertiesResponse": { "description": "Definition of awsKmsKey", "properties": { "arn": { "type": "string", "description": "Property arn" }, "bypassPolicyLockoutSafetyCheck": { "type": "boolean", "description": "Skips ('bypasses') the key policy lockout safety check. The default value is false. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key." }, "description": { "type": "string", "description": "A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use." }, "enableKeyRotation": { "type": "boolean", "description": "Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*." }, "enabled": { "type": "boolean", "description": "Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*." }, "keyId": { "type": "string", "description": "Property keyId" }, "keyPolicy": { "$ref": "pulumi.json#/Any", "description": "The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. A key policy document can include only the following characters: + Printable ASCII characters + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\\u0009``), line feed (``\\u000A``), and carriage return (``\\u000D``) special characters *Minimum*: ``1`` *Maximum*: ``32768``" }, "keySpec": { "type": "string", "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [Services that are integrated with](https://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + HMAC keys (symmetric) + ``HMAC_224`` + ``HMAC_256`` + ``HMAC_384`` + ``HMAC_512`` + Asymmetric RSA key pairs + ``RSA_2048`` + ``RSA_3072`` + ``RSA_4096`` + Asymmetric NIST-recommended elliptic curve key pairs + ``ECC_NIST_P256`` (secp256r1) + ``ECC_NIST_P384`` (secp384r1) + ``ECC_NIST_P521`` (secp521r1) + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + SM2 key pairs (China Regions only) + ``SM2``", "default": "SYMMETRIC_DEFAULT" }, "keyUsage": { "type": "string", "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.", "default": "ENCRYPT_DECRYPT" }, "multiRegion": { "type": "boolean", "description": "Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key." }, "origin": { "type": "string", "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", "default": "AWS_KMS" }, "pendingWindowInDays": { "type": "integer", "description": "Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*." }, "rotationPeriodInDays": { "type": "integer", "description": "Property rotationPeriodInDays", "default": 365 }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Assigns one or more tags to the replica key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." } }, "type": "object" }, "azure-native:awsconnector:AwsLambdaFunctionCodeLocationProperties": { "description": "Definition of awsLambdaFunctionCodeLocation", "properties": { "imageUri": { "type": "string", "description": "\u003cp\u003eURI of a container image in the Amazon ECR registry.\u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eA presigned URL that you can use to download the deployment package.\u003c/p\u003e" }, "repositoryType": { "type": "string", "description": "\u003cp\u003eThe service that's hosting the file.\u003c/p\u003e" }, "resolvedImageUri": { "type": "string", "description": "\u003cp\u003eThe resolved URI for the image.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsLambdaFunctionCodeLocationPropertiesResponse": { "description": "Definition of awsLambdaFunctionCodeLocation", "properties": { "imageUri": { "type": "string", "description": "\u003cp\u003eURI of a container image in the Amazon ECR registry.\u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eA presigned URL that you can use to download the deployment package.\u003c/p\u003e" }, "repositoryType": { "type": "string", "description": "\u003cp\u003eThe service that's hosting the file.\u003c/p\u003e" }, "resolvedImageUri": { "type": "string", "description": "\u003cp\u003eThe resolved URI for the image.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsLambdaFunctionProperties": { "description": "Definition of awsLambdaFunction", "properties": { "architectures": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Architectures" } ] }, "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``." }, "arn": { "type": "string", "description": "Property arn" }, "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Code", "description": "The code for the function. The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template." }, "codeSigningConfigArn": { "type": "string", "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function." }, "deadLetterConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeadLetterConfig", "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations." }, "description": { "type": "string", "description": "A description of the function." }, "environment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Environment", "description": "Environment variables that are accessible from function code during execution. A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration." }, "ephemeralStorage": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EphemeralStorage", "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." }, "fileSystemConfigs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FileSystemConfig" }, "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)." }, "functionName": { "type": "string", "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "handler": { "type": "string", "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html)." }, "imageConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageConfig", "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." }, "kmsKeyArn": { "type": "string", "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key." }, "layers": { "type": "array", "items": { "type": "string" }, "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version." }, "loggingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingConfig", "description": "The function's Amazon CloudWatch Logs configuration settings. The function's Amazon CloudWatch Logs configuration settings." }, "memorySize": { "type": "integer", "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase." }, "packageType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PackageType" } ], "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive." }, "reservedConcurrentExecutions": { "type": "integer", "description": "The number of simultaneous executions to reserve for the function." }, "role": { "type": "string", "description": "The Amazon Resource Name (ARN) of the function's execution role." }, "runtime": { "type": "string", "description": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." }, "runtimeManagementConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuntimeManagementConfig", "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." }, "snapStart": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapStart", "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." }, "snapStartResponse": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapStartResponse", "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function." }, "timeout": { "type": "integer", "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)." }, "tracingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TracingConfig", "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``." }, "vpcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfig", "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted." } }, "type": "object" }, "azure-native:awsconnector:AwsLambdaFunctionPropertiesResponse": { "description": "Definition of awsLambdaFunction", "properties": { "architectures": { "type": "array", "items": { "type": "string" }, "description": "The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``." }, "arn": { "type": "string", "description": "Property arn" }, "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CodeResponse", "description": "The code for the function. The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template." }, "codeSigningConfigArn": { "type": "string", "description": "To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function." }, "deadLetterConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeadLetterConfigResponse", "description": "A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations." }, "description": { "type": "string", "description": "A description of the function." }, "environment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentResponse", "description": "Environment variables that are accessible from function code during execution. A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration." }, "ephemeralStorage": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EphemeralStorageResponseV1", "description": "The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB." }, "fileSystemConfigs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FileSystemConfigResponse" }, "description": "Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html)." }, "functionName": { "type": "string", "description": "The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "handler": { "type": "string", "description": "The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html)." }, "imageConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImageConfigResponse", "description": "Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms)." }, "kmsKeyArn": { "type": "string", "description": "The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key." }, "layers": { "type": "array", "items": { "type": "string" }, "description": "A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version." }, "loggingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingConfigResponse", "description": "The function's Amazon CloudWatch Logs configuration settings. The function's Amazon CloudWatch Logs configuration settings." }, "memorySize": { "type": "integer", "description": "The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase." }, "packageType": { "type": "string", "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive." }, "reservedConcurrentExecutions": { "type": "integer", "description": "The number of simultaneous executions to reserve for the function." }, "role": { "type": "string", "description": "The Amazon Resource Name (ARN) of the function's execution role." }, "runtime": { "type": "string", "description": "The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy)." }, "runtimeManagementConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuntimeManagementConfigResponse", "description": "Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html)." }, "snapStart": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapStartResponse", "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." }, "snapStartResponse": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapStartResponseResponse", "description": "The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function." }, "timeout": { "type": "integer", "description": "The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html)." }, "tracingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TracingConfigResponse", "description": "Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``." }, "vpcConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfigResponseV1", "description": "For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted." } }, "type": "object" }, "azure-native:awsconnector:AwsLightsailBucketProperties": { "description": "Definition of awsLightsailBucket", "properties": { "ableToUpdateBundle": { "type": "boolean", "description": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle." }, "accessRules": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessRules", "description": "An object that sets the public accessibility of objects in the specified bucket." }, "bucketArn": { "type": "string", "description": "Property bucketArn" }, "bucketName": { "type": "string", "description": "The name for the bucket." }, "bundleId": { "type": "string", "description": "The ID of the bundle to use for the bucket." }, "objectVersioning": { "type": "boolean", "description": "Specifies whether to enable or disable versioning of objects in the bucket." }, "readOnlyAccessAccounts": { "type": "array", "items": { "type": "string" }, "description": "An array of strings to specify the AWS account IDs that can access the bucket." }, "resourcesReceivingAccess": { "type": "array", "items": { "type": "string" }, "description": "The names of the Lightsail resources for which to set bucket access." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." }, "url": { "type": "string", "description": "The URL of the bucket." } }, "type": "object" }, "azure-native:awsconnector:AwsLightsailBucketPropertiesResponse": { "description": "Definition of awsLightsailBucket", "properties": { "ableToUpdateBundle": { "type": "boolean", "description": "Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle." }, "accessRules": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessRulesResponse", "description": "An object that sets the public accessibility of objects in the specified bucket." }, "bucketArn": { "type": "string", "description": "Property bucketArn" }, "bucketName": { "type": "string", "description": "The name for the bucket." }, "bundleId": { "type": "string", "description": "The ID of the bundle to use for the bucket." }, "objectVersioning": { "type": "boolean", "description": "Specifies whether to enable or disable versioning of objects in the bucket." }, "readOnlyAccessAccounts": { "type": "array", "items": { "type": "string" }, "description": "An array of strings to specify the AWS account IDs that can access the bucket." }, "resourcesReceivingAccess": { "type": "array", "items": { "type": "string" }, "description": "The names of the Lightsail resources for which to set bucket access." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." }, "url": { "type": "string", "description": "The URL of the bucket." } }, "type": "object" }, "azure-native:awsconnector:AwsLightsailInstanceProperties": { "description": "Definition of awsLightsailInstance", "properties": { "addOns": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AddOn" }, "description": "An array of objects representing the add-ons to enable for the new instance." }, "availabilityZone": { "type": "string", "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." }, "blueprintId": { "type": "string", "description": "The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints )." }, "bundleId": { "type": "string", "description": "The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 )." }, "hardware": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Hardware", "description": "Hardware of the Instance." }, "instanceArn": { "type": "string", "description": "Property instanceArn" }, "instanceName": { "type": "string", "description": "The names to use for your new Lightsail instance." }, "isStaticIp": { "type": "boolean", "description": "Is the IP Address of the Instance is the static IP" }, "keyPairName": { "type": "string", "description": "The name of your key pair." }, "location": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Location", "description": "Location of a resource." }, "networking": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Networking", "description": "Networking of the Instance." }, "privateIpAddress": { "type": "string", "description": "Private IP Address of the Instance" }, "publicIpAddress": { "type": "string", "description": "Public IP Address of the Instance" }, "resourceType": { "type": "string", "description": "Resource type of Lightsail instance." }, "sshKeyName": { "type": "string", "description": "SSH Key Name of the Lightsail instance." }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:State", "description": "Current State of the Instance." }, "supportCode": { "type": "string", "description": "Support code to help identify any issues" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." }, "userData": { "type": "string", "description": "A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update." }, "userName": { "type": "string", "description": "Username of the Lightsail instance." } }, "type": "object" }, "azure-native:awsconnector:AwsLightsailInstancePropertiesResponse": { "description": "Definition of awsLightsailInstance", "properties": { "addOns": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AddOnResponse" }, "description": "An array of objects representing the add-ons to enable for the new instance." }, "availabilityZone": { "type": "string", "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." }, "blueprintId": { "type": "string", "description": "The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints )." }, "bundleId": { "type": "string", "description": "The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 )." }, "hardware": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HardwareResponse", "description": "Hardware of the Instance." }, "instanceArn": { "type": "string", "description": "Property instanceArn" }, "instanceName": { "type": "string", "description": "The names to use for your new Lightsail instance." }, "isStaticIp": { "type": "boolean", "description": "Is the IP Address of the Instance is the static IP" }, "keyPairName": { "type": "string", "description": "The name of your key pair." }, "location": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LocationResponse", "description": "Location of a resource." }, "networking": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkingResponse", "description": "Networking of the Instance." }, "privateIpAddress": { "type": "string", "description": "Private IP Address of the Instance" }, "publicIpAddress": { "type": "string", "description": "Public IP Address of the Instance" }, "resourceType": { "type": "string", "description": "Resource type of Lightsail instance." }, "sshKeyName": { "type": "string", "description": "SSH Key Name of the Lightsail instance." }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StateResponse", "description": "Current State of the Instance." }, "supportCode": { "type": "string", "description": "Support code to help identify any issues" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." }, "userData": { "type": "string", "description": "A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update." }, "userName": { "type": "string", "description": "Username of the Lightsail instance." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsLogGroupProperties": { "description": "Definition of awsLogsLogGroup", "properties": { "arn": { "type": "string", "description": "Property arn" }, "dataProtectionPolicy": { "$ref": "pulumi.json#/Any", "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks. For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)." }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error. Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)" }, "logGroupClass": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LogGroupClass" } ], "description": "Specifies the log group class for this log group. There are two classes: + The ``Standard`` log class supports all CWL features. + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", "default": "STANDARD" }, "logGroupName": { "type": "string", "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group." }, "retentionInDays": { "type": "integer", "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to the log group. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsLogGroupPropertiesResponse": { "description": "Definition of awsLogsLogGroup", "properties": { "arn": { "type": "string", "description": "Property arn" }, "dataProtectionPolicy": { "$ref": "pulumi.json#/Any", "description": "Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks. For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html)." }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error. Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html)" }, "logGroupClass": { "type": "string", "description": "Specifies the log group class for this log group. There are two classes: + The ``Standard`` log class supports all CWL features. + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", "default": "STANDARD" }, "logGroupName": { "type": "string", "description": "The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group." }, "retentionInDays": { "type": "integer", "description": "The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html)." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to the log group. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html)." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsLogStreamProperties": { "description": "Definition of awsLogsLogStream", "properties": { "logGroupName": { "type": "string", "description": "The name of the log group where the log stream is created." }, "logStreamName": { "type": "string", "description": "The name of the log stream. The name must be unique wihtin the log group." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsLogStreamPropertiesResponse": { "description": "Definition of awsLogsLogStream", "properties": { "logGroupName": { "type": "string", "description": "The name of the log group where the log stream is created." }, "logStreamName": { "type": "string", "description": "The name of the log stream. The name must be unique wihtin the log group." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsMetricFilterProperties": { "description": "Definition of awsLogsMetricFilter", "properties": { "filterName": { "type": "string", "description": "The name of the metric filter." }, "filterPattern": { "type": "string", "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." }, "logGroupName": { "type": "string", "description": "The name of an existing log group that you want to associate with this metric filter." }, "metricTransformations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricTransformation" }, "description": "The metric transformations." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsMetricFilterPropertiesResponse": { "description": "Definition of awsLogsMetricFilter", "properties": { "filterName": { "type": "string", "description": "The name of the metric filter." }, "filterPattern": { "type": "string", "description": "A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." }, "logGroupName": { "type": "string", "description": "The name of an existing log group that you want to associate with this metric filter." }, "metricTransformations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricTransformationResponse" }, "description": "The metric transformations." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsSubscriptionFilterProperties": { "description": "Definition of awsLogsSubscriptionFilter", "properties": { "destinationArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the destination." }, "distribution": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Distribution" } ], "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream." }, "filterName": { "type": "string", "description": "The name of the subscription filter." }, "filterPattern": { "type": "string", "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." }, "logGroupName": { "type": "string", "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events." }, "roleArn": { "type": "string", "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery." } }, "type": "object" }, "azure-native:awsconnector:AwsLogsSubscriptionFilterPropertiesResponse": { "description": "Definition of awsLogsSubscriptionFilter", "properties": { "destinationArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the destination." }, "distribution": { "type": "string", "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream." }, "filterName": { "type": "string", "description": "The name of the subscription filter." }, "filterPattern": { "type": "string", "description": "The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html)." }, "logGroupName": { "type": "string", "description": "The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events." }, "roleArn": { "type": "string", "description": "The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery." } }, "type": "object" }, "azure-native:awsconnector:AwsMacie2JobSummaryProperties": { "description": "Definition of awsMacie2JobSummary", "properties": { "bucketCriteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3BucketCriteriaForJob", "description": "\u003cp\u003eThe property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.\u003c/p\u003e" }, "bucketDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3BucketDefinitionForJob" }, "description": "\u003cp\u003eAn array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.\u003c/p\u003e" }, "createdAt": { "type": "string", "description": "\u003cp\u003eThe date and time, in UTC and extended ISO 8601 format, when the job was created.\u003c/p\u003e" }, "jobId": { "type": "string", "description": "\u003cp\u003eThe unique identifier for the job.\u003c/p\u003e" }, "jobStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:JobStatusEnumValue", "description": "\u003cp\u003eThe current status of the job. Possible values are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eCANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eCOMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eIDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003ePAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eRUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eUSER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e" }, "jobType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:JobTypeEnumValue", "description": "\u003cp\u003eThe schedule for running the job. Possible values are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eONE_TIME - The job runs only once.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eSCHEDULED - The job runs on a daily, weekly, or monthly basis.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e" }, "lastRunErrorStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LastRunErrorStatus", "description": "\u003cp\u003eSpecifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe custom name of the job.\u003c/p\u003e" }, "userPausedDetails": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UserPausedDetails", "description": "\u003cp\u003eIf the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsMacie2JobSummaryPropertiesResponse": { "description": "Definition of awsMacie2JobSummary", "properties": { "bucketCriteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3BucketCriteriaForJobResponse", "description": "\u003cp\u003eThe property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.\u003c/p\u003e" }, "bucketDefinitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3BucketDefinitionForJobResponse" }, "description": "\u003cp\u003eAn array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.\u003c/p\u003e" }, "createdAt": { "type": "string", "description": "\u003cp\u003eThe date and time, in UTC and extended ISO 8601 format, when the job was created.\u003c/p\u003e" }, "jobId": { "type": "string", "description": "\u003cp\u003eThe unique identifier for the job.\u003c/p\u003e" }, "jobStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:JobStatusEnumValueResponse", "description": "\u003cp\u003eThe current status of the job. Possible values are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eCANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eCOMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eIDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003ePAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eRUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eUSER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e" }, "jobType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:JobTypeEnumValueResponse", "description": "\u003cp\u003eThe schedule for running the job. Possible values are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eONE_TIME - The job runs only once.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eSCHEDULED - The job runs on a daily, weekly, or monthly basis.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e" }, "lastRunErrorStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LastRunErrorStatusResponse", "description": "\u003cp\u003eSpecifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe custom name of the job.\u003c/p\u003e" }, "userPausedDetails": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UserPausedDetailsResponse", "description": "\u003cp\u003eIf the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsMacieAllowListProperties": { "description": "Definition of awsMacieAllowList", "properties": { "arn": { "type": "string", "description": "AllowList ARN." }, "criteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Criteria", "description": "AllowList criteria. The regex or s3 object to use for the AllowList." }, "description": { "type": "string", "description": "Description of AllowList." }, "id": { "type": "string", "description": "AllowList ID." }, "name": { "type": "string", "description": "Name of AllowList." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Status" } ], "description": "AllowList status. The status for the AllowList" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A collection of tags associated with a resource" } }, "type": "object" }, "azure-native:awsconnector:AwsMacieAllowListPropertiesResponse": { "description": "Definition of awsMacieAllowList", "properties": { "arn": { "type": "string", "description": "AllowList ARN." }, "criteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaResponse", "description": "AllowList criteria. The regex or s3 object to use for the AllowList." }, "description": { "type": "string", "description": "Description of AllowList." }, "id": { "type": "string", "description": "AllowList ID." }, "name": { "type": "string", "description": "Name of AllowList." }, "status": { "type": "string", "description": "AllowList status. The status for the AllowList" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A collection of tags associated with a resource" } }, "type": "object" }, "azure-native:awsconnector:AwsNetworkFirewallFirewallPolicyProperties": { "description": "Definition of awsNetworkFirewallFirewallPolicy", "properties": { "description": { "type": "string", "description": "Property description" }, "firewallPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FirewallPolicy", "description": "Property firewallPolicy" }, "firewallPolicyArn": { "type": "string", "description": "A resource ARN." }, "firewallPolicyId": { "type": "string", "description": "Property firewallPolicyId" }, "firewallPolicyName": { "type": "string", "description": "Property firewallPolicyName" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" } }, "type": "object" }, "azure-native:awsconnector:AwsNetworkFirewallFirewallPolicyPropertiesResponse": { "description": "Definition of awsNetworkFirewallFirewallPolicy", "properties": { "description": { "type": "string", "description": "Property description" }, "firewallPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FirewallPolicyResponse", "description": "Property firewallPolicy" }, "firewallPolicyArn": { "type": "string", "description": "A resource ARN." }, "firewallPolicyId": { "type": "string", "description": "Property firewallPolicyId" }, "firewallPolicyName": { "type": "string", "description": "Property firewallPolicyName" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" } }, "type": "object" }, "azure-native:awsconnector:AwsNetworkFirewallFirewallProperties": { "description": "Definition of awsNetworkFirewallFirewall", "properties": { "deleteProtection": { "type": "boolean", "description": "Property deleteProtection" }, "description": { "type": "string", "description": "Property description" }, "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "Property endpointIds" }, "firewallArn": { "type": "string", "description": "A resource ARN." }, "firewallId": { "type": "string", "description": "Property firewallId" }, "firewallName": { "type": "string", "description": "Property firewallName" }, "firewallPolicyArn": { "type": "string", "description": "A resource ARN." }, "firewallPolicyChangeProtection": { "type": "boolean", "description": "Property firewallPolicyChangeProtection" }, "subnetChangeProtection": { "type": "boolean", "description": "Property subnetChangeProtection" }, "subnetMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SubnetMapping" }, "description": "Property subnetMappings" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "vpcId": { "type": "string", "description": "Property vpcId" } }, "type": "object" }, "azure-native:awsconnector:AwsNetworkFirewallFirewallPropertiesResponse": { "description": "Definition of awsNetworkFirewallFirewall", "properties": { "deleteProtection": { "type": "boolean", "description": "Property deleteProtection" }, "description": { "type": "string", "description": "Property description" }, "endpointIds": { "type": "array", "items": { "type": "string" }, "description": "Property endpointIds" }, "firewallArn": { "type": "string", "description": "A resource ARN." }, "firewallId": { "type": "string", "description": "Property firewallId" }, "firewallName": { "type": "string", "description": "Property firewallName" }, "firewallPolicyArn": { "type": "string", "description": "A resource ARN." }, "firewallPolicyChangeProtection": { "type": "boolean", "description": "Property firewallPolicyChangeProtection" }, "subnetChangeProtection": { "type": "boolean", "description": "Property subnetChangeProtection" }, "subnetMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SubnetMappingResponseV1" }, "description": "Property subnetMappings" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "vpcId": { "type": "string", "description": "Property vpcId" } }, "type": "object" }, "azure-native:awsconnector:AwsNetworkFirewallRuleGroupProperties": { "description": "Definition of awsNetworkFirewallRuleGroup", "properties": { "capacity": { "type": "integer", "description": "Property capacity" }, "description": { "type": "string", "description": "Property description" }, "ruleGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleGroup", "description": "Property ruleGroup" }, "ruleGroupArn": { "type": "string", "description": "A resource ARN." }, "ruleGroupId": { "type": "string", "description": "Property ruleGroupId" }, "ruleGroupName": { "type": "string", "description": "Property ruleGroupName" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tags" }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Type" } ], "description": "Property type" } }, "type": "object" }, "azure-native:awsconnector:AwsNetworkFirewallRuleGroupPropertiesResponse": { "description": "Definition of awsNetworkFirewallRuleGroup", "properties": { "capacity": { "type": "integer", "description": "Property capacity" }, "description": { "type": "string", "description": "Property description" }, "ruleGroup": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleGroupResponse", "description": "Property ruleGroup" }, "ruleGroupArn": { "type": "string", "description": "A resource ARN." }, "ruleGroupId": { "type": "string", "description": "Property ruleGroupId" }, "ruleGroupName": { "type": "string", "description": "Property ruleGroupName" }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tags" }, "type": { "type": "string", "description": "Property type" } }, "type": "object" }, "azure-native:awsconnector:AwsOpenSearchDomainStatusProperties": { "description": "Definition of awsOpenSearchDomainStatus", "properties": { "accessPolicies": { "type": "string", "description": "\u003cp\u003eIdentity and Access Management (IAM) policy document specifying the access policies for the domain.\u003c/p\u003e" }, "advancedOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eKey-value pairs that specify advanced configuration options.\u003c/p\u003e" }, "advancedSecurityOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdvancedSecurityOptions", "description": "\u003cp\u003eSettings for fine-grained access control.\u003c/p\u003e" }, "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the domain. For more information, see \u003ca href='https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html'\u003eIAM identifiers \u003c/a\u003e in the \u003ci\u003eAWS Identity and Access Management User Guide\u003c/i\u003e.\u003c/p\u003e" }, "autoTuneOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoTuneOptionsOutput", "description": "\u003cp\u003eAuto-Tune settings for the domain.\u003c/p\u003e" }, "changeProgressDetails": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ChangeProgressDetails", "description": "\u003cp\u003eInformation about a configuration change happening on the domain.\u003c/p\u003e" }, "clusterConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterConfig", "description": "\u003cp\u003eContainer for the cluster configuration of the domain.\u003c/p\u003e" }, "cognitoOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CognitoOptions", "description": "\u003cp\u003eKey-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.\u003c/p\u003e" }, "created": { "type": "boolean", "description": "\u003cp\u003eCreation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.\u003c/p\u003e" }, "deleted": { "type": "boolean", "description": "\u003cp\u003eDeletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.\u003c/p\u003e" }, "domainEndpointOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DomainEndpointOptions", "description": "\u003cp\u003eAdditional options for the domain endpoint, such as whether to require HTTPS for all traffic.\u003c/p\u003e" }, "domainId": { "type": "string", "description": "\u003cp\u003eUnique identifier for the domain.\u003c/p\u003e" }, "domainName": { "type": "string", "description": "\u003cp\u003eName of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.\u003c/p\u003e" }, "domainProcessingStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DomainProcessingStatusTypeEnumValue", "description": "\u003cp\u003eThe status of any changes that are currently in progress for the domain.\u003c/p\u003e" }, "ebsOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EBSOptions", "description": "\u003cp\u003eContainer for EBS-based storage settings for the domain.\u003c/p\u003e" }, "encryptionAtRestOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionAtRestOptions", "description": "\u003cp\u003eEncryption at rest settings for the domain.\u003c/p\u003e" }, "endpoint": { "type": "string", "description": "\u003cp\u003eDomain-specific endpoint used to submit index, search, and data upload requests to the domain.\u003c/p\u003e" }, "endpointV2": { "type": "string", "description": "\u003cp\u003eIf \u003ccode\u003eIPAddressType\u003c/code\u003e to set to \u003ccode\u003edualstack\u003c/code\u003e, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. \u003c/p\u003e" }, "endpoints": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example \u003ccode\u003ekey, value\u003c/code\u003e: \u003ccode\u003e'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'\u003c/code\u003e.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eVersion of OpenSearch or Elasticsearch that the domain is running, in the format \u003ccode\u003eElasticsearch_X.Y\u003c/code\u003e or \u003ccode\u003eOpenSearch_X.Y\u003c/code\u003e.\u003c/p\u003e" }, "ipAddressType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPAddressTypeEnumValue", "description": "\u003cp\u003eThe type of IP addresses supported by the endpoint for the domain.\u003c/p\u003e" }, "logPublishingOptions": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogPublishingOption" }, "description": "\u003cp\u003eLog publishing options for the domain.\u003c/p\u003e" }, "modifyingProperties": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ModifyingProperties" }, "description": "\u003cp\u003eInformation about the domain properties that are currently being modified.\u003c/p\u003e" }, "nodeToNodeEncryptionOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NodeToNodeEncryptionOptions", "description": "\u003cp\u003eWhether node-to-node encryption is enabled or disabled.\u003c/p\u003e" }, "offPeakWindowOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OffPeakWindowOptions", "description": "\u003cp\u003eOptions that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.\u003c/p\u003e" }, "processing": { "type": "boolean", "description": "\u003cp\u003eThe status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.\u003c/p\u003e" }, "serviceSoftwareOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceSoftwareOptions", "description": "\u003cp\u003eThe current status of the domain's service software.\u003c/p\u003e" }, "snapshotOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapshotOptions", "description": "\u003cp\u003eDEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.\u003c/p\u003e" }, "softwareUpdateOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SoftwareUpdateOptions", "description": "\u003cp\u003eService software update options for the domain.\u003c/p\u003e" }, "upgradeProcessing": { "type": "boolean", "description": "\u003cp\u003eThe status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.\u003c/p\u003e" }, "vpcOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VPCDerivedInfo", "description": "\u003cp\u003eThe VPC configuration for the domain.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsOpenSearchDomainStatusPropertiesResponse": { "description": "Definition of awsOpenSearchDomainStatus", "properties": { "accessPolicies": { "type": "string", "description": "\u003cp\u003eIdentity and Access Management (IAM) policy document specifying the access policies for the domain.\u003c/p\u003e" }, "advancedOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eKey-value pairs that specify advanced configuration options.\u003c/p\u003e" }, "advancedSecurityOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AdvancedSecurityOptionsResponse", "description": "\u003cp\u003eSettings for fine-grained access control.\u003c/p\u003e" }, "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the domain. For more information, see \u003ca href='https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html'\u003eIAM identifiers \u003c/a\u003e in the \u003ci\u003eAWS Identity and Access Management User Guide\u003c/i\u003e.\u003c/p\u003e" }, "autoTuneOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AutoTuneOptionsOutputResponse", "description": "\u003cp\u003eAuto-Tune settings for the domain.\u003c/p\u003e" }, "changeProgressDetails": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ChangeProgressDetailsResponse", "description": "\u003cp\u003eInformation about a configuration change happening on the domain.\u003c/p\u003e" }, "clusterConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterConfigResponse", "description": "\u003cp\u003eContainer for the cluster configuration of the domain.\u003c/p\u003e" }, "cognitoOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CognitoOptionsResponse", "description": "\u003cp\u003eKey-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.\u003c/p\u003e" }, "created": { "type": "boolean", "description": "\u003cp\u003eCreation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.\u003c/p\u003e" }, "deleted": { "type": "boolean", "description": "\u003cp\u003eDeletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.\u003c/p\u003e" }, "domainEndpointOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DomainEndpointOptionsResponse", "description": "\u003cp\u003eAdditional options for the domain endpoint, such as whether to require HTTPS for all traffic.\u003c/p\u003e" }, "domainId": { "type": "string", "description": "\u003cp\u003eUnique identifier for the domain.\u003c/p\u003e" }, "domainName": { "type": "string", "description": "\u003cp\u003eName of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.\u003c/p\u003e" }, "domainProcessingStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DomainProcessingStatusTypeEnumValueResponse", "description": "\u003cp\u003eThe status of any changes that are currently in progress for the domain.\u003c/p\u003e" }, "ebsOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EBSOptionsResponse", "description": "\u003cp\u003eContainer for EBS-based storage settings for the domain.\u003c/p\u003e" }, "encryptionAtRestOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionAtRestOptionsResponse", "description": "\u003cp\u003eEncryption at rest settings for the domain.\u003c/p\u003e" }, "endpoint": { "type": "string", "description": "\u003cp\u003eDomain-specific endpoint used to submit index, search, and data upload requests to the domain.\u003c/p\u003e" }, "endpointV2": { "type": "string", "description": "\u003cp\u003eIf \u003ccode\u003eIPAddressType\u003c/code\u003e to set to \u003ccode\u003edualstack\u003c/code\u003e, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses. \u003c/p\u003e" }, "endpoints": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eThe key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example \u003ccode\u003ekey, value\u003c/code\u003e: \u003ccode\u003e'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'\u003c/code\u003e.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eVersion of OpenSearch or Elasticsearch that the domain is running, in the format \u003ccode\u003eElasticsearch_X.Y\u003c/code\u003e or \u003ccode\u003eOpenSearch_X.Y\u003c/code\u003e.\u003c/p\u003e" }, "ipAddressType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPAddressTypeEnumValueResponse", "description": "\u003cp\u003eThe type of IP addresses supported by the endpoint for the domain.\u003c/p\u003e" }, "logPublishingOptions": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogPublishingOptionResponse" }, "description": "\u003cp\u003eLog publishing options for the domain.\u003c/p\u003e" }, "modifyingProperties": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ModifyingPropertiesResponse" }, "description": "\u003cp\u003eInformation about the domain properties that are currently being modified.\u003c/p\u003e" }, "nodeToNodeEncryptionOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NodeToNodeEncryptionOptionsResponse", "description": "\u003cp\u003eWhether node-to-node encryption is enabled or disabled.\u003c/p\u003e" }, "offPeakWindowOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OffPeakWindowOptionsResponse", "description": "\u003cp\u003eOptions that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.\u003c/p\u003e" }, "processing": { "type": "boolean", "description": "\u003cp\u003eThe status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.\u003c/p\u003e" }, "serviceSoftwareOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceSoftwareOptionsResponse", "description": "\u003cp\u003eThe current status of the domain's service software.\u003c/p\u003e" }, "snapshotOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SnapshotOptionsResponse", "description": "\u003cp\u003eDEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.\u003c/p\u003e" }, "softwareUpdateOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SoftwareUpdateOptionsResponse", "description": "\u003cp\u003eService software update options for the domain.\u003c/p\u003e" }, "upgradeProcessing": { "type": "boolean", "description": "\u003cp\u003eThe status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.\u003c/p\u003e" }, "vpcOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VPCDerivedInfoResponse", "description": "\u003cp\u003eThe VPC configuration for the domain.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsOrganizationsAccountProperties": { "description": "Definition of awsOrganizationsAccount", "properties": { "accountId": { "type": "string", "description": "If the account was created successfully, the unique identifier (ID) of the new account." }, "accountName": { "type": "string", "description": "The friendly name of the member account." }, "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the account." }, "email": { "type": "string", "description": "The email address of the owner to assign to the new member account." }, "joinedMethod": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:JoinedMethod" } ], "description": "The method by which the account joined the organization." }, "joinedTimestamp": { "type": "string", "description": "The date the account became a part of the organization." }, "parentIds": { "type": "array", "items": { "type": "string" }, "description": "List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root." }, "roleName": { "type": "string", "description": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.", "default": "OrganizationAccountAccessRole" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Status" } ], "description": "The status of the account in the organization." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value." } }, "type": "object" }, "azure-native:awsconnector:AwsOrganizationsAccountPropertiesResponse": { "description": "Definition of awsOrganizationsAccount", "properties": { "accountId": { "type": "string", "description": "If the account was created successfully, the unique identifier (ID) of the new account." }, "accountName": { "type": "string", "description": "The friendly name of the member account." }, "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the account." }, "email": { "type": "string", "description": "The email address of the owner to assign to the new member account." }, "joinedMethod": { "type": "string", "description": "The method by which the account joined the organization." }, "joinedTimestamp": { "type": "string", "description": "The date the account became a part of the organization." }, "parentIds": { "type": "array", "items": { "type": "string" }, "description": "List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root." }, "roleName": { "type": "string", "description": "The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified.", "default": "OrganizationAccountAccessRole" }, "status": { "type": "string", "description": "The status of the account in the organization." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value." } }, "type": "object" }, "azure-native:awsconnector:AwsOrganizationsOrganizationProperties": { "description": "Definition of awsOrganizationsOrganization", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of an organization." }, "featureSet": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FeatureSet" } ], "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.", "default": "ALL" }, "id": { "type": "string", "description": "The unique identifier (ID) of an organization." }, "managementAccountArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization." }, "managementAccountEmail": { "type": "string", "description": "The email address that is associated with the AWS account that is designated as the management account for the organization." }, "managementAccountId": { "type": "string", "description": "The unique identifier (ID) of the management account of an organization." }, "rootId": { "type": "string", "description": "The unique identifier (ID) for the root." } }, "type": "object" }, "azure-native:awsconnector:AwsOrganizationsOrganizationPropertiesResponse": { "description": "Definition of awsOrganizationsOrganization", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of an organization." }, "featureSet": { "type": "string", "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.", "default": "ALL" }, "id": { "type": "string", "description": "The unique identifier (ID) of an organization." }, "managementAccountArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization." }, "managementAccountEmail": { "type": "string", "description": "The email address that is associated with the AWS account that is designated as the management account for the organization." }, "managementAccountId": { "type": "string", "description": "The unique identifier (ID) of the management account of an organization." }, "rootId": { "type": "string", "description": "The unique identifier (ID) for the root." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBClusterProperties": { "description": "Definition of awsRdsDBCluster", "properties": { "allocatedStorage": { "type": "integer", "description": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster." }, "associatedRoles": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DBClusterRole" }, "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf." }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically." }, "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide." }, "backtrackWindow": { "type": "integer", "description": "The target backtrack window, in seconds. To disable backtracking, set this value to 0." }, "backupRetentionPeriod": { "type": "integer", "description": "The number of days for which automated backups are retained.", "default": 1 }, "copyTagsToSnapshot": { "type": "boolean", "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them." }, "databaseName": { "type": "string", "description": "The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide." }, "dbClusterArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the DB cluster." }, "dbClusterIdentifier": { "type": "string", "description": "The DB cluster identifier. This parameter is stored as a lowercase string." }, "dbClusterInstanceClass": { "type": "string", "description": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge." }, "dbClusterParameterGroupName": { "type": "string", "description": "The name of the DB cluster parameter group to associate with this DB cluster.", "default": "default.aurora5.6" }, "dbClusterResourceId": { "type": "string", "description": "The AWS Region-unique, immutable identifier for the DB cluster." }, "dbInstanceParameterGroupName": { "type": "string", "description": "The name of the DB parameter group to apply to all instances of the DB cluster." }, "dbSubnetGroupName": { "type": "string", "description": "A DB subnet group that you want to associate with this DB cluster." }, "dbSystemId": { "type": "string", "description": "Reserved for future use." }, "deletionProtection": { "type": "boolean", "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled." }, "domain": { "type": "string", "description": "The Active Directory directory ID to create the DB cluster in." }, "domainIAMRoleName": { "type": "string", "description": "Specify the name of the IAM role to be used when making API calls to the Directory Service." }, "enableCloudwatchLogsExports": { "type": "array", "items": { "type": "string" }, "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide." }, "enableGlobalWriteForwarding": { "type": "boolean", "description": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database." }, "enableHttpEndpoint": { "type": "boolean", "description": "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled." }, "enableIAMDatabaseAuthentication": { "type": "boolean", "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled." }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RdsDbClusterEndpoint", "description": "Property endpoint" }, "engine": { "type": "string", "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql" }, "engineMode": { "type": "string", "description": "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster." }, "engineVersion": { "type": "string", "description": "The version number of the database engine to use." }, "globalClusterIdentifier": { "type": "string", "description": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.If you aren't configuring a global database cluster, don't specify this property." }, "iops": { "type": "integer", "description": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster." }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true." }, "manageMasterUserPassword": { "type": "boolean", "description": "A value that indicates whether to manage the master user password with AWS Secrets Manager." }, "masterUserPassword": { "type": "string", "description": "The master password for the DB instance." }, "masterUserSecret": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MasterUserSecret", "description": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, "masterUsername": { "type": "string", "description": "The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername." }, "monitoringInterval": { "type": "integer", "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0." }, "monitoringRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs." }, "networkType": { "type": "string", "description": "The network type of the DB cluster." }, "performanceInsightsEnabled": { "type": "boolean", "description": "A value that indicates whether to turn on Performance Insights for the DB cluster." }, "performanceInsightsKmsKeyId": { "type": "string", "description": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data." }, "performanceInsightsRetentionPeriod": { "type": "integer", "description": "The amount of time, in days, to retain Performance Insights data." }, "port": { "type": "integer", "description": "The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql." }, "preferredBackupWindow": { "type": "string", "description": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." }, "publiclyAccessible": { "type": "boolean", "description": "A value that indicates whether the DB cluster is publicly accessible." }, "readEndpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReadEndpoint", "description": "Property readEndpoint" }, "replicationSourceIdentifier": { "type": "string", "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica." }, "restoreToTime": { "type": "string", "description": "The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z" }, "restoreType": { "type": "string", "description": "The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.", "default": "full-copy" }, "scalingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScalingConfiguration", "description": "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster." }, "serverlessV2ScalingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerlessV2ScalingConfiguration", "description": "Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster." }, "snapshotIdentifier": { "type": "string", "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted." }, "sourceDBClusterIdentifier": { "type": "string", "description": "The identifier of the source DB cluster from which to restore." }, "sourceRegion": { "type": "string", "description": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1." }, "storageEncrypted": { "type": "boolean", "description": "Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance." }, "storageThroughput": { "type": "integer", "description": "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type." }, "storageType": { "type": "string", "description": "Specifies the storage type to be associated with the DB cluster." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." }, "useLatestRestorableTime": { "type": "boolean", "description": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time." }, "vpcSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of EC2 VPC security groups to associate with this DB cluster." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBClusterPropertiesResponse": { "description": "Definition of awsRdsDBCluster", "properties": { "allocatedStorage": { "type": "integer", "description": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster." }, "associatedRoles": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DBClusterRoleResponse" }, "description": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf." }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically." }, "availabilityZones": { "type": "array", "items": { "type": "string" }, "description": "A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide." }, "backtrackWindow": { "type": "integer", "description": "The target backtrack window, in seconds. To disable backtracking, set this value to 0." }, "backupRetentionPeriod": { "type": "integer", "description": "The number of days for which automated backups are retained.", "default": 1 }, "copyTagsToSnapshot": { "type": "boolean", "description": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them." }, "databaseName": { "type": "string", "description": "The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide." }, "dbClusterArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the DB cluster." }, "dbClusterIdentifier": { "type": "string", "description": "The DB cluster identifier. This parameter is stored as a lowercase string." }, "dbClusterInstanceClass": { "type": "string", "description": "The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge." }, "dbClusterParameterGroupName": { "type": "string", "description": "The name of the DB cluster parameter group to associate with this DB cluster.", "default": "default.aurora5.6" }, "dbClusterResourceId": { "type": "string", "description": "The AWS Region-unique, immutable identifier for the DB cluster." }, "dbInstanceParameterGroupName": { "type": "string", "description": "The name of the DB parameter group to apply to all instances of the DB cluster." }, "dbSubnetGroupName": { "type": "string", "description": "A DB subnet group that you want to associate with this DB cluster." }, "dbSystemId": { "type": "string", "description": "Reserved for future use." }, "deletionProtection": { "type": "boolean", "description": "A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled." }, "domain": { "type": "string", "description": "The Active Directory directory ID to create the DB cluster in." }, "domainIAMRoleName": { "type": "string", "description": "Specify the name of the IAM role to be used when making API calls to the Directory Service." }, "enableCloudwatchLogsExports": { "type": "array", "items": { "type": "string" }, "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide." }, "enableGlobalWriteForwarding": { "type": "boolean", "description": "Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database." }, "enableHttpEndpoint": { "type": "boolean", "description": "A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled." }, "enableIAMDatabaseAuthentication": { "type": "boolean", "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled." }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RdsDbClusterEndpointResponse", "description": "Property endpoint" }, "engine": { "type": "string", "description": "The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql" }, "engineMode": { "type": "string", "description": "The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster." }, "engineVersion": { "type": "string", "description": "The version number of the database engine to use." }, "globalClusterIdentifier": { "type": "string", "description": "If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.If you aren't configuring a global database cluster, don't specify this property." }, "iops": { "type": "integer", "description": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster." }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true." }, "manageMasterUserPassword": { "type": "boolean", "description": "A value that indicates whether to manage the master user password with AWS Secrets Manager." }, "masterUserPassword": { "type": "string", "description": "The master password for the DB instance." }, "masterUserSecret": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MasterUserSecretResponse", "description": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, "masterUsername": { "type": "string", "description": "The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername." }, "monitoringInterval": { "type": "integer", "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0." }, "monitoringRoleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs." }, "networkType": { "type": "string", "description": "The network type of the DB cluster." }, "performanceInsightsEnabled": { "type": "boolean", "description": "A value that indicates whether to turn on Performance Insights for the DB cluster." }, "performanceInsightsKmsKeyId": { "type": "string", "description": "The Amazon Web Services KMS key identifier for encryption of Performance Insights data." }, "performanceInsightsRetentionPeriod": { "type": "integer", "description": "The amount of time, in days, to retain Performance Insights data." }, "port": { "type": "integer", "description": "The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql." }, "preferredBackupWindow": { "type": "string", "description": "The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide." }, "publiclyAccessible": { "type": "boolean", "description": "A value that indicates whether the DB cluster is publicly accessible." }, "readEndpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReadEndpointResponse", "description": "Property readEndpoint" }, "replicationSourceIdentifier": { "type": "string", "description": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica." }, "restoreToTime": { "type": "string", "description": "The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z" }, "restoreType": { "type": "string", "description": "The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster.", "default": "full-copy" }, "scalingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScalingConfigurationResponse", "description": "The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster." }, "serverlessV2ScalingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerlessV2ScalingConfigurationResponse", "description": "Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster." }, "snapshotIdentifier": { "type": "string", "description": "The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted." }, "sourceDBClusterIdentifier": { "type": "string", "description": "The identifier of the source DB cluster from which to restore." }, "sourceRegion": { "type": "string", "description": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1." }, "storageEncrypted": { "type": "boolean", "description": "Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance." }, "storageThroughput": { "type": "integer", "description": "Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type." }, "storageType": { "type": "string", "description": "Specifies the storage type to be associated with the DB cluster." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." }, "useLatestRestorableTime": { "type": "boolean", "description": "A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time." }, "vpcSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of EC2 VPC security groups to associate with this DB cluster." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBInstanceProperties": { "description": "Definition of awsRdsDBInstance", "properties": { "allocatedStorage": { "type": "string", "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). *Amazon Aurora* Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. *MySQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *MariaDB* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *PostgreSQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *Oracle* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. *SQL Server* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024." }, "allowMajorVersionUpgrade": { "type": "boolean", "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version." }, "associatedRoles": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DBInstanceRole" }, "description": "The IAMlong (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster." }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically." }, "automaticBackupReplicationKmsKeyId": { "type": "string", "description": "Property automaticBackupReplicationKmsKeyId" }, "automaticBackupReplicationRegion": { "type": "string", "description": "The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*." }, "availabilityZone": { "type": "string", "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example: ``us-east-1d``" }, "backupRetentionPeriod": { "type": "integer", "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas", "default": 1 }, "caCertificateIdentifier": { "type": "string", "description": "The identifier of the CA certificate for this DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*." }, "certificateDetails": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateDetails", "description": "The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*." }, "certificateRotationRestart": { "type": "boolean", "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances." }, "characterSetName": { "type": "string", "description": "For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html)." }, "copyTagsToSnapshot": { "type": "boolean", "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting." }, "customIAMInstanceProfile": { "type": "string", "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*." }, "dbClusterIdentifier": { "type": "string", "description": "The identifier of the DB cluster that the instance will belong to." }, "dbClusterSnapshotIdentifier": { "type": "string", "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when ``DBSnapshotIdentifier`` is specified. + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot." }, "dbInstanceArn": { "type": "string", "description": "Property dbInstanceArn" }, "dbInstanceClass": { "type": "string", "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*." }, "dbInstanceIdentifier": { "type": "string", "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "dbName": { "type": "string", "description": "The meaning of this parameter differs according to the database engine you use. If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. Default: ``ORCL`` Constraints: + Can't be longer than 8 characters *SQL Server* Not applicable. Must be null." }, "dbParameterGroupName": { "type": "string", "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text`` If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used." }, "dbSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + ``AllocatedStorage`` + ``AutoMinorVersionUpgrade`` + ``AvailabilityZone`` + ``BackupRetentionPeriod`` + ``CharacterSetName`` + ``DBInstanceClass`` + ``DBName`` + ``DBParameterGroupName`` + ``DBSecurityGroups`` + ``DBSubnetGroupName`` + ``Engine`` + ``EngineVersion`` + ``Iops`` + ``LicenseModel`` + ``MasterUsername`` + ``MasterUserPassword`` + ``MultiAZ`` + ``OptionGroupName`` + ``PreferredBackupWindow`` + ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance." }, "dbSnapshotIdentifier": { "type": "string", "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + ``CharacterSetName`` + ``DBClusterIdentifier`` + ``DBName`` + ``DeleteAutomatedBackups`` + ``EnablePerformanceInsights`` + ``KmsKeyId`` + ``MasterUsername`` + ``MasterUserPassword`` + ``PerformanceInsightsKMSKeyId`` + ``PerformanceInsightsRetentionPeriod`` + ``PromotionTier`` + ``SourceDBInstanceIdentifier`` + ``SourceRegion`` + ``StorageEncrypted`` (for an encrypted snapshot) + ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster." }, "dbSubnetGroupName": { "type": "string", "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting." }, "dbSystemId": { "type": "string", "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB." }, "dbiResourceId": { "type": "string", "description": "Property dbiResourceId" }, "dedicatedLogVolume": { "type": "boolean", "description": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled." }, "deleteAutomatedBackups": { "type": "boolean", "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted." }, "deletionProtection": { "type": "boolean", "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). *Amazon Aurora* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster." }, "domain": { "type": "string", "description": "The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*." }, "domainAuthSecretArn": { "type": "string", "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``" }, "domainDnsIps": { "type": "array", "items": { "type": "string" }, "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237``" }, "domainFqdn": { "type": "string", "description": "The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example: ``mymanagedADtest.mymanagedAD.mydomain``" }, "domainIAMRoleName": { "type": "string", "description": "The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom" }, "domainOu": { "type": "string", "description": "The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``" }, "enableCloudwatchLogsExports": { "type": "array", "items": { "type": "string" }, "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. *Amazon Aurora* Not applicable. CloudWatch Logs exports are managed by the DB cluster. *Db2* Valid values: ``diag.log``, ``notify.log`` *MariaDB* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Microsoft SQL Server* Valid values: ``agent``, ``error`` *MySQL* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Oracle* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` *PostgreSQL* Valid values: ``postgresql``, ``upgrade``" }, "enableIAMDatabaseAuthentication": { "type": "boolean", "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster." }, "enablePerformanceInsights": { "type": "boolean", "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances." }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RdsDbInstanceEndpoint", "description": "The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of ``creating``. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: + ``CreateDBInstance`` + ``DescribeDBInstances`` + ``DeleteDBInstance`` For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``." }, "engine": { "type": "string", "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` or ``oracle-ee-cdb`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + ``db2-ae`` + ``db2-se`` + ``mariadb`` + ``mysql`` + ``oracle-ee`` + ``oracle-ee-cdb`` + ``oracle-se2`` + ``oracle-se2-cdb`` + ``postgres`` + ``sqlserver-ee`` + ``sqlserver-se`` + ``sqlserver-ex`` + ``sqlserver-web``" }, "engineVersion": { "type": "string", "description": "The version number of the database engine to use. For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. *Amazon Aurora* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Microsoft SQL Server* See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* *MySQL* See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Oracle* See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* *PostgreSQL* See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*" }, "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance." }, "kmsKeyId": { "type": "string", "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The KMS key identifier is managed by the DB cluster." }, "licenseModel": { "type": "string", "description": "License model information for this DB instance. Valid Values: + Aurora MySQL - ``general-public-license`` + Aurora PostgreSQL - ``postgresql-license`` + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + RDS for MariaDB - ``general-public-license`` + RDS for Microsoft SQL Server - ``license-included`` + RDS for MySQL - ``general-public-license`` + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + RDS for PostgreSQL - ``postgresql-license`` If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability." }, "manageMasterUserPassword": { "type": "boolean", "description": "Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified." }, "masterUserPassword": { "type": "string", "description": "The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters." }, "masterUserSecret": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MasterUserSecret", "description": "The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*" }, "masterUsername": { "type": "string", "description": "The master user name for the DB instance. If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. *Amazon Aurora* Not applicable. The name for the master user is managed by the DB cluster. *RDS for Db2* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MariaDB* Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. *RDS for Microsoft SQL Server* Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MySQL* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for Oracle* Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for PostgreSQL* Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine." }, "maxAllocatedStorage": { "type": "integer", "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom" }, "monitoringInterval": { "type": "integer", "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: ``0, 1, 5, 10, 15, 30, 60``" }, "monitoringRoleArn": { "type": "string", "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances." }, "multiAZ": { "type": "boolean", "description": "Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set." }, "ncharCharacterSetName": { "type": "string", "description": "The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances." }, "networkType": { "type": "string", "description": "The network type of the DB instance. Valid values: + ``IPV4`` + ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*" }, "optionGroupName": { "type": "string", "description": "Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance." }, "performanceInsightsKMSKeyId": { "type": "string", "description": "The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)." }, "performanceInsightsRetentionPeriod": { "type": "integer", "description": "The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: + ``7`` + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error." }, "port": { "type": "string", "description": "The port number on which the database accepts connections. *Amazon Aurora* Not applicable. The port number is managed by the DB cluster. *Db2* Default value: ``50000``" }, "preferredBackupWindow": { "type": "string", "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* Constraints: + Must be in the format ``hh24:mi-hh24:mi``. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster." }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window." }, "processorFeatures": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProcessorFeature" }, "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances." }, "promotionTier": { "type": "integer", "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15``", "default": 1 }, "publiclyAccessible": { "type": "boolean", "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*." }, "replicaMode": { "type": "string", "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. This setting is only supported in RDS for Oracle. Default: ``open-read-only`` Valid Values: ``open-read-only`` or ``mounted``" }, "restoreTime": { "type": "string", "description": "The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. Example: ``2009-09-07T23:45:00Z``" }, "sourceDBClusterIdentifier": { "type": "string", "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported." }, "sourceDBInstanceAutomatedBackupsArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. This setting doesn't apply to RDS Custom." }, "sourceDBInstanceIdentifier": { "type": "string", "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances." }, "sourceDbiResourceId": { "type": "string", "description": "The resource ID of the source DB instance from which to restore." }, "sourceRegion": { "type": "string", "description": "The ID of the region that contains the source DB instance for the read replica." }, "storageEncrypted": { "type": "boolean", "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster." }, "storageThroughput": { "type": "integer", "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora." }, "storageType": { "type": "string", "description": "The storage type to associate with the DB instance. If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An optional array of key-value pairs to apply to this DB instance." }, "tdeCredentialArn": { "type": "string", "description": "Property tdeCredentialArn" }, "tdeCredentialPassword": { "type": "string", "description": "Property tdeCredentialPassword" }, "timezone": { "type": "string", "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)." }, "useDefaultProcessorFeatures": { "type": "boolean", "description": "Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances." }, "useLatestRestorableTime": { "type": "boolean", "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided." }, "vpcSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. *Amazon Aurora* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBInstancePropertiesResponse": { "description": "Definition of awsRdsDBInstance", "properties": { "allocatedStorage": { "type": "string", "description": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). *Amazon Aurora* Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. *MySQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *MariaDB* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *PostgreSQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *Oracle* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. *SQL Server* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024." }, "allowMajorVersionUpgrade": { "type": "boolean", "description": "A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version." }, "associatedRoles": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DBInstanceRoleResponse" }, "description": "The IAMlong (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster." }, "autoMinorVersionUpgrade": { "type": "boolean", "description": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically." }, "automaticBackupReplicationKmsKeyId": { "type": "string", "description": "Property automaticBackupReplicationKmsKeyId" }, "automaticBackupReplicationRegion": { "type": "string", "description": "The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*." }, "availabilityZone": { "type": "string", "description": "The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example: ``us-east-1d``" }, "backupRetentionPeriod": { "type": "integer", "description": "The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas", "default": 1 }, "caCertificateIdentifier": { "type": "string", "description": "The identifier of the CA certificate for this DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*." }, "certificateDetails": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CertificateDetailsResponse", "description": "The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*." }, "certificateRotationRestart": { "type": "boolean", "description": "Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances." }, "characterSetName": { "type": "string", "description": "For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html)." }, "copyTagsToSnapshot": { "type": "boolean", "description": "Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting." }, "customIAMInstanceProfile": { "type": "string", "description": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*." }, "dbClusterIdentifier": { "type": "string", "description": "The identifier of the DB cluster that the instance will belong to." }, "dbClusterSnapshotIdentifier": { "type": "string", "description": "The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when ``DBSnapshotIdentifier`` is specified. + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot." }, "dbInstanceArn": { "type": "string", "description": "Property dbInstanceArn" }, "dbInstanceClass": { "type": "string", "description": "The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*." }, "dbInstanceIdentifier": { "type": "string", "description": "A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "dbName": { "type": "string", "description": "The meaning of this parameter differs according to the database engine you use. If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. Default: ``ORCL`` Constraints: + Can't be longer than 8 characters *SQL Server* Not applicable. Must be null." }, "dbParameterGroupName": { "type": "string", "description": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text`` If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used." }, "dbSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + ``AllocatedStorage`` + ``AutoMinorVersionUpgrade`` + ``AvailabilityZone`` + ``BackupRetentionPeriod`` + ``CharacterSetName`` + ``DBInstanceClass`` + ``DBName`` + ``DBParameterGroupName`` + ``DBSecurityGroups`` + ``DBSubnetGroupName`` + ``Engine`` + ``EngineVersion`` + ``Iops`` + ``LicenseModel`` + ``MasterUsername`` + ``MasterUserPassword`` + ``MultiAZ`` + ``OptionGroupName`` + ``PreferredBackupWindow`` + ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance." }, "dbSnapshotIdentifier": { "type": "string", "description": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + ``CharacterSetName`` + ``DBClusterIdentifier`` + ``DBName`` + ``DeleteAutomatedBackups`` + ``EnablePerformanceInsights`` + ``KmsKeyId`` + ``MasterUsername`` + ``MasterUserPassword`` + ``PerformanceInsightsKMSKeyId`` + ``PerformanceInsightsRetentionPeriod`` + ``PromotionTier`` + ``SourceDBInstanceIdentifier`` + ``SourceRegion`` + ``StorageEncrypted`` (for an encrypted snapshot) + ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster." }, "dbSubnetGroupName": { "type": "string", "description": "A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting." }, "dbSystemId": { "type": "string", "description": "The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB." }, "dbiResourceId": { "type": "string", "description": "Property dbiResourceId" }, "dedicatedLogVolume": { "type": "boolean", "description": "Indicates whether the DB instance has a dedicated log volume (DLV) enabled." }, "deleteAutomatedBackups": { "type": "boolean", "description": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted." }, "deletionProtection": { "type": "boolean", "description": "A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). *Amazon Aurora* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster." }, "domain": { "type": "string", "description": "The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*." }, "domainAuthSecretArn": { "type": "string", "description": "The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456``" }, "domainDnsIps": { "type": "array", "items": { "type": "string" }, "description": "The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237``" }, "domainFqdn": { "type": "string", "description": "The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example: ``mymanagedADtest.mymanagedAD.mydomain``" }, "domainIAMRoleName": { "type": "string", "description": "The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom" }, "domainOu": { "type": "string", "description": "The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain``" }, "enableCloudwatchLogsExports": { "type": "array", "items": { "type": "string" }, "description": "The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. *Amazon Aurora* Not applicable. CloudWatch Logs exports are managed by the DB cluster. *Db2* Valid values: ``diag.log``, ``notify.log`` *MariaDB* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Microsoft SQL Server* Valid values: ``agent``, ``error`` *MySQL* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Oracle* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` *PostgreSQL* Valid values: ``postgresql``, ``upgrade``" }, "enableIAMDatabaseAuthentication": { "type": "boolean", "description": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster." }, "enablePerformanceInsights": { "type": "boolean", "description": "Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances." }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RdsDbInstanceEndpointResponse", "description": "The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of ``creating``. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: + ``CreateDBInstance`` + ``DescribeDBInstances`` + ``DeleteDBInstance`` For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``." }, "engine": { "type": "string", "description": "The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` or ``oracle-ee-cdb`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + ``db2-ae`` + ``db2-se`` + ``mariadb`` + ``mysql`` + ``oracle-ee`` + ``oracle-ee-cdb`` + ``oracle-se2`` + ``oracle-se2-cdb`` + ``postgres`` + ``sqlserver-ee`` + ``sqlserver-se`` + ``sqlserver-ex`` + ``sqlserver-web``" }, "engineVersion": { "type": "string", "description": "The version number of the database engine to use. For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. *Amazon Aurora* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Microsoft SQL Server* See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* *MySQL* See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Oracle* See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* *PostgreSQL* See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*" }, "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance." }, "kmsKeyId": { "type": "string", "description": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The KMS key identifier is managed by the DB cluster." }, "licenseModel": { "type": "string", "description": "License model information for this DB instance. Valid Values: + Aurora MySQL - ``general-public-license`` + Aurora PostgreSQL - ``postgresql-license`` + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + RDS for MariaDB - ``general-public-license`` + RDS for Microsoft SQL Server - ``license-included`` + RDS for MySQL - ``general-public-license`` + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + RDS for PostgreSQL - ``postgresql-license`` If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability." }, "manageMasterUserPassword": { "type": "boolean", "description": "Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified." }, "masterUserPassword": { "type": "string", "description": "The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters." }, "masterUserSecret": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MasterUserSecretResponse", "description": "The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*" }, "masterUsername": { "type": "string", "description": "The master user name for the DB instance. If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. *Amazon Aurora* Not applicable. The name for the master user is managed by the DB cluster. *RDS for Db2* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MariaDB* Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. *RDS for Microsoft SQL Server* Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MySQL* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for Oracle* Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for PostgreSQL* Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine." }, "maxAllocatedStorage": { "type": "integer", "description": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom" }, "monitoringInterval": { "type": "integer", "description": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: ``0, 1, 5, 10, 15, 30, 60``" }, "monitoringRoleArn": { "type": "string", "description": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances." }, "multiAZ": { "type": "boolean", "description": "Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set." }, "ncharCharacterSetName": { "type": "string", "description": "The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances." }, "networkType": { "type": "string", "description": "The network type of the DB instance. Valid values: + ``IPV4`` + ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*" }, "optionGroupName": { "type": "string", "description": "Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance." }, "performanceInsightsKMSKeyId": { "type": "string", "description": "The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights)." }, "performanceInsightsRetentionPeriod": { "type": "integer", "description": "The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: + ``7`` + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error." }, "port": { "type": "string", "description": "The port number on which the database accepts connections. *Amazon Aurora* Not applicable. The port number is managed by the DB cluster. *Db2* Default value: ``50000``" }, "preferredBackupWindow": { "type": "string", "description": "The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* Constraints: + Must be in the format ``hh24:mi-hh24:mi``. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster." }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window." }, "processorFeatures": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProcessorFeatureResponse" }, "description": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances." }, "promotionTier": { "type": "integer", "description": "The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15``", "default": 1 }, "publiclyAccessible": { "type": "boolean", "description": "Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*." }, "replicaMode": { "type": "string", "description": "The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. This setting is only supported in RDS for Oracle. Default: ``open-read-only`` Valid Values: ``open-read-only`` or ``mounted``" }, "restoreTime": { "type": "string", "description": "The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. Example: ``2009-09-07T23:45:00Z``" }, "sourceDBClusterIdentifier": { "type": "string", "description": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported." }, "sourceDBInstanceAutomatedBackupsArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. This setting doesn't apply to RDS Custom." }, "sourceDBInstanceIdentifier": { "type": "string", "description": "If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances." }, "sourceDbiResourceId": { "type": "string", "description": "The resource ID of the source DB instance from which to restore." }, "sourceRegion": { "type": "string", "description": "The ID of the region that contains the source DB instance for the read replica." }, "storageEncrypted": { "type": "boolean", "description": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster." }, "storageThroughput": { "type": "integer", "description": "Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora." }, "storageType": { "type": "string", "description": "The storage type to associate with the DB instance. If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An optional array of key-value pairs to apply to this DB instance." }, "tdeCredentialArn": { "type": "string", "description": "Property tdeCredentialArn" }, "tdeCredentialPassword": { "type": "string", "description": "Property tdeCredentialPassword" }, "timezone": { "type": "string", "description": "The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone)." }, "useDefaultProcessorFeatures": { "type": "boolean", "description": "Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances." }, "useLatestRestorableTime": { "type": "boolean", "description": "Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided." }, "vpcSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. *Amazon Aurora* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBSnapshotAttributesResultProperties": { "description": "Definition of awsRdsDBSnapshotAttributesResult", "properties": { "dbSnapshotAttributes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DBSnapshotAttribute" }, "description": "\u003cp\u003eThe list of attributes and values for the manual DB snapshot.\u003c/p\u003e" }, "dbSnapshotIdentifier": { "type": "string", "description": "\u003cp\u003eThe identifier of the manual DB snapshot that the attributes apply to.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBSnapshotAttributesResultPropertiesResponse": { "description": "Definition of awsRdsDBSnapshotAttributesResult", "properties": { "dbSnapshotAttributes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DBSnapshotAttributeResponse" }, "description": "\u003cp\u003eThe list of attributes and values for the manual DB snapshot.\u003c/p\u003e" }, "dbSnapshotIdentifier": { "type": "string", "description": "\u003cp\u003eThe identifier of the manual DB snapshot that the attributes apply to.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBSnapshotProperties": { "description": "Definition of awsRdsDBSnapshot", "properties": { "allocatedStorage": { "type": "integer", "description": "\u003cp\u003eSpecifies the allocated storage size in gibibytes (GiB).\u003c/p\u003e" }, "availabilityZone": { "type": "string", "description": "\u003cp\u003eSpecifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.\u003c/p\u003e" }, "dbInstanceIdentifier": { "type": "string", "description": "\u003cp\u003eSpecifies the DB instance identifier of the DB instance this DB snapshot was created from.\u003c/p\u003e" }, "dbSnapshotArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) for the DB snapshot.\u003c/p\u003e" }, "dbSnapshotIdentifier": { "type": "string", "description": "\u003cp\u003eSpecifies the identifier for the DB snapshot.\u003c/p\u003e" }, "dbSystemId": { "type": "string", "description": "\u003cp\u003eThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.\u003c/p\u003e" }, "dbiResourceId": { "type": "string", "description": "\u003cp\u003eThe identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.\u003c/p\u003e" }, "dedicatedLogVolume": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the DB instance has a dedicated log volume (DLV) enabled.\u003c/p\u003e" }, "encrypted": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the DB snapshot is encrypted.\u003c/p\u003e" }, "engine": { "type": "string", "description": "\u003cp\u003eSpecifies the name of the database engine.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eSpecifies the version of the database engine.\u003c/p\u003e" }, "iamDatabaseAuthenticationEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.\u003c/p\u003e" }, "instanceCreateTime": { "type": "string", "description": "\u003cp\u003eSpecifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.\u003c/p\u003e" }, "iops": { "type": "integer", "description": "\u003cp\u003eSpecifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eIf \u003ccode\u003eEncrypted\u003c/code\u003e is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.\u003c/p\u003e \u003cp\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\u003c/p\u003e" }, "licenseModel": { "type": "string", "description": "\u003cp\u003eLicense model information for the restored DB instance.\u003c/p\u003e" }, "masterUsername": { "type": "string", "description": "\u003cp\u003eProvides the master username for the DB snapshot.\u003c/p\u003e" }, "multiTenant": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).\u003c/p\u003e" }, "optionGroupName": { "type": "string", "description": "\u003cp\u003eProvides the option group name for the DB snapshot.\u003c/p\u003e" }, "originalSnapshotCreateTime": { "type": "string", "description": "\u003cp\u003eSpecifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.\u003c/p\u003e" }, "percentProgress": { "type": "integer", "description": "\u003cp\u003eThe percentage of the estimated data that has been transferred.\u003c/p\u003e" }, "port": { "type": "integer", "description": "\u003cp\u003eSpecifies the port that the database engine was listening on at the time of the snapshot.\u003c/p\u003e" }, "processorFeatures": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProcessorFeature" }, "description": "\u003cp\u003eThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.\u003c/p\u003e" }, "snapshotCreateTime": { "type": "string", "description": "\u003cp\u003eSpecifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.\u003c/p\u003e" }, "snapshotDatabaseTime": { "type": "string", "description": "\u003cp\u003eThe timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.\u003c/p\u003e \u003cp\u003eIf you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.\u003c/p\u003e" }, "snapshotTarget": { "type": "string", "description": "\u003cp\u003eSpecifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.\u003c/p\u003e" }, "snapshotType": { "type": "string", "description": "\u003cp\u003eProvides the type of the DB snapshot.\u003c/p\u003e" }, "sourceDBSnapshotIdentifier": { "type": "string", "description": "\u003cp\u003eThe DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.\u003c/p\u003e" }, "sourceRegion": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region that the DB snapshot was created in or copied from.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eSpecifies the status of this DB snapshot.\u003c/p\u003e" }, "storageThroughput": { "type": "integer", "description": "\u003cp\u003eSpecifies the storage throughput for the DB snapshot.\u003c/p\u003e" }, "storageType": { "type": "string", "description": "\u003cp\u003eSpecifies the storage type associated with DB snapshot.\u003c/p\u003e" }, "tagList": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "Property tagList" }, "tdeCredentialArn": { "type": "string", "description": "\u003cp\u003eThe ARN from the key store with which to associate the instance for TDE encryption.\u003c/p\u003e" }, "timezone": { "type": "string", "description": "\u003cp\u003eThe time zone of the DB snapshot. In most cases, the \u003ccode\u003eTimezone\u003c/code\u003e element is empty. \u003ccode\u003eTimezone\u003c/code\u003e content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eProvides the VPC ID associated with the DB snapshot.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRdsDBSnapshotPropertiesResponse": { "description": "Definition of awsRdsDBSnapshot", "properties": { "allocatedStorage": { "type": "integer", "description": "\u003cp\u003eSpecifies the allocated storage size in gibibytes (GiB).\u003c/p\u003e" }, "availabilityZone": { "type": "string", "description": "\u003cp\u003eSpecifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.\u003c/p\u003e" }, "dbInstanceIdentifier": { "type": "string", "description": "\u003cp\u003eSpecifies the DB instance identifier of the DB instance this DB snapshot was created from.\u003c/p\u003e" }, "dbSnapshotArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) for the DB snapshot.\u003c/p\u003e" }, "dbSnapshotIdentifier": { "type": "string", "description": "\u003cp\u003eSpecifies the identifier for the DB snapshot.\u003c/p\u003e" }, "dbSystemId": { "type": "string", "description": "\u003cp\u003eThe Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.\u003c/p\u003e" }, "dbiResourceId": { "type": "string", "description": "\u003cp\u003eThe identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.\u003c/p\u003e" }, "dedicatedLogVolume": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the DB instance has a dedicated log volume (DLV) enabled.\u003c/p\u003e" }, "encrypted": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the DB snapshot is encrypted.\u003c/p\u003e" }, "engine": { "type": "string", "description": "\u003cp\u003eSpecifies the name of the database engine.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eSpecifies the version of the database engine.\u003c/p\u003e" }, "iamDatabaseAuthenticationEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.\u003c/p\u003e" }, "instanceCreateTime": { "type": "string", "description": "\u003cp\u003eSpecifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.\u003c/p\u003e" }, "iops": { "type": "integer", "description": "\u003cp\u003eSpecifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eIf \u003ccode\u003eEncrypted\u003c/code\u003e is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.\u003c/p\u003e \u003cp\u003eThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\u003c/p\u003e" }, "licenseModel": { "type": "string", "description": "\u003cp\u003eLicense model information for the restored DB instance.\u003c/p\u003e" }, "masterUsername": { "type": "string", "description": "\u003cp\u003eProvides the master username for the DB snapshot.\u003c/p\u003e" }, "multiTenant": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).\u003c/p\u003e" }, "optionGroupName": { "type": "string", "description": "\u003cp\u003eProvides the option group name for the DB snapshot.\u003c/p\u003e" }, "originalSnapshotCreateTime": { "type": "string", "description": "\u003cp\u003eSpecifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.\u003c/p\u003e" }, "percentProgress": { "type": "integer", "description": "\u003cp\u003eThe percentage of the estimated data that has been transferred.\u003c/p\u003e" }, "port": { "type": "integer", "description": "\u003cp\u003eSpecifies the port that the database engine was listening on at the time of the snapshot.\u003c/p\u003e" }, "processorFeatures": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProcessorFeatureResponse" }, "description": "\u003cp\u003eThe number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.\u003c/p\u003e" }, "snapshotCreateTime": { "type": "string", "description": "\u003cp\u003eSpecifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.\u003c/p\u003e" }, "snapshotDatabaseTime": { "type": "string", "description": "\u003cp\u003eThe timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.\u003c/p\u003e \u003cp\u003eIf you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.\u003c/p\u003e" }, "snapshotTarget": { "type": "string", "description": "\u003cp\u003eSpecifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.\u003c/p\u003e" }, "snapshotType": { "type": "string", "description": "\u003cp\u003eProvides the type of the DB snapshot.\u003c/p\u003e" }, "sourceDBSnapshotIdentifier": { "type": "string", "description": "\u003cp\u003eThe DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.\u003c/p\u003e" }, "sourceRegion": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region that the DB snapshot was created in or copied from.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eSpecifies the status of this DB snapshot.\u003c/p\u003e" }, "storageThroughput": { "type": "integer", "description": "\u003cp\u003eSpecifies the storage throughput for the DB snapshot.\u003c/p\u003e" }, "storageType": { "type": "string", "description": "\u003cp\u003eSpecifies the storage type associated with DB snapshot.\u003c/p\u003e" }, "tagList": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "Property tagList" }, "tdeCredentialArn": { "type": "string", "description": "\u003cp\u003eThe ARN from the key store with which to associate the instance for TDE encryption.\u003c/p\u003e" }, "timezone": { "type": "string", "description": "\u003cp\u003eThe time zone of the DB snapshot. In most cases, the \u003ccode\u003eTimezone\u003c/code\u003e element is empty. \u003ccode\u003eTimezone\u003c/code\u003e content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eProvides the VPC ID associated with the DB snapshot.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRdsEventSubscriptionProperties": { "description": "Definition of awsRdsEventSubscription", "properties": { "enabled": { "type": "boolean", "description": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.", "default": true }, "eventCategories": { "type": "array", "items": { "type": "string" }, "description": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action." }, "snsTopicArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it." }, "sourceIds": { "type": "array", "items": { "type": "string" }, "description": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens." }, "sourceType": { "type": "string", "description": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned." }, "subscriptionName": { "type": "string", "description": "The name of the subscription." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsEventSubscriptionPropertiesResponse": { "description": "Definition of awsRdsEventSubscription", "properties": { "enabled": { "type": "boolean", "description": "A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.", "default": true }, "eventCategories": { "type": "array", "items": { "type": "string" }, "description": "A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action." }, "snsTopicArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it." }, "sourceIds": { "type": "array", "items": { "type": "string" }, "description": "The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens." }, "sourceType": { "type": "string", "description": "The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned." }, "subscriptionName": { "type": "string", "description": "The name of the subscription." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." } }, "type": "object" }, "azure-native:awsconnector:AwsRdsExportTaskProperties": { "description": "Definition of awsRdsExportTask", "properties": { "exportOnly": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe data exported from the snapshot or cluster.\u003c/p\u003e \u003cp\u003eValid Values:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase\u003c/code\u003e - Export all the data from a specified database.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase.table\u003c/code\u003e \u003ci\u003etable-name\u003c/i\u003e - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase.schema\u003c/code\u003e \u003ci\u003eschema-name\u003c/i\u003e - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase.schema.table\u003c/code\u003e \u003ci\u003etable-name\u003c/i\u003e - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "exportTaskIdentifier": { "type": "string", "description": "\u003cp\u003eA unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.\u003c/p\u003e" }, "failureCause": { "type": "string", "description": "\u003cp\u003eThe reason the export failed, if it failed.\u003c/p\u003e" }, "iamRoleArn": { "type": "string", "description": "\u003cp\u003eThe name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eThe key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.\u003c/p\u003e" }, "percentProgress": { "type": "integer", "description": "\u003cp\u003eThe progress of the snapshot or cluster export task as a percentage.\u003c/p\u003e" }, "s3Bucket": { "type": "string", "description": "\u003cp\u003eThe Amazon S3 bucket where the snapshot or cluster is exported to.\u003c/p\u003e" }, "s3Prefix": { "type": "string", "description": "\u003cp\u003eThe Amazon S3 bucket prefix that is the file name and path of the exported data.\u003c/p\u003e" }, "snapshotTime": { "type": "string", "description": "\u003cp\u003eThe time when the snapshot was created.\u003c/p\u003e" }, "sourceArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.\u003c/p\u003e" }, "sourceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExportSourceTypeEnumValue", "description": "\u003cp\u003eThe type of source for the export.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eThe progress status of the export task. The status can be one of the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCANCELED\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCANCELING\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCOMPLETE\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eFAILED\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eIN_PROGRESS\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSTARTING\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "taskEndTime": { "type": "string", "description": "\u003cp\u003eThe time when the snapshot or cluster export task ended.\u003c/p\u003e" }, "taskStartTime": { "type": "string", "description": "\u003cp\u003eThe time when the snapshot or cluster export task started.\u003c/p\u003e" }, "totalExtractedDataInGB": { "type": "integer", "description": "\u003cp\u003eThe total amount of data exported, in gigabytes.\u003c/p\u003e" }, "warningMessage": { "type": "string", "description": "\u003cp\u003eA warning about the snapshot or cluster export task.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRdsExportTaskPropertiesResponse": { "description": "Definition of awsRdsExportTask", "properties": { "exportOnly": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe data exported from the snapshot or cluster.\u003c/p\u003e \u003cp\u003eValid Values:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase\u003c/code\u003e - Export all the data from a specified database.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase.table\u003c/code\u003e \u003ci\u003etable-name\u003c/i\u003e - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase.schema\u003c/code\u003e \u003ci\u003eschema-name\u003c/i\u003e - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003edatabase.schema.table\u003c/code\u003e \u003ci\u003etable-name\u003c/i\u003e - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "exportTaskIdentifier": { "type": "string", "description": "\u003cp\u003eA unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.\u003c/p\u003e" }, "failureCause": { "type": "string", "description": "\u003cp\u003eThe reason the export failed, if it failed.\u003c/p\u003e" }, "iamRoleArn": { "type": "string", "description": "\u003cp\u003eThe name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eThe key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.\u003c/p\u003e" }, "percentProgress": { "type": "integer", "description": "\u003cp\u003eThe progress of the snapshot or cluster export task as a percentage.\u003c/p\u003e" }, "s3Bucket": { "type": "string", "description": "\u003cp\u003eThe Amazon S3 bucket where the snapshot or cluster is exported to.\u003c/p\u003e" }, "s3Prefix": { "type": "string", "description": "\u003cp\u003eThe Amazon S3 bucket prefix that is the file name and path of the exported data.\u003c/p\u003e" }, "snapshotTime": { "type": "string", "description": "\u003cp\u003eThe time when the snapshot was created.\u003c/p\u003e" }, "sourceArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.\u003c/p\u003e" }, "sourceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExportSourceTypeEnumValueResponse", "description": "\u003cp\u003eThe type of source for the export.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eThe progress status of the export task. The status can be one of the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCANCELED\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCANCELING\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCOMPLETE\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eFAILED\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eIN_PROGRESS\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSTARTING\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "taskEndTime": { "type": "string", "description": "\u003cp\u003eThe time when the snapshot or cluster export task ended.\u003c/p\u003e" }, "taskStartTime": { "type": "string", "description": "\u003cp\u003eThe time when the snapshot or cluster export task started.\u003c/p\u003e" }, "totalExtractedDataInGB": { "type": "integer", "description": "\u003cp\u003eThe total amount of data exported, in gigabytes.\u003c/p\u003e" }, "warningMessage": { "type": "string", "description": "\u003cp\u003eA warning about the snapshot or cluster export task.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRedshiftClusterParameterGroupProperties": { "description": "Definition of awsRedshiftClusterParameterGroup", "properties": { "description": { "type": "string", "description": "A description of the parameter group." }, "parameterGroupFamily": { "type": "string", "description": "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters." }, "parameterGroupName": { "type": "string", "description": "The name of the cluster parameter group." }, "parameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Parameter" }, "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An array of key-value pairs to apply to this resource." } }, "type": "object" }, "azure-native:awsconnector:AwsRedshiftClusterParameterGroupPropertiesResponse": { "description": "Definition of awsRedshiftClusterParameterGroup", "properties": { "description": { "type": "string", "description": "A description of the parameter group." }, "parameterGroupFamily": { "type": "string", "description": "The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters." }, "parameterGroupName": { "type": "string", "description": "The name of the cluster parameter group." }, "parameters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ParameterResponseV1" }, "description": "An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An array of key-value pairs to apply to this resource." } }, "type": "object" }, "azure-native:awsconnector:AwsRedshiftClusterProperties": { "description": "Definition of awsRedshiftCluster", "properties": { "allowVersionUpgrade": { "type": "boolean", "description": "Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True" }, "aquaConfigurationStatus": { "type": "string", "description": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.disabled - Don't use AQUA.auto - Amazon Redshift determines whether to use AQUA." }, "automatedSnapshotRetentionPeriod": { "type": "integer", "description": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1" }, "availabilityZone": { "type": "string", "description": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint" }, "availabilityZoneRelocation": { "type": "boolean", "description": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete." }, "availabilityZoneRelocationStatus": { "type": "string", "description": "The availability zone relocation status of the cluster" }, "classic": { "type": "boolean", "description": "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic." }, "clusterIdentifier": { "type": "string", "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account" }, "clusterNamespaceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the cluster namespace." }, "clusterParameterGroupName": { "type": "string", "description": "The name of the parameter group to be associated with this cluster." }, "clusterSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of security groups to be associated with this cluster." }, "clusterSubnetGroupName": { "type": "string", "description": "The name of a cluster subnet group to be associated with this cluster." }, "clusterType": { "type": "string", "description": "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required" }, "clusterVersion": { "type": "string", "description": "The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster." }, "dbName": { "type": "string", "description": "The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database." }, "deferMaintenance": { "type": "boolean", "description": "A boolean indicating whether to enable the deferred maintenance window." }, "deferMaintenanceDuration": { "type": "integer", "description": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less." }, "deferMaintenanceEndTime": { "type": "string", "description": "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration." }, "deferMaintenanceIdentifier": { "type": "string", "description": "A unique identifier for the deferred maintenance window." }, "deferMaintenanceStartTime": { "type": "string", "description": "A timestamp indicating the start time for the deferred maintenance window." }, "destinationRegion": { "type": "string", "description": "The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference" }, "elasticIp": { "type": "string", "description": "The Elastic IP (EIP) address for the cluster." }, "encrypted": { "type": "boolean", "description": "If true, the data in the cluster is encrypted at rest." }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RedshiftClusterEndpoint", "description": "Property endpoint" }, "enhancedVpcRouting": { "type": "boolean", "description": "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.If this option is true , enhanced VPC routing is enabled.Default: false" }, "hsmClientCertificateIdentifier": { "type": "string", "description": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM" }, "hsmConfigurationIdentifier": { "type": "string", "description": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM." }, "iamRoles": { "type": "array", "items": { "type": "string" }, "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request" }, "kmsKeyId": { "type": "string", "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster." }, "loggingProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingProperties", "description": "Property loggingProperties" }, "maintenanceTrackName": { "type": "string", "description": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied." }, "manageMasterPassword": { "type": "boolean", "description": "A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password." }, "manualSnapshotRetentionPeriod": { "type": "integer", "description": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.The value must be either -1 or an integer between 1 and 3,653." }, "masterPasswordSecretArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the cluster's admin user credentials secret." }, "masterPasswordSecretKmsKeyId": { "type": "string", "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret." }, "masterUserPassword": { "type": "string", "description": "The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character." }, "masterUsername": { "type": "string", "description": "The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter." }, "multiAZ": { "type": "boolean", "description": "A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az." }, "namespaceResourcePolicy": { "$ref": "pulumi.json#/Any", "description": "The namespace resource policy document that will be attached to a Redshift cluster." }, "nodeType": { "type": "string", "description": "The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge" }, "numberOfNodes": { "type": "integer", "description": "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node." }, "ownerAccount": { "type": "string", "description": "Property ownerAccount" }, "port": { "type": "integer", "description": "The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings" }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range (in UTC) during which automated cluster maintenance can occur." }, "publiclyAccessible": { "type": "boolean", "description": "If true, the cluster can be accessed from a public network." }, "resourceAction": { "type": "string", "description": "The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs" }, "revisionTarget": { "type": "string", "description": "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request." }, "rotateEncryptionKey": { "type": "boolean", "description": "A boolean indicating if we want to rotate Encryption Keys." }, "snapshotClusterIdentifier": { "type": "string", "description": "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name." }, "snapshotCopyGrantName": { "type": "string", "description": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region." }, "snapshotCopyManual": { "type": "boolean", "description": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots." }, "snapshotCopyRetentionPeriod": { "type": "integer", "description": "The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35." }, "snapshotIdentifier": { "type": "string", "description": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The list of tags for the cluster parameter group." }, "vpcSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster." } }, "type": "object" }, "azure-native:awsconnector:AwsRedshiftClusterPropertiesResponse": { "description": "Definition of awsRedshiftCluster", "properties": { "allowVersionUpgrade": { "type": "boolean", "description": "Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True" }, "aquaConfigurationStatus": { "type": "string", "description": "The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.disabled - Don't use AQUA.auto - Amazon Redshift determines whether to use AQUA." }, "automatedSnapshotRetentionPeriod": { "type": "integer", "description": "The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1" }, "availabilityZone": { "type": "string", "description": "The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint" }, "availabilityZoneRelocation": { "type": "boolean", "description": "The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete." }, "availabilityZoneRelocationStatus": { "type": "string", "description": "The availability zone relocation status of the cluster" }, "classic": { "type": "boolean", "description": "A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic." }, "clusterIdentifier": { "type": "string", "description": "A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account" }, "clusterNamespaceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the cluster namespace." }, "clusterParameterGroupName": { "type": "string", "description": "The name of the parameter group to be associated with this cluster." }, "clusterSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of security groups to be associated with this cluster." }, "clusterSubnetGroupName": { "type": "string", "description": "The name of a cluster subnet group to be associated with this cluster." }, "clusterType": { "type": "string", "description": "The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required" }, "clusterVersion": { "type": "string", "description": "The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster." }, "dbName": { "type": "string", "description": "The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database." }, "deferMaintenance": { "type": "boolean", "description": "A boolean indicating whether to enable the deferred maintenance window." }, "deferMaintenanceDuration": { "type": "integer", "description": "An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less." }, "deferMaintenanceEndTime": { "type": "string", "description": "A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration." }, "deferMaintenanceIdentifier": { "type": "string", "description": "A unique identifier for the deferred maintenance window." }, "deferMaintenanceStartTime": { "type": "string", "description": "A timestamp indicating the start time for the deferred maintenance window." }, "destinationRegion": { "type": "string", "description": "The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference" }, "elasticIp": { "type": "string", "description": "The Elastic IP (EIP) address for the cluster." }, "encrypted": { "type": "boolean", "description": "If true, the data in the cluster is encrypted at rest." }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RedshiftClusterEndpointResponse", "description": "Property endpoint" }, "enhancedVpcRouting": { "type": "boolean", "description": "An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.If this option is true , enhanced VPC routing is enabled.Default: false" }, "hsmClientCertificateIdentifier": { "type": "string", "description": "Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM" }, "hsmConfigurationIdentifier": { "type": "string", "description": "Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM." }, "iamRoles": { "type": "array", "items": { "type": "string" }, "description": "A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request" }, "kmsKeyId": { "type": "string", "description": "The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster." }, "loggingProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingPropertiesResponse", "description": "Property loggingProperties" }, "maintenanceTrackName": { "type": "string", "description": "The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied." }, "manageMasterPassword": { "type": "boolean", "description": "A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password." }, "manualSnapshotRetentionPeriod": { "type": "integer", "description": "The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.The value must be either -1 or an integer between 1 and 3,653." }, "masterPasswordSecretArn": { "type": "string", "description": "The Amazon Resource Name (ARN) for the cluster's admin user credentials secret." }, "masterPasswordSecretKmsKeyId": { "type": "string", "description": "The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret." }, "masterUserPassword": { "type": "string", "description": "The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character." }, "masterUsername": { "type": "string", "description": "The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter." }, "multiAZ": { "type": "boolean", "description": "A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az." }, "namespaceResourcePolicy": { "$ref": "pulumi.json#/Any", "description": "The namespace resource policy document that will be attached to a Redshift cluster." }, "nodeType": { "type": "string", "description": "The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge" }, "numberOfNodes": { "type": "integer", "description": "The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node." }, "ownerAccount": { "type": "string", "description": "Property ownerAccount" }, "port": { "type": "integer", "description": "The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings" }, "preferredMaintenanceWindow": { "type": "string", "description": "The weekly time range (in UTC) during which automated cluster maintenance can occur." }, "publiclyAccessible": { "type": "boolean", "description": "If true, the cluster can be accessed from a public network." }, "resourceAction": { "type": "string", "description": "The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs" }, "revisionTarget": { "type": "string", "description": "The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request." }, "rotateEncryptionKey": { "type": "boolean", "description": "A boolean indicating if we want to rotate Encryption Keys." }, "snapshotClusterIdentifier": { "type": "string", "description": "The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name." }, "snapshotCopyGrantName": { "type": "string", "description": "The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region." }, "snapshotCopyManual": { "type": "boolean", "description": "Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots." }, "snapshotCopyRetentionPeriod": { "type": "integer", "description": "The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35." }, "snapshotIdentifier": { "type": "string", "description": "The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The list of tags for the cluster parameter group." }, "vpcSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster." } }, "type": "object" }, "azure-native:awsconnector:AwsRoute53DomainsDomainSummaryProperties": { "description": "Definition of awsRoute53DomainsDomainSummary", "properties": { "autoRenew": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the domain is automatically renewed upon expiration.\u003c/p\u003e" }, "domainName": { "type": "string", "description": "\u003cp\u003eThe name of the domain that the summary information applies to.\u003c/p\u003e" }, "expiry": { "type": "string", "description": "\u003cp\u003eExpiration date of the domain in Unix time format and Coordinated Universal Time (UTC).\u003c/p\u003e" }, "transferLock": { "type": "boolean", "description": "\u003cp\u003eIndicates whether a domain is locked from unauthorized transfer to another party.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRoute53DomainsDomainSummaryPropertiesResponse": { "description": "Definition of awsRoute53DomainsDomainSummary", "properties": { "autoRenew": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the domain is automatically renewed upon expiration.\u003c/p\u003e" }, "domainName": { "type": "string", "description": "\u003cp\u003eThe name of the domain that the summary information applies to.\u003c/p\u003e" }, "expiry": { "type": "string", "description": "\u003cp\u003eExpiration date of the domain in Unix time format and Coordinated Universal Time (UTC).\u003c/p\u003e" }, "transferLock": { "type": "boolean", "description": "\u003cp\u003eIndicates whether a domain is locked from unauthorized transfer to another party.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRoute53HostedZoneProperties": { "description": "Definition of awsRoute53HostedZone", "properties": { "hostedZoneConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostedZoneConfig", "description": "A complex type that contains an optional comment. If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements." }, "hostedZoneTags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostedZoneTag" }, "description": "Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*." }, "id": { "type": "string", "description": "Property id" }, "name": { "type": "string", "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function." }, "nameServers": { "type": "array", "items": { "type": "string" }, "description": "Property nameServers" }, "queryLoggingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:QueryLoggingConfig", "description": "Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + Route 53 edge location that responded to the DNS query + Domain or subdomain that was requested + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see 'The Route 53 Global Network' on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. A complex type that contains information about a configuration for DNS query logging." }, "vpCs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VPC" }, "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." } }, "type": "object" }, "azure-native:awsconnector:AwsRoute53HostedZonePropertiesResponse": { "description": "Definition of awsRoute53HostedZone", "properties": { "hostedZoneConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostedZoneConfigResponse", "description": "A complex type that contains an optional comment. If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements." }, "hostedZoneTags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostedZoneTagResponse" }, "description": "Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*." }, "id": { "type": "string", "description": "Property id" }, "name": { "type": "string", "description": "The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function." }, "nameServers": { "type": "array", "items": { "type": "string" }, "description": "Property nameServers" }, "queryLoggingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:QueryLoggingConfigResponse", "description": "Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + Route 53 edge location that responded to the DNS query + Domain or subdomain that was requested + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see 'The Route 53 Global Network' on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. A complex type that contains information about a configuration for DNS query logging." }, "vpCs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VPCResponse" }, "description": "*Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``." } }, "type": "object" }, "azure-native:awsconnector:AwsRoute53ResourceRecordSetProperties": { "description": "Definition of awsRoute53ResourceRecordSet", "properties": { "aliasTarget": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AliasTarget", "description": "\u003cp\u003e \u003ci\u003eAlias resource record sets only:\u003c/i\u003e Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. \u003c/p\u003e \u003cp\u003eIf you're creating resource records sets for a private hosted zone, note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor information about creating failover resource record sets in a private hosted zone, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'\u003eConfiguring Failover in a Private Hosted Zone\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "cidrRoutingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CidrRoutingConfig", "description": "Property cidrRoutingConfig" }, "failover": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRecordSetFailoverEnumValue", "description": "\u003cp\u003e \u003ci\u003eFailover resource record sets only:\u003c/i\u003e To configure failover, you add the \u003ccode\u003eFailover\u003c/code\u003e element to two resource record sets. For one resource record set, you specify \u003ccode\u003ePRIMARY\u003c/code\u003e as the value for \u003ccode\u003eFailover\u003c/code\u003e; for the other resource record set, you specify \u003ccode\u003eSECONDARY\u003c/code\u003e. In addition, you include the \u003ccode\u003eHealthCheckId\u003c/code\u003e element and specify the health check that you want Amazon Route 53 to perform for each resource record set.\u003c/p\u003e \u003cp\u003eExcept where noted, the following failover behaviors assume that you have included the \u003ccode\u003eHealthCheckId\u003c/code\u003e element in both resource record sets:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eWhen the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eWhen the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eWhen the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you omit the \u003ccode\u003eHealthCheckId\u003c/code\u003e element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eYou can't create non-failover resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as failover resource record sets.\u003c/p\u003e \u003cp\u003eFor failover alias resource record sets, you must also include the \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e element and set the value to true.\u003c/p\u003e \u003cp\u003eFor more information about configuring failover for Route 53, see the following topics in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'\u003eRoute 53 Health Checks and DNS Failover\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'\u003eConfiguring Failover in a Private Hosted Zone\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "geoLocation": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GeoLocation", "description": "\u003cp\u003e \u003ci\u003eGeolocation resource record sets only:\u003c/i\u003e A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of \u003ccode\u003e192.0.2.111\u003c/code\u003e, create a resource record set with a \u003ccode\u003eType\u003c/code\u003e of \u003ccode\u003eA\u003c/code\u003e and a \u003ccode\u003eContinentCode\u003c/code\u003e of \u003ccode\u003eAF\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eIf you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.\u003c/p\u003e \u003cp\u003eYou can't create two geolocation resource record sets that specify the same geographic location.\u003c/p\u003e \u003cp\u003eThe value \u003ccode\u003e*\u003c/code\u003e in the \u003ccode\u003eCountryCode\u003c/code\u003e element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eGeolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of \u003ccode\u003eCountryCode\u003c/code\u003e is \u003ccode\u003e*\u003c/code\u003e. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a \u003ccode\u003e*\u003c/code\u003e resource record set, Route 53 returns a 'no answer' response for queries from those locations.\u003c/p\u003e \u003c/important\u003e \u003cp\u003eYou can't create non-geolocation resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as geolocation resource record sets.\u003c/p\u003e" }, "geoProximityLocation": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GeoProximityLocation", "description": "\u003cp\u003e \u003ci\u003e GeoproximityLocation resource record sets only:\u003c/i\u003e A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. \u003c/p\u003e" }, "healthCheckId": { "type": "string", "description": "\u003cp\u003eIf you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the \u003ccode\u003eHealthCheckId\u003c/code\u003e element and specify the ID of the applicable health check.\u003c/p\u003e \u003cp\u003eRoute 53 determines whether a resource record set is healthy based on one of the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eBy periodically sending a request to the endpoint that is specified in the health check\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eBy aggregating the status of a specified group of health checks (calculated health checks)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eBy determining the current state of a CloudWatch alarm (CloudWatch metric health checks)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cimportant\u003e \u003cp\u003eRoute 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the \u003ccode\u003eValue\u003c/code\u003e element. When you add a \u003ccode\u003eHealthCheckId\u003c/code\u003e element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. \u003c/p\u003e \u003c/important\u003e \u003cp\u003eFor more information, see the following topics in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html'\u003eHow Amazon Route 53 Determines Whether an Endpoint Is Healthy\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'\u003eRoute 53 Health Checks and DNS Failover\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'\u003eConfiguring Failover in a Private Hosted Zone\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e \u003cb\u003eWhen to Specify HealthCheckId\u003c/b\u003e \u003c/p\u003e \u003cp\u003eSpecifying a value for \u003ccode\u003eHealthCheckId\u003c/code\u003e is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eNon-alias resource record sets\u003c/b\u003e: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. \u003c/p\u003e \u003cp\u003eIf the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.\u003c/p\u003e \u003cp\u003eIf the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.\u003c/p\u003e \u003cp\u003eIf the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAlias resource record sets\u003c/b\u003e: You specify the following settings:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou specify a health check ID for the non-alias resource record set. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eIf the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.\u003c/p\u003e \u003cp\u003eIf the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe alias resource record set can also route traffic to a \u003ci\u003egroup\u003c/i\u003e of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.\u003c/p\u003e \u003c/note\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e \u003cb\u003eGeolocation Routing\u003c/b\u003e \u003c/p\u003e \u003cp\u003eFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has \u003ccode\u003e*\u003c/code\u003e for \u003ccode\u003eCountryCode\u003c/code\u003e is \u003ccode\u003e*\u003c/code\u003e, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe United States\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eNorth America\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe default resource record set\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e \u003cb\u003eSpecifying the Health Check Endpoint by Domain Name\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each \u003ccode\u003eHTTP\u003c/code\u003e server that is serving content for \u003ccode\u003ewww.example.com\u003c/code\u003e. For the value of \u003ccode\u003eFullyQualifiedDomainName\u003c/code\u003e, specify the domain name of the server (such as \u003ccode\u003eus-east-2-www.example.com\u003c/code\u003e), not the name of the resource record sets (\u003ccode\u003ewww.example.com\u003c/code\u003e).\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eHealth check results will be unpredictable if you do the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eCreate a health check that has the same value for \u003ccode\u003eFullyQualifiedDomainName\u003c/code\u003e as the name of a resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAssociate that health check with the resource record set.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/important\u003e" }, "multiValueAnswer": { "type": "boolean", "description": "\u003cp\u003e \u003ci\u003eMultivalue answer resource record sets only\u003c/i\u003e: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify \u003ccode\u003etrue\u003c/code\u003e for \u003ccode\u003eMultiValueAnswer\u003c/code\u003e. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eRoute 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eWhen all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eYou can't create multivalue answer alias records.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eFor \u003ccode\u003eChangeResourceRecordSets\u003c/code\u003e requests, the name of the record that you want to create, update, or delete. For \u003ccode\u003eListResourceRecordSets\u003c/code\u003e responses, the name of a record in the specified hosted zone.\u003c/p\u003e \u003cp\u003e \u003cb\u003eChangeResourceRecordSets Only\u003c/b\u003e \u003c/p\u003e \u003cp\u003eEnter a fully qualified domain name, for example, \u003ccode\u003ewww.example.com\u003c/code\u003e. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats \u003ccode\u003ewww.example.com\u003c/code\u003e (without a trailing dot) and \u003ccode\u003ewww.example.com.\u003c/code\u003e (with a trailing dot) as identical.\u003c/p\u003e \u003cp\u003eFor information about how to specify characters other than \u003ccode\u003ea-z\u003c/code\u003e, \u003ccode\u003e0-9\u003c/code\u003e, and \u003ccode\u003e-\u003c/code\u003e (hyphen) and how to specify internationalized domain names, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html'\u003eDNS Domain Name Format\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eYou can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, \u003ccode\u003e*.example.com\u003c/code\u003e. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe * must replace the entire label. For example, you can't specify \u003ccode\u003e*prod.example.com\u003c/code\u003e or \u003ccode\u003eprod*.example.com\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe * can't replace any of the middle labels, for example, marketing.*.example.com.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eYou can't use the * wildcard for resource records sets that have a type of NS.\u003c/p\u003e \u003c/important\u003e \u003c/li\u003e \u003c/ul\u003e" }, "region": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRecordSetRegionEnumValue", "description": "\u003cp\u003e \u003ci\u003eLatency-based resource record sets only:\u003c/i\u003e The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.\u003c/p\u003e \u003cp\u003eWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.\u003c/p\u003e \u003cp\u003eNote the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou can only specify one \u003ccode\u003eResourceRecord\u003c/code\u003e per latency resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can only create one latency resource record set for each Amazon EC2 Region.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can't create non-latency resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as latency resource record sets.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "resourceRecords": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRecord" }, "description": "\u003cp\u003eInformation about the resource records to act upon.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias resource record set, omit \u003ccode\u003eResourceRecords\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e" }, "setIdentifier": { "type": "string", "description": "\u003cp\u003e \u003ci\u003eResource record sets that have a routing policy other than simple:\u003c/i\u003e An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of \u003ccode\u003eSetIdentifier\u003c/code\u003e must be unique for each resource record set. \u003c/p\u003e \u003cp\u003eFor information about routing policies, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html'\u003eChoosing a Routing Policy\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e" }, "trafficPolicyInstanceId": { "type": "string", "description": "\u003cp\u003eWhen you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. \u003ccode\u003eTrafficPolicyInstanceId\u003c/code\u003e is the ID of the traffic policy instance that Route 53 created this resource record set for.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eTo delete the resource record set that is associated with a traffic policy instance, use \u003ccode\u003eDeleteTrafficPolicyInstance\u003c/code\u003e. Route 53 will delete the resource record set automatically. If you delete the resource record set by using \u003ccode\u003eChangeResourceRecordSets\u003c/code\u003e, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. \u003c/p\u003e \u003c/important\u003e" }, "ttl": { "type": "number", "description": "\u003cp\u003eThe resource record cache time to live (TTL), in seconds. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you're creating or updating an alias resource record set, omit \u003ccode\u003eTTL\u003c/code\u003e. Amazon Route 53 uses the value of \u003ccode\u003eTTL\u003c/code\u003e for the alias target. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you're associating this resource record set with a health check (if you're adding a \u003ccode\u003eHealthCheckId\u003c/code\u003e element), we recommend that you specify a \u003ccode\u003eTTL\u003c/code\u003e of 60 seconds or less so clients respond quickly to changes in health status.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAll of the resource record sets in a group of weighted resource record sets must have the same value for \u003ccode\u003eTTL\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a \u003ccode\u003eTTL\u003c/code\u003e of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for \u003ccode\u003eWeight\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RRTypeEnumValue", "description": "\u003cp\u003eThe DNS record type. For information about different record types and how data is encoded for them, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'\u003eSupported DNS Resource Record Types\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eValid values for basic resource record sets: \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e | \u003ccode\u003eCAA\u003c/code\u003e | \u003ccode\u003eCNAME\u003c/code\u003e | \u003ccode\u003eDS\u003c/code\u003e |\u003ccode\u003eMX\u003c/code\u003e | \u003ccode\u003eNAPTR\u003c/code\u003e | \u003ccode\u003eNS\u003c/code\u003e | \u003ccode\u003ePTR\u003c/code\u003e | \u003ccode\u003eSOA\u003c/code\u003e | \u003ccode\u003eSPF\u003c/code\u003e | \u003ccode\u003eSRV\u003c/code\u003e | \u003ccode\u003eTXT\u003c/code\u003e \u003c/p\u003e \u003cp\u003eValues for weighted, latency, geolocation, and failover resource record sets: \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e | \u003ccode\u003eCAA\u003c/code\u003e | \u003ccode\u003eCNAME\u003c/code\u003e | \u003ccode\u003eMX\u003c/code\u003e | \u003ccode\u003eNAPTR\u003c/code\u003e | \u003ccode\u003ePTR\u003c/code\u003e | \u003ccode\u003eSPF\u003c/code\u003e | \u003ccode\u003eSRV\u003c/code\u003e | \u003ccode\u003eTXT\u003c/code\u003e. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.\u003c/p\u003e \u003cp\u003eValid values for multivalue answer resource record sets: \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e | \u003ccode\u003eMX\u003c/code\u003e | \u003ccode\u003eNAPTR\u003c/code\u003e | \u003ccode\u003ePTR\u003c/code\u003e | \u003ccode\u003eSPF\u003c/code\u003e | \u003ccode\u003eSRV\u003c/code\u003e | \u003ccode\u003eTXT\u003c/code\u003e \u003c/p\u003e \u003cnote\u003e \u003cp\u003eSPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of \u003ccode\u003eType\u003c/code\u003e is \u003ccode\u003eSPF\u003c/code\u003e. RFC 7208, \u003ci\u003eSender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1\u003c/i\u003e, has been updated to say, '...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.' In RFC 7208, see section 14.1, \u003ca href='http://tools.ietf.org/html/rfc7208#section-14.1'\u003eThe SPF DNS Record Type\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eValues for alias resource record sets:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon API Gateway custom regional APIs and edge-optimized APIs:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCloudFront distributions:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003cp\u003eIf IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of \u003ccode\u003eA\u003c/code\u003e and one with a value of \u003ccode\u003eAAAA\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon API Gateway environment that has a regionalized subdomain\u003c/b\u003e: \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eELB load balancers:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon S3 buckets:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon Virtual Private Cloud interface VPC endpoints\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAnother resource record set in this hosted zone:\u003c/b\u003e Specify the type of the resource record set that you're creating the alias for. All values are supported except \u003ccode\u003eNS\u003c/code\u003e and \u003ccode\u003eSOA\u003c/code\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of \u003ccode\u003eType\u003c/code\u003e is \u003ccode\u003eCNAME\u003c/code\u003e. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.\u003c/p\u003e \u003c/note\u003e \u003c/li\u003e \u003c/ul\u003e" }, "weight": { "type": "number", "description": "\u003cp\u003e \u003ci\u003eWeighted resource record sets only:\u003c/i\u003e Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou must specify a value for the \u003ccode\u003eWeight\u003c/code\u003e element for every weighted resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can only specify one \u003ccode\u003eResourceRecord\u003c/code\u003e per weighted resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can't create latency, failover, or geolocation resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as weighted resource record sets.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can create a maximum of 100 weighted resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor weighted (but not weighted alias) resource record sets, if you set \u003ccode\u003eWeight\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set \u003ccode\u003eWeight\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.\u003c/p\u003e \u003cp\u003eThe effect of setting \u003ccode\u003eWeight\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e is different when you associate health checks with weighted resource record sets. For more information, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html'\u003eOptions for Configuring Route 53 Active-Active and Active-Passive Failover\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsRoute53ResourceRecordSetPropertiesResponse": { "description": "Definition of awsRoute53ResourceRecordSet", "properties": { "aliasTarget": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AliasTargetResponse", "description": "\u003cp\u003e \u003ci\u003eAlias resource record sets only:\u003c/i\u003e Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to. \u003c/p\u003e \u003cp\u003eIf you're creating resource records sets for a private hosted zone, note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor information about creating failover resource record sets in a private hosted zone, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'\u003eConfiguring Failover in a Private Hosted Zone\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "cidrRoutingConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CidrRoutingConfigResponse", "description": "Property cidrRoutingConfig" }, "failover": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRecordSetFailoverEnumValueResponse", "description": "\u003cp\u003e \u003ci\u003eFailover resource record sets only:\u003c/i\u003e To configure failover, you add the \u003ccode\u003eFailover\u003c/code\u003e element to two resource record sets. For one resource record set, you specify \u003ccode\u003ePRIMARY\u003c/code\u003e as the value for \u003ccode\u003eFailover\u003c/code\u003e; for the other resource record set, you specify \u003ccode\u003eSECONDARY\u003c/code\u003e. In addition, you include the \u003ccode\u003eHealthCheckId\u003c/code\u003e element and specify the health check that you want Amazon Route 53 to perform for each resource record set.\u003c/p\u003e \u003cp\u003eExcept where noted, the following failover behaviors assume that you have included the \u003ccode\u003eHealthCheckId\u003c/code\u003e element in both resource record sets:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eWhen the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eWhen the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eWhen the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you omit the \u003ccode\u003eHealthCheckId\u003c/code\u003e element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eYou can't create non-failover resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as failover resource record sets.\u003c/p\u003e \u003cp\u003eFor failover alias resource record sets, you must also include the \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e element and set the value to true.\u003c/p\u003e \u003cp\u003eFor more information about configuring failover for Route 53, see the following topics in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'\u003eRoute 53 Health Checks and DNS Failover\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'\u003eConfiguring Failover in a Private Hosted Zone\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "geoLocation": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GeoLocationResponse", "description": "\u003cp\u003e \u003ci\u003eGeolocation resource record sets only:\u003c/i\u003e A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of \u003ccode\u003e192.0.2.111\u003c/code\u003e, create a resource record set with a \u003ccode\u003eType\u003c/code\u003e of \u003ccode\u003eA\u003c/code\u003e and a \u003ccode\u003eContinentCode\u003c/code\u003e of \u003ccode\u003eAF\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eIf you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.\u003c/p\u003e \u003cp\u003eYou can't create two geolocation resource record sets that specify the same geographic location.\u003c/p\u003e \u003cp\u003eThe value \u003ccode\u003e*\u003c/code\u003e in the \u003ccode\u003eCountryCode\u003c/code\u003e element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eGeolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of \u003ccode\u003eCountryCode\u003c/code\u003e is \u003ccode\u003e*\u003c/code\u003e. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a \u003ccode\u003e*\u003c/code\u003e resource record set, Route 53 returns a 'no answer' response for queries from those locations.\u003c/p\u003e \u003c/important\u003e \u003cp\u003eYou can't create non-geolocation resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as geolocation resource record sets.\u003c/p\u003e" }, "geoProximityLocation": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GeoProximityLocationResponse", "description": "\u003cp\u003e \u003ci\u003e GeoproximityLocation resource record sets only:\u003c/i\u003e A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources. \u003c/p\u003e" }, "healthCheckId": { "type": "string", "description": "\u003cp\u003eIf you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the \u003ccode\u003eHealthCheckId\u003c/code\u003e element and specify the ID of the applicable health check.\u003c/p\u003e \u003cp\u003eRoute 53 determines whether a resource record set is healthy based on one of the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eBy periodically sending a request to the endpoint that is specified in the health check\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eBy aggregating the status of a specified group of health checks (calculated health checks)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eBy determining the current state of a CloudWatch alarm (CloudWatch metric health checks)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cimportant\u003e \u003cp\u003eRoute 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the \u003ccode\u003eValue\u003c/code\u003e element. When you add a \u003ccode\u003eHealthCheckId\u003c/code\u003e element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check. \u003c/p\u003e \u003c/important\u003e \u003cp\u003eFor more information, see the following topics in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html'\u003eHow Amazon Route 53 Determines Whether an Endpoint Is Healthy\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover.html'\u003eRoute 53 Health Checks and DNS Failover\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-private-hosted-zones.html'\u003eConfiguring Failover in a Private Hosted Zone\u003c/a\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e \u003cb\u003eWhen to Specify HealthCheckId\u003c/b\u003e \u003c/p\u003e \u003cp\u003eSpecifying a value for \u003ccode\u003eHealthCheckId\u003c/code\u003e is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eNon-alias resource record sets\u003c/b\u003e: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets. \u003c/p\u003e \u003cp\u003eIf the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.\u003c/p\u003e \u003cp\u003eIf the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.\u003c/p\u003e \u003cp\u003eIf the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAlias resource record sets\u003c/b\u003e: You specify the following settings:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou set \u003ccode\u003eEvaluateTargetHealth\u003c/code\u003e to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou specify a health check ID for the non-alias resource record set. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eIf the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.\u003c/p\u003e \u003cp\u003eIf the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe alias resource record set can also route traffic to a \u003ci\u003egroup\u003c/i\u003e of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.\u003c/p\u003e \u003c/note\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e \u003cb\u003eGeolocation Routing\u003c/b\u003e \u003c/p\u003e \u003cp\u003eFor geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has \u003ccode\u003e*\u003c/code\u003e for \u003ccode\u003eCountryCode\u003c/code\u003e is \u003ccode\u003e*\u003c/code\u003e, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe United States\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eNorth America\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe default resource record set\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e \u003cb\u003eSpecifying the Health Check Endpoint by Domain Name\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each \u003ccode\u003eHTTP\u003c/code\u003e server that is serving content for \u003ccode\u003ewww.example.com\u003c/code\u003e. For the value of \u003ccode\u003eFullyQualifiedDomainName\u003c/code\u003e, specify the domain name of the server (such as \u003ccode\u003eus-east-2-www.example.com\u003c/code\u003e), not the name of the resource record sets (\u003ccode\u003ewww.example.com\u003c/code\u003e).\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eHealth check results will be unpredictable if you do the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eCreate a health check that has the same value for \u003ccode\u003eFullyQualifiedDomainName\u003c/code\u003e as the name of a resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAssociate that health check with the resource record set.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/important\u003e" }, "multiValueAnswer": { "type": "boolean", "description": "\u003cp\u003e \u003ci\u003eMultivalue answer resource record sets only\u003c/i\u003e: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify \u003ccode\u003etrue\u003c/code\u003e for \u003ccode\u003eMultiValueAnswer\u003c/code\u003e. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eRoute 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eWhen all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eYou can't create multivalue answer alias records.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eFor \u003ccode\u003eChangeResourceRecordSets\u003c/code\u003e requests, the name of the record that you want to create, update, or delete. For \u003ccode\u003eListResourceRecordSets\u003c/code\u003e responses, the name of a record in the specified hosted zone.\u003c/p\u003e \u003cp\u003e \u003cb\u003eChangeResourceRecordSets Only\u003c/b\u003e \u003c/p\u003e \u003cp\u003eEnter a fully qualified domain name, for example, \u003ccode\u003ewww.example.com\u003c/code\u003e. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats \u003ccode\u003ewww.example.com\u003c/code\u003e (without a trailing dot) and \u003ccode\u003ewww.example.com.\u003c/code\u003e (with a trailing dot) as identical.\u003c/p\u003e \u003cp\u003eFor information about how to specify characters other than \u003ccode\u003ea-z\u003c/code\u003e, \u003ccode\u003e0-9\u003c/code\u003e, and \u003ccode\u003e-\u003c/code\u003e (hyphen) and how to specify internationalized domain names, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html'\u003eDNS Domain Name Format\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eYou can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, \u003ccode\u003e*.example.com\u003c/code\u003e. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe * must replace the entire label. For example, you can't specify \u003ccode\u003e*prod.example.com\u003c/code\u003e or \u003ccode\u003eprod*.example.com\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe * can't replace any of the middle labels, for example, marketing.*.example.com.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eYou can't use the * wildcard for resource records sets that have a type of NS.\u003c/p\u003e \u003c/important\u003e \u003c/li\u003e \u003c/ul\u003e" }, "region": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRecordSetRegionEnumValueResponse", "description": "\u003cp\u003e \u003ci\u003eLatency-based resource record sets only:\u003c/i\u003e The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.\u003c/p\u003e \u003cp\u003eWhen Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.\u003c/p\u003e \u003cp\u003eNote the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou can only specify one \u003ccode\u003eResourceRecord\u003c/code\u003e per latency resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can only create one latency resource record set for each Amazon EC2 Region.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can't create non-latency resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as latency resource record sets.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "resourceRecords": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRecordResponse" }, "description": "\u003cp\u003eInformation about the resource records to act upon.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias resource record set, omit \u003ccode\u003eResourceRecords\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e" }, "setIdentifier": { "type": "string", "description": "\u003cp\u003e \u003ci\u003eResource record sets that have a routing policy other than simple:\u003c/i\u003e An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of \u003ccode\u003eSetIdentifier\u003c/code\u003e must be unique for each resource record set. \u003c/p\u003e \u003cp\u003eFor information about routing policies, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html'\u003eChoosing a Routing Policy\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e" }, "trafficPolicyInstanceId": { "type": "string", "description": "\u003cp\u003eWhen you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. \u003ccode\u003eTrafficPolicyInstanceId\u003c/code\u003e is the ID of the traffic policy instance that Route 53 created this resource record set for.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eTo delete the resource record set that is associated with a traffic policy instance, use \u003ccode\u003eDeleteTrafficPolicyInstance\u003c/code\u003e. Route 53 will delete the resource record set automatically. If you delete the resource record set by using \u003ccode\u003eChangeResourceRecordSets\u003c/code\u003e, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use. \u003c/p\u003e \u003c/important\u003e" }, "ttl": { "type": "number", "description": "\u003cp\u003eThe resource record cache time to live (TTL), in seconds. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you're creating or updating an alias resource record set, omit \u003ccode\u003eTTL\u003c/code\u003e. Amazon Route 53 uses the value of \u003ccode\u003eTTL\u003c/code\u003e for the alias target. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you're associating this resource record set with a health check (if you're adding a \u003ccode\u003eHealthCheckId\u003c/code\u003e element), we recommend that you specify a \u003ccode\u003eTTL\u003c/code\u003e of 60 seconds or less so clients respond quickly to changes in health status.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAll of the resource record sets in a group of weighted resource record sets must have the same value for \u003ccode\u003eTTL\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a \u003ccode\u003eTTL\u003c/code\u003e of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for \u003ccode\u003eWeight\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RRTypeEnumValueResponse", "description": "\u003cp\u003eThe DNS record type. For information about different record types and how data is encoded for them, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'\u003eSupported DNS Resource Record Types\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eValid values for basic resource record sets: \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e | \u003ccode\u003eCAA\u003c/code\u003e | \u003ccode\u003eCNAME\u003c/code\u003e | \u003ccode\u003eDS\u003c/code\u003e |\u003ccode\u003eMX\u003c/code\u003e | \u003ccode\u003eNAPTR\u003c/code\u003e | \u003ccode\u003eNS\u003c/code\u003e | \u003ccode\u003ePTR\u003c/code\u003e | \u003ccode\u003eSOA\u003c/code\u003e | \u003ccode\u003eSPF\u003c/code\u003e | \u003ccode\u003eSRV\u003c/code\u003e | \u003ccode\u003eTXT\u003c/code\u003e \u003c/p\u003e \u003cp\u003eValues for weighted, latency, geolocation, and failover resource record sets: \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e | \u003ccode\u003eCAA\u003c/code\u003e | \u003ccode\u003eCNAME\u003c/code\u003e | \u003ccode\u003eMX\u003c/code\u003e | \u003ccode\u003eNAPTR\u003c/code\u003e | \u003ccode\u003ePTR\u003c/code\u003e | \u003ccode\u003eSPF\u003c/code\u003e | \u003ccode\u003eSRV\u003c/code\u003e | \u003ccode\u003eTXT\u003c/code\u003e. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.\u003c/p\u003e \u003cp\u003eValid values for multivalue answer resource record sets: \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e | \u003ccode\u003eMX\u003c/code\u003e | \u003ccode\u003eNAPTR\u003c/code\u003e | \u003ccode\u003ePTR\u003c/code\u003e | \u003ccode\u003eSPF\u003c/code\u003e | \u003ccode\u003eSRV\u003c/code\u003e | \u003ccode\u003eTXT\u003c/code\u003e \u003c/p\u003e \u003cnote\u003e \u003cp\u003eSPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of \u003ccode\u003eType\u003c/code\u003e is \u003ccode\u003eSPF\u003c/code\u003e. RFC 7208, \u003ci\u003eSender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1\u003c/i\u003e, has been updated to say, '...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.' In RFC 7208, see section 14.1, \u003ca href='http://tools.ietf.org/html/rfc7208#section-14.1'\u003eThe SPF DNS Record Type\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eValues for alias resource record sets:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon API Gateway custom regional APIs and edge-optimized APIs:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eCloudFront distributions:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003cp\u003eIf IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of \u003ccode\u003eA\u003c/code\u003e and one with a value of \u003ccode\u003eAAAA\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon API Gateway environment that has a regionalized subdomain\u003c/b\u003e: \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eELB load balancers:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e | \u003ccode\u003eAAAA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon S3 buckets:\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAmazon Virtual Private Cloud interface VPC endpoints\u003c/b\u003e \u003ccode\u003eA\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAnother resource record set in this hosted zone:\u003c/b\u003e Specify the type of the resource record set that you're creating the alias for. All values are supported except \u003ccode\u003eNS\u003c/code\u003e and \u003ccode\u003eSOA\u003c/code\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of \u003ccode\u003eType\u003c/code\u003e is \u003ccode\u003eCNAME\u003c/code\u003e. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.\u003c/p\u003e \u003c/note\u003e \u003c/li\u003e \u003c/ul\u003e" }, "weight": { "type": "number", "description": "\u003cp\u003e \u003ci\u003eWeighted resource record sets only:\u003c/i\u003e Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou must specify a value for the \u003ccode\u003eWeight\u003c/code\u003e element for every weighted resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can only specify one \u003ccode\u003eResourceRecord\u003c/code\u003e per weighted resource record set.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can't create latency, failover, or geolocation resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements as weighted resource record sets.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou can create a maximum of 100 weighted resource record sets that have the same values for the \u003ccode\u003eName\u003c/code\u003e and \u003ccode\u003eType\u003c/code\u003e elements.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor weighted (but not weighted alias) resource record sets, if you set \u003ccode\u003eWeight\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set \u003ccode\u003eWeight\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.\u003c/p\u003e \u003cp\u003eThe effect of setting \u003ccode\u003eWeight\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e is different when you associate health checks with weighted resource record sets. For more information, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-configuring-options.html'\u003eOptions for Configuring Route 53 Active-Active and Active-Passive Failover\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsS3AccessControlPolicyProperties": { "description": "Definition of awsS3AccessControlPolicy", "properties": { "grants": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Grant" }, "description": "\u003cp\u003eA list of grants.\u003c/p\u003e" }, "owner": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Owner", "description": "\u003cp\u003eContainer for the bucket owner's display name and ID.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsS3AccessControlPolicyPropertiesResponse": { "description": "Definition of awsS3AccessControlPolicy", "properties": { "grants": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GrantResponse" }, "description": "\u003cp\u003eA list of grants.\u003c/p\u003e" }, "owner": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OwnerResponse", "description": "\u003cp\u003eContainer for the bucket owner's display name and ID.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsS3AccessPointProperties": { "description": "Definition of awsS3AccessPoint", "properties": { "alias": { "type": "string", "description": "The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications." }, "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the specified accesspoint. the Amazon Resource Name (ARN) of the specified accesspoint." }, "bucket": { "type": "string", "description": "The name of the bucket that you want to associate this Access Point with." }, "bucketAccountId": { "type": "string", "description": "The AWS account ID associated with the S3 bucket associated with this access point." }, "name": { "type": "string", "description": "The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name." }, "networkOrigin": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:NetworkOrigin" } ], "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies." }, "policy": { "$ref": "pulumi.json#/Any", "description": "The Access Point Policy you want to apply to this access point." }, "publicAccessBlockConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublicAccessBlockConfiguration", "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." }, "vpcConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfiguration", "description": "If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). The Virtual Private Cloud (VPC) configuration for a bucket access point." } }, "type": "object" }, "azure-native:awsconnector:AwsS3AccessPointPropertiesResponse": { "description": "Definition of awsS3AccessPoint", "properties": { "alias": { "type": "string", "description": "The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications." }, "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the specified accesspoint. the Amazon Resource Name (ARN) of the specified accesspoint." }, "bucket": { "type": "string", "description": "The name of the bucket that you want to associate this Access Point with." }, "bucketAccountId": { "type": "string", "description": "The AWS account ID associated with the S3 bucket associated with this access point." }, "name": { "type": "string", "description": "The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name." }, "networkOrigin": { "type": "string", "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies." }, "policy": { "$ref": "pulumi.json#/Any", "description": "The Access Point Policy you want to apply to this access point." }, "publicAccessBlockConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublicAccessBlockConfigurationResponse", "description": "The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide." }, "vpcConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VpcConfigurationResponse", "description": "If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). The Virtual Private Cloud (VPC) configuration for a bucket access point." } }, "type": "object" }, "azure-native:awsconnector:AwsS3BucketPolicyProperties": { "description": "Definition of awsS3BucketPolicy", "properties": { "policy": { "type": "string", "description": "\u003cp\u003eThe bucket policy as a JSON document.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsS3BucketPolicyPropertiesResponse": { "description": "Definition of awsS3BucketPolicy", "properties": { "policy": { "type": "string", "description": "\u003cp\u003eThe bucket policy as a JSON document.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsS3BucketProperties": { "description": "Definition of awsS3Bucket", "properties": { "accelerateConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccelerateConfiguration", "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." }, "accessControl": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AccessControl" } ], "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*." }, "analyticsConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AnalyticsConfiguration" }, "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket." }, "arn": { "type": "string", "description": "the Amazon Resource Name (ARN) of the specified bucket." }, "bucketEncryption": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BucketEncryption", "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." }, "bucketName": { "type": "string", "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name." }, "corsConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CorsConfiguration", "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." }, "domainName": { "type": "string", "description": "Property domainName" }, "dualStackDomainName": { "type": "string", "description": "Property dualStackDomainName" }, "intelligentTieringConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IntelligentTieringConfiguration" }, "description": "Defines how Amazon S3 handles Intelligent-Tiering storage." }, "inventoryConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InventoryConfiguration" }, "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*." }, "lifecycleConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecycleConfiguration", "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." }, "loggingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingConfiguration", "description": "Settings that define where logs are stored. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*. To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions." }, "metricsConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricsConfiguration" }, "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html)." }, "notificationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotificationConfiguration", "description": "Configuration that defines how Amazon S3 handles bucket notifications. Describes the notification configuration for an Amazon S3 bucket. If you create the target resource and related permissions in the same template, you might have a circular dependency. For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency. To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3)." }, "objectLockConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ObjectLockConfiguration", "description": "This operation is not supported by directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html)." }, "objectLockEnabled": { "type": "boolean", "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." }, "ownershipControls": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OwnershipControls", "description": "Configuration that defines how Amazon S3 handles Object Ownership rules. Specifies the container element for Object Ownership rules. S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*." }, "publicAccessBlockConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublicAccessBlockConfiguration", "description": "Configuration that defines how Amazon S3 handles public access. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of 'Public'](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*." }, "regionalDomainName": { "type": "string", "description": "Property regionalDomainName" }, "replicationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationConfiguration", "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket." }, "versioningConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VersioningConfiguration", "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*." }, "websiteConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WebsiteConfiguration", "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). Specifies website configuration parameters for an Amazon S3 bucket." }, "websiteURL": { "type": "string", "description": "Property websiteURL" } }, "type": "object" }, "azure-native:awsconnector:AwsS3BucketPropertiesResponse": { "description": "Definition of awsS3Bucket", "properties": { "accelerateConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccelerateConfigurationResponse", "description": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*." }, "accessControl": { "type": "string", "description": "This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*." }, "analyticsConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AnalyticsConfigurationResponse" }, "description": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket." }, "arn": { "type": "string", "description": "the Amazon Resource Name (ARN) of the specified bucket." }, "bucketEncryption": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BucketEncryptionResponse", "description": "Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*." }, "bucketName": { "type": "string", "description": "A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name." }, "corsConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CorsConfigurationResponse", "description": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*." }, "domainName": { "type": "string", "description": "Property domainName" }, "dualStackDomainName": { "type": "string", "description": "Property dualStackDomainName" }, "intelligentTieringConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IntelligentTieringConfigurationResponse" }, "description": "Defines how Amazon S3 handles Intelligent-Tiering storage." }, "inventoryConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InventoryConfigurationResponse" }, "description": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*." }, "lifecycleConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LifecycleConfigurationResponse", "description": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*." }, "loggingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingConfigurationResponse", "description": "Settings that define where logs are stored. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*. To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions." }, "metricsConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricsConfigurationResponse" }, "description": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html)." }, "notificationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotificationConfigurationResponse", "description": "Configuration that defines how Amazon S3 handles bucket notifications. Describes the notification configuration for an Amazon S3 bucket. If you create the target resource and related permissions in the same template, you might have a circular dependency. For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency. To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3)." }, "objectLockConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ObjectLockConfigurationResponse", "description": "This operation is not supported by directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html)." }, "objectLockEnabled": { "type": "boolean", "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." }, "ownershipControls": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OwnershipControlsResponse", "description": "Configuration that defines how Amazon S3 handles Object Ownership rules. Specifies the container element for Object Ownership rules. S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*." }, "publicAccessBlockConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PublicAccessBlockConfigurationResponse", "description": "Configuration that defines how Amazon S3 handles public access. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of 'Public'](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*." }, "regionalDomainName": { "type": "string", "description": "Property regionalDomainName" }, "replicationConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationConfigurationResponseV1", "description": "Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "An arbitrary set of tags (key-value pairs) for this S3 bucket." }, "versioningConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VersioningConfigurationResponse", "description": "Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*." }, "websiteConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WebsiteConfigurationResponse", "description": "Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). Specifies website configuration parameters for an Amazon S3 bucket." }, "websiteURL": { "type": "string", "description": "Property websiteURL" } }, "type": "object" }, "azure-native:awsconnector:AwsS3ControlMultiRegionAccessPointPolicyDocumentProperties": { "description": "Definition of awsS3ControlMultiRegionAccessPointPolicyDocument", "properties": { "established": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EstablishedMultiRegionAccessPointPolicy", "description": "\u003cp\u003eThe last established policy for the Multi-Region Access Point.\u003c/p\u003e" }, "proposed": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProposedMultiRegionAccessPointPolicy", "description": "\u003cp\u003eThe proposed policy for the Multi-Region Access Point.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsS3ControlMultiRegionAccessPointPolicyDocumentPropertiesResponse": { "description": "Definition of awsS3ControlMultiRegionAccessPointPolicyDocument", "properties": { "established": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EstablishedMultiRegionAccessPointPolicyResponse", "description": "\u003cp\u003eThe last established policy for the Multi-Region Access Point.\u003c/p\u003e" }, "proposed": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProposedMultiRegionAccessPointPolicyResponse", "description": "\u003cp\u003eThe proposed policy for the Multi-Region Access Point.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSageMakerAppProperties": { "description": "Definition of awsSageMakerApp", "properties": { "appArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the app." }, "appName": { "type": "string", "description": "The name of the app." }, "appType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AppType" } ], "description": "The type of app." }, "domainId": { "type": "string", "description": "The domain ID." }, "resourceSpec": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceSpec", "description": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A list of tags to apply to the app." }, "userProfileName": { "type": "string", "description": "The user profile name." } }, "type": "object" }, "azure-native:awsconnector:AwsSageMakerAppPropertiesResponse": { "description": "Definition of awsSageMakerApp", "properties": { "appArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the app." }, "appName": { "type": "string", "description": "The name of the app." }, "appType": { "type": "string", "description": "The type of app." }, "domainId": { "type": "string", "description": "The domain ID." }, "resourceSpec": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceSpecResponse", "description": "The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A list of tags to apply to the app." }, "userProfileName": { "type": "string", "description": "The user profile name." } }, "type": "object" }, "azure-native:awsconnector:AwsSageMakerNotebookInstanceSummaryProperties": { "description": "Definition of awsSageMakerNotebookInstanceSummary", "properties": { "additionalCodeRepositories": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in \u003ca href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'\u003eAmazon Web Services CodeCommit\u003c/a\u003e or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see \u003ca href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'\u003eAssociating Git Repositories with SageMaker Notebook Instances\u003c/a\u003e.\u003c/p\u003e" }, "creationTime": { "type": "string", "description": "\u003cp\u003eA timestamp that shows when the notebook instance was created.\u003c/p\u003e" }, "defaultCodeRepository": { "type": "string", "description": "\u003cp\u003eThe Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in \u003ca href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'\u003eAmazon Web Services CodeCommit\u003c/a\u003e or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see \u003ca href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'\u003eAssociating Git Repositories with SageMaker Notebook Instances\u003c/a\u003e.\u003c/p\u003e" }, "instanceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceTypeEnumValue", "description": "\u003cp\u003eThe type of ML compute instance that the notebook instance is running on.\u003c/p\u003e" }, "lastModifiedTime": { "type": "string", "description": "\u003cp\u003eA timestamp that shows when the notebook instance was last modified.\u003c/p\u003e" }, "notebookInstanceArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the notebook instance.\u003c/p\u003e" }, "notebookInstanceLifecycleConfigName": { "type": "string", "description": "\u003cp\u003eThe name of a notebook instance lifecycle configuration associated with this notebook instance.\u003c/p\u003e \u003cp\u003eFor information about notebook instance lifestyle configurations, see \u003ca href='https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html'\u003eStep 2.1: (Optional) Customize a Notebook Instance\u003c/a\u003e.\u003c/p\u003e" }, "notebookInstanceName": { "type": "string", "description": "\u003cp\u003eThe name of the notebook instance that you want a summary for.\u003c/p\u003e" }, "notebookInstanceStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotebookInstanceStatusEnumValue", "description": "\u003cp\u003eThe status of the notebook instance.\u003c/p\u003e" }, "url": { "type": "string", "description": "\u003cp\u003eThe URL that you use to connect to the Jupyter notebook running in your notebook instance. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSageMakerNotebookInstanceSummaryPropertiesResponse": { "description": "Definition of awsSageMakerNotebookInstanceSummary", "properties": { "additionalCodeRepositories": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in \u003ca href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'\u003eAmazon Web Services CodeCommit\u003c/a\u003e or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see \u003ca href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'\u003eAssociating Git Repositories with SageMaker Notebook Instances\u003c/a\u003e.\u003c/p\u003e" }, "creationTime": { "type": "string", "description": "\u003cp\u003eA timestamp that shows when the notebook instance was created.\u003c/p\u003e" }, "defaultCodeRepository": { "type": "string", "description": "\u003cp\u003eThe Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in \u003ca href='https://docs.aws.amazon.com/codecommit/latest/userguide/welcome.html'\u003eAmazon Web Services CodeCommit\u003c/a\u003e or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see \u003ca href='https://docs.aws.amazon.com/sagemaker/latest/dg/nbi-git-repo.html'\u003eAssociating Git Repositories with SageMaker Notebook Instances\u003c/a\u003e.\u003c/p\u003e" }, "instanceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceTypeEnumValueResponse", "description": "\u003cp\u003eThe type of ML compute instance that the notebook instance is running on.\u003c/p\u003e" }, "lastModifiedTime": { "type": "string", "description": "\u003cp\u003eA timestamp that shows when the notebook instance was last modified.\u003c/p\u003e" }, "notebookInstanceArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the notebook instance.\u003c/p\u003e" }, "notebookInstanceLifecycleConfigName": { "type": "string", "description": "\u003cp\u003eThe name of a notebook instance lifecycle configuration associated with this notebook instance.\u003c/p\u003e \u003cp\u003eFor information about notebook instance lifestyle configurations, see \u003ca href='https://docs.aws.amazon.com/sagemaker/latest/dg/notebook-lifecycle-config.html'\u003eStep 2.1: (Optional) Customize a Notebook Instance\u003c/a\u003e.\u003c/p\u003e" }, "notebookInstanceName": { "type": "string", "description": "\u003cp\u003eThe name of the notebook instance that you want a summary for.\u003c/p\u003e" }, "notebookInstanceStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotebookInstanceStatusEnumValueResponse", "description": "\u003cp\u003eThe status of the notebook instance.\u003c/p\u003e" }, "url": { "type": "string", "description": "\u003cp\u003eThe URL that you use to connect to the Jupyter notebook running in your notebook instance. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSecretsManagerResourcePolicyProperties": { "description": "Definition of awsSecretsManagerResourcePolicy", "properties": { "blockPublicPolicy": { "type": "boolean", "description": "Property blockPublicPolicy" }, "id": { "type": "string", "description": "Property id" }, "resourcePolicy": { "$ref": "pulumi.json#/Any", "description": "Property resourcePolicy" }, "secretId": { "type": "string", "description": "Property secretId" } }, "type": "object" }, "azure-native:awsconnector:AwsSecretsManagerResourcePolicyPropertiesResponse": { "description": "Definition of awsSecretsManagerResourcePolicy", "properties": { "blockPublicPolicy": { "type": "boolean", "description": "Property blockPublicPolicy" }, "id": { "type": "string", "description": "Property id" }, "resourcePolicy": { "$ref": "pulumi.json#/Any", "description": "Property resourcePolicy" }, "secretId": { "type": "string", "description": "Property secretId" } }, "type": "object" }, "azure-native:awsconnector:AwsSecretsManagerSecretProperties": { "description": "Definition of awsSecretsManagerSecret", "properties": { "description": { "type": "string", "description": "The description of the secret." }, "generateSecretString": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GenerateSecretString", "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html)." }, "id": { "type": "string", "description": "Property id" }, "kmsKeyId": { "type": "string", "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key." }, "name": { "type": "string", "description": "The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN." }, "replicaRegions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicaRegion" }, "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret." }, "secretString": { "type": "string", "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: ``[{'Key':'CostCenter','Value':'12345'},{'Key':'environment','Value':'production'}]`` Secrets Manager tag key names are case sensitive. A tag with the key 'ABC' is a different tag from one with key 'abc'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: + Maximum number of tags per secret: 50 + Maximum key length: 127 Unicode characters in UTF-8 + Maximum value length: 255 Unicode characters in UTF-8 + Tag keys and values are case sensitive. + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @." } }, "type": "object" }, "azure-native:awsconnector:AwsSecretsManagerSecretPropertiesResponse": { "description": "Definition of awsSecretsManagerSecret", "properties": { "description": { "type": "string", "description": "The description of the secret." }, "generateSecretString": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GenerateSecretStringResponse", "description": "A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html)." }, "id": { "type": "string", "description": "Property id" }, "kmsKeyId": { "type": "string", "description": "The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key." }, "name": { "type": "string", "description": "The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN." }, "replicaRegions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicaRegionResponse" }, "description": "A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret." }, "secretString": { "type": "string", "description": "The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: ``[{'Key':'CostCenter','Value':'12345'},{'Key':'environment','Value':'production'}]`` Secrets Manager tag key names are case sensitive. A tag with the key 'ABC' is a different tag from one with key 'abc'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: + Maximum number of tags per secret: 50 + Maximum key length: 127 Unicode characters in UTF-8 + Maximum value length: 255 Unicode characters in UTF-8 + Tag keys and values are case sensitive. + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @." } }, "type": "object" }, "azure-native:awsconnector:AwsSnsSubscriptionProperties": { "description": "Definition of awsSnsSubscription", "properties": { "endpoint": { "type": "string", "description": "\u003cp\u003eThe subscription's endpoint (format depends on the protocol).\u003c/p\u003e" }, "owner": { "type": "string", "description": "\u003cp\u003eThe subscription's owner.\u003c/p\u003e" }, "protocol": { "type": "string", "description": "\u003cp\u003eThe subscription's protocol.\u003c/p\u003e" }, "subscriptionArn": { "type": "string", "description": "\u003cp\u003eThe subscription's ARN.\u003c/p\u003e" }, "topicArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the subscription's topic.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSnsSubscriptionPropertiesResponse": { "description": "Definition of awsSnsSubscription", "properties": { "endpoint": { "type": "string", "description": "\u003cp\u003eThe subscription's endpoint (format depends on the protocol).\u003c/p\u003e" }, "owner": { "type": "string", "description": "\u003cp\u003eThe subscription's owner.\u003c/p\u003e" }, "protocol": { "type": "string", "description": "\u003cp\u003eThe subscription's protocol.\u003c/p\u003e" }, "subscriptionArn": { "type": "string", "description": "\u003cp\u003eThe subscription's ARN.\u003c/p\u003e" }, "topicArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the subscription's topic.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSnsTopicProperties": { "description": "Definition of awsSnsTopic", "properties": { "archivePolicy": { "$ref": "pulumi.json#/Any", "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days." }, "contentBasedDeduplication": { "type": "boolean", "description": "Enables content-based deduplication for FIFO topics. + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action." }, "dataProtectionPolicy": { "$ref": "pulumi.json#/Any", "description": "The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720." }, "deliveryStatusLogging": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingConfig" }, "description": "Property deliveryStatusLogging" }, "displayName": { "type": "string", "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs." }, "fifoTopic": { "type": "boolean", "description": "Set to true to create a FIFO topic." }, "kmsMasterKeyId": { "type": "string", "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html)." }, "signatureVersion": { "type": "string", "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``." }, "subscription": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Subscription" }, "description": "The SNS subscriptions (endpoints) for this topic. If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions." }, "topicArn": { "type": "string", "description": "Property topicArn" }, "topicName": { "type": "string", "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "tracingConfig": { "type": "string", "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true." } }, "type": "object" }, "azure-native:awsconnector:AwsSnsTopicPropertiesResponse": { "description": "Definition of awsSnsTopic", "properties": { "archivePolicy": { "$ref": "pulumi.json#/Any", "description": "The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days." }, "contentBasedDeduplication": { "type": "boolean", "description": "Enables content-based deduplication for FIFO topics. + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action." }, "dataProtectionPolicy": { "$ref": "pulumi.json#/Any", "description": "The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720." }, "deliveryStatusLogging": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingConfigResponseV1" }, "description": "Property deliveryStatusLogging" }, "displayName": { "type": "string", "description": "The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs." }, "fifoTopic": { "type": "boolean", "description": "Set to true to create a FIFO topic." }, "kmsMasterKeyId": { "type": "string", "description": "The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html)." }, "signatureVersion": { "type": "string", "description": "The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``." }, "subscription": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SubscriptionResponse" }, "description": "The SNS subscriptions (endpoints) for this topic. If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions." }, "topicArn": { "type": "string", "description": "Property topicArn" }, "topicName": { "type": "string", "description": "The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "tracingConfig": { "type": "string", "description": "Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true." } }, "type": "object" }, "azure-native:awsconnector:AwsSqsQueueProperties": { "description": "Definition of awsSqsQueue", "properties": { "arn": { "type": "string", "description": "Property arn" }, "contentBasedDeduplication": { "type": "boolean", "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*." }, "deduplicationScope": { "type": "string", "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." }, "delaySeconds": { "type": "integer", "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``." }, "fifoQueue": { "type": "boolean", "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*." }, "fifoThroughputLimit": { "type": "string", "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." }, "kmsDataKeyReusePeriodSeconds": { "type": "integer", "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*." }, "kmsMasterKeyId": { "type": "string", "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + The Key Management Service (KMS) section of the [Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper" }, "maximumMessageSize": { "type": "integer", "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB)." }, "messageRetentionPeriod": { "type": "integer", "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days)." }, "queueName": { "type": "string", "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "queueUrl": { "type": "string", "description": "Property queueUrl" }, "receiveMessageWaitTimeSeconds": { "type": "integer", "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*." }, "redriveAllowPolicy": { "$ref": "pulumi.json#/Any", "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``." }, "redrivePolicy": { "$ref": "pulumi.json#/Any", "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* ``{ 'deadLetterTargetArn' : String, 'maxReceiveCount' : Integer }`` *YAML* ``deadLetterTargetArn : String`` ``maxReceiveCount : Integer``" }, "sqsManagedSseEnabled": { "type": "boolean", "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*." }, "visibilityTimeout": { "type": "integer", "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsSqsQueuePropertiesResponse": { "description": "Definition of awsSqsQueue", "properties": { "arn": { "type": "string", "description": "Property arn" }, "contentBasedDeduplication": { "type": "boolean", "description": "For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*." }, "deduplicationScope": { "type": "string", "description": "For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." }, "delaySeconds": { "type": "integer", "description": "The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``." }, "fifoQueue": { "type": "boolean", "description": "If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*." }, "fifoThroughputLimit": { "type": "string", "description": "For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*." }, "kmsDataKeyReusePeriodSeconds": { "type": "integer", "description": "The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*." }, "kmsMasterKeyId": { "type": "string", "description": "The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + The Key Management Service (KMS) section of the [Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper" }, "maximumMessageSize": { "type": "integer", "description": "The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB)." }, "messageRetentionPeriod": { "type": "integer", "description": "The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days)." }, "queueName": { "type": "string", "description": "A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name." }, "queueUrl": { "type": "string", "description": "Property queueUrl" }, "receiveMessageWaitTimeSeconds": { "type": "integer", "description": "Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*." }, "redriveAllowPolicy": { "$ref": "pulumi.json#/Any", "description": "The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``." }, "redrivePolicy": { "$ref": "pulumi.json#/Any", "description": "The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* ``{ 'deadLetterTargetArn' : String, 'maxReceiveCount' : Integer }`` *YAML* ``deadLetterTargetArn : String`` ``maxReceiveCount : Integer``" }, "sqsManagedSseEnabled": { "type": "boolean", "description": "Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*." }, "visibilityTimeout": { "type": "integer", "description": "The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:AwsSsmInstanceInformationProperties": { "description": "Definition of awsSsmInstanceInformation", "properties": { "activationId": { "type": "string", "description": "\u003cp\u003eThe activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.\u003c/p\u003e" }, "agentVersion": { "type": "string", "description": "\u003cp\u003eThe version of SSM Agent running on your Linux managed node. \u003c/p\u003e" }, "associationOverview": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAggregatedAssociationOverview", "description": "\u003cp\u003eInformation about the association.\u003c/p\u003e" }, "associationStatus": { "type": "string", "description": "\u003cp\u003eThe status of the association.\u003c/p\u003e" }, "computerName": { "type": "string", "description": "\u003cp\u003eThe fully qualified host name of the managed node.\u003c/p\u003e" }, "iamRole": { "type": "string", "description": "\u003cp\u003eThe Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 \u003ccode\u003eDescribeInstances\u003c/code\u003e operation. For information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'\u003eDescribeInstances\u003c/a\u003e in the \u003ci\u003eAmazon EC2 API Reference\u003c/i\u003e or \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'\u003edescribe-instances\u003c/a\u003e in the \u003ci\u003eAmazon Web Services CLI Command Reference\u003c/i\u003e.\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe managed node ID. \u003c/p\u003e" }, "ipAddress": { "type": "string", "description": "\u003cp\u003eThe IP address of the managed node.\u003c/p\u003e" }, "isLatestVersion": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.\u003c/p\u003e" }, "lastAssociationExecutionDate": { "type": "string", "description": "\u003cp\u003eThe date the association was last run.\u003c/p\u003e" }, "lastPingDateTime": { "type": "string", "description": "\u003cp\u003eThe date and time when the agent last pinged the Systems Manager service. \u003c/p\u003e" }, "lastSuccessfulAssociationExecutionDate": { "type": "string", "description": "\u003cp\u003eThe last date the association was successfully run.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the \u003ccode\u003eDefaultInstanceName\u003c/code\u003e property using the \u003ca\u003eCreateActivation\u003c/a\u003e command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in \u003ca href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html'\u003eInstall SSM Agent for a hybrid and multicloud environment (Linux)\u003c/a\u003e and \u003ca href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html'\u003eInstall SSM Agent for a hybrid and multicloud environment (Windows)\u003c/a\u003e. To retrieve the \u003ccode\u003eName\u003c/code\u003e tag of an EC2 instance, use the Amazon EC2 \u003ccode\u003eDescribeInstances\u003c/code\u003e operation. For information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'\u003eDescribeInstances\u003c/a\u003e in the \u003ci\u003eAmazon EC2 API Reference\u003c/i\u003e or \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'\u003edescribe-instances\u003c/a\u003e in the \u003ci\u003eAmazon Web Services CLI Command Reference\u003c/i\u003e.\u003c/p\u003e" }, "pingStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PingStatusEnumValue", "description": "\u003cp\u003eConnection status of SSM Agent. \u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe status \u003ccode\u003eInactive\u003c/code\u003e has been deprecated and is no longer in use.\u003c/p\u003e \u003c/note\u003e" }, "platformName": { "type": "string", "description": "\u003cp\u003eThe name of the operating system platform running on your managed node. \u003c/p\u003e" }, "platformType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlatformTypeEnumValue", "description": "\u003cp\u003eThe operating system platform type. \u003c/p\u003e" }, "platformVersion": { "type": "string", "description": "\u003cp\u003eThe version of the OS platform running on your managed node. \u003c/p\u003e" }, "registrationDate": { "type": "string", "description": "\u003cp\u003eThe date the server or VM was registered with Amazon Web Services as a managed node.\u003c/p\u003e" }, "resourceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceTypeEnumValue", "description": "\u003cp\u003eThe type of instance. Instances are either EC2 instances or managed instances. \u003c/p\u003e" }, "sourceId": { "type": "string", "description": "\u003cp\u003eThe ID of the source resource. For IoT Greengrass devices, \u003ccode\u003eSourceId\u003c/code\u003e is the Thing name. \u003c/p\u003e" }, "sourceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceTypeEnumValue", "description": "\u003cp\u003eThe type of the source resource. For IoT Greengrass devices, \u003ccode\u003eSourceType\u003c/code\u003e is \u003ccode\u003eAWS::IoT::Thing\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSsmInstanceInformationPropertiesResponse": { "description": "Definition of awsSsmInstanceInformation", "properties": { "activationId": { "type": "string", "description": "\u003cp\u003eThe activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.\u003c/p\u003e" }, "agentVersion": { "type": "string", "description": "\u003cp\u003eThe version of SSM Agent running on your Linux managed node. \u003c/p\u003e" }, "associationOverview": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAggregatedAssociationOverviewResponse", "description": "\u003cp\u003eInformation about the association.\u003c/p\u003e" }, "associationStatus": { "type": "string", "description": "\u003cp\u003eThe status of the association.\u003c/p\u003e" }, "computerName": { "type": "string", "description": "\u003cp\u003eThe fully qualified host name of the managed node.\u003c/p\u003e" }, "iamRole": { "type": "string", "description": "\u003cp\u003eThe Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 \u003ccode\u003eDescribeInstances\u003c/code\u003e operation. For information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'\u003eDescribeInstances\u003c/a\u003e in the \u003ci\u003eAmazon EC2 API Reference\u003c/i\u003e or \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'\u003edescribe-instances\u003c/a\u003e in the \u003ci\u003eAmazon Web Services CLI Command Reference\u003c/i\u003e.\u003c/p\u003e" }, "instanceId": { "type": "string", "description": "\u003cp\u003eThe managed node ID. \u003c/p\u003e" }, "ipAddress": { "type": "string", "description": "\u003cp\u003eThe IP address of the managed node.\u003c/p\u003e" }, "isLatestVersion": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.\u003c/p\u003e" }, "lastAssociationExecutionDate": { "type": "string", "description": "\u003cp\u003eThe date the association was last run.\u003c/p\u003e" }, "lastPingDateTime": { "type": "string", "description": "\u003cp\u003eThe date and time when the agent last pinged the Systems Manager service. \u003c/p\u003e" }, "lastSuccessfulAssociationExecutionDate": { "type": "string", "description": "\u003cp\u003eThe last date the association was successfully run.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the \u003ccode\u003eDefaultInstanceName\u003c/code\u003e property using the \u003ca\u003eCreateActivation\u003c/a\u003e command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in \u003ca href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-linux.html'\u003eInstall SSM Agent for a hybrid and multicloud environment (Linux)\u003c/a\u003e and \u003ca href='https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-install-managed-win.html'\u003eInstall SSM Agent for a hybrid and multicloud environment (Windows)\u003c/a\u003e. To retrieve the \u003ccode\u003eName\u003c/code\u003e tag of an EC2 instance, use the Amazon EC2 \u003ccode\u003eDescribeInstances\u003c/code\u003e operation. For information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html'\u003eDescribeInstances\u003c/a\u003e in the \u003ci\u003eAmazon EC2 API Reference\u003c/i\u003e or \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-instances.html'\u003edescribe-instances\u003c/a\u003e in the \u003ci\u003eAmazon Web Services CLI Command Reference\u003c/i\u003e.\u003c/p\u003e" }, "pingStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PingStatusEnumValueResponse", "description": "\u003cp\u003eConnection status of SSM Agent. \u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe status \u003ccode\u003eInactive\u003c/code\u003e has been deprecated and is no longer in use.\u003c/p\u003e \u003c/note\u003e" }, "platformName": { "type": "string", "description": "\u003cp\u003eThe name of the operating system platform running on your managed node. \u003c/p\u003e" }, "platformType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlatformTypeEnumValueResponse", "description": "\u003cp\u003eThe operating system platform type. \u003c/p\u003e" }, "platformVersion": { "type": "string", "description": "\u003cp\u003eThe version of the OS platform running on your managed node. \u003c/p\u003e" }, "registrationDate": { "type": "string", "description": "\u003cp\u003eThe date the server or VM was registered with Amazon Web Services as a managed node.\u003c/p\u003e" }, "resourceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceTypeEnumValueResponse", "description": "\u003cp\u003eThe type of instance. Instances are either EC2 instances or managed instances. \u003c/p\u003e" }, "sourceId": { "type": "string", "description": "\u003cp\u003eThe ID of the source resource. For IoT Greengrass devices, \u003ccode\u003eSourceId\u003c/code\u003e is the Thing name. \u003c/p\u003e" }, "sourceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceTypeEnumValueResponse", "description": "\u003cp\u003eThe type of the source resource. For IoT Greengrass devices, \u003ccode\u003eSourceType\u003c/code\u003e is \u003ccode\u003eAWS::IoT::Thing\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSsmParameterProperties": { "description": "Definition of awsSsmParameter", "properties": { "allowedPattern": { "type": "string", "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``" }, "dataType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DataType" } ], "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``." }, "description": { "type": "string", "description": "Information about the parameter." }, "name": { "type": "string", "description": "The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``" }, "policies": { "type": "string", "description": "Information about the policies assigned to a parameter. [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*." }, "tags": { "$ref": "pulumi.json#/Any", "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter." }, "tier": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Tier" } ], "description": "The parameter tier." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Type" } ], "description": "The type of parameter." }, "value": { "type": "string", "description": "The parameter value. If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field." } }, "type": "object" }, "azure-native:awsconnector:AwsSsmParameterPropertiesResponse": { "description": "Definition of awsSsmParameter", "properties": { "allowedPattern": { "type": "string", "description": "A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\\d+$``" }, "dataType": { "type": "string", "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``." }, "description": { "type": "string", "description": "Information about the parameter." }, "name": { "type": "string", "description": "The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName``" }, "policies": { "type": "string", "description": "Information about the policies assigned to a parameter. [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*." }, "tags": { "$ref": "pulumi.json#/Any", "description": "Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter." }, "tier": { "type": "string", "description": "The parameter tier." }, "type": { "type": "string", "description": "The type of parameter." }, "value": { "type": "string", "description": "The parameter value. If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field." } }, "type": "object" }, "azure-native:awsconnector:AwsSsmResourceComplianceSummaryItemProperties": { "description": "Definition of awsSsmResourceComplianceSummaryItem", "properties": { "complianceType": { "type": "string", "description": "\u003cp\u003eThe compliance type.\u003c/p\u003e" }, "compliantSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CompliantSummary", "description": "\u003cp\u003eA list of items that are compliant for the resource.\u003c/p\u003e" }, "executionSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComplianceExecutionSummary", "description": "\u003cp\u003eInformation about the execution.\u003c/p\u003e" }, "nonCompliantSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NonCompliantSummary", "description": "\u003cp\u003eA list of items that aren't compliant for the resource.\u003c/p\u003e" }, "overallSeverity": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComplianceSeverityEnumValue", "description": "\u003cp\u003eThe highest severity item found for the resource. The resource is compliant for this item.\u003c/p\u003e" }, "resourceId": { "type": "string", "description": "\u003cp\u003eThe resource ID.\u003c/p\u003e" }, "resourceType": { "type": "string", "description": "\u003cp\u003eThe resource type.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComplianceStatusEnumValue", "description": "\u003cp\u003eThe compliance status for the resource.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsSsmResourceComplianceSummaryItemPropertiesResponse": { "description": "Definition of awsSsmResourceComplianceSummaryItem", "properties": { "complianceType": { "type": "string", "description": "\u003cp\u003eThe compliance type.\u003c/p\u003e" }, "compliantSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CompliantSummaryResponse", "description": "\u003cp\u003eA list of items that are compliant for the resource.\u003c/p\u003e" }, "executionSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComplianceExecutionSummaryResponse", "description": "\u003cp\u003eInformation about the execution.\u003c/p\u003e" }, "nonCompliantSummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NonCompliantSummaryResponse", "description": "\u003cp\u003eA list of items that aren't compliant for the resource.\u003c/p\u003e" }, "overallSeverity": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComplianceSeverityEnumValueResponse", "description": "\u003cp\u003eThe highest severity item found for the resource. The resource is compliant for this item.\u003c/p\u003e" }, "resourceId": { "type": "string", "description": "\u003cp\u003eThe resource ID.\u003c/p\u003e" }, "resourceType": { "type": "string", "description": "\u003cp\u003eThe resource type.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComplianceStatusEnumValueResponse", "description": "\u003cp\u003eThe compliance status for the resource.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsVpcConfiguration": { "description": "Definition of AwsVpcConfiguration", "properties": { "assignPublicIp": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:AwsVpcConfigurationAssignPublicIp" } ], "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``. All specified security groups must be from the same VPC." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``. All specified subnets must be from the same VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsVpcConfigurationAssignPublicIp": { "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``.", "type": "string", "enum": [ { "name": "DISABLED", "description": "AwsVpcConfigurationAssignPublicIp enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "AwsVpcConfigurationAssignPublicIp enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:AwsVpcConfigurationResponse": { "description": "Definition of AwsVpcConfiguration", "properties": { "assignPublicIp": { "type": "string", "description": "Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``." }, "securityGroups": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``. All specified security groups must be from the same VPC." }, "subnets": { "type": "array", "items": { "type": "string" }, "description": "The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``. All specified subnets must be from the same VPC." } }, "type": "object" }, "azure-native:awsconnector:AwsWafWebACLSummaryProperties": { "description": "Definition of awsWafWebACLSummary", "properties": { "name": { "type": "string", "description": "\u003cp\u003eA friendly name or description of the \u003ca\u003eWebACL\u003c/a\u003e. You can't change the name of a \u003ccode\u003eWebACL\u003c/code\u003e after you create it.\u003c/p\u003e" }, "webACLId": { "type": "string", "description": "\u003cp\u003eA unique identifier for a \u003ccode\u003eWebACL\u003c/code\u003e. You use \u003ccode\u003eWebACLId\u003c/code\u003e to get information about a \u003ccode\u003eWebACL\u003c/code\u003e (see \u003ca\u003eGetWebACL\u003c/a\u003e), update a \u003ccode\u003eWebACL\u003c/code\u003e (see \u003ca\u003eUpdateWebACL\u003c/a\u003e), and delete a \u003ccode\u003eWebACL\u003c/code\u003e from AWS WAF (see \u003ca\u003eDeleteWebACL\u003c/a\u003e).\u003c/p\u003e \u003cp\u003e \u003ccode\u003eWebACLId\u003c/code\u003e is returned by \u003ca\u003eCreateWebACL\u003c/a\u003e and by \u003ca\u003eListWebACLs\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsWafWebACLSummaryPropertiesResponse": { "description": "Definition of awsWafWebACLSummary", "properties": { "name": { "type": "string", "description": "\u003cp\u003eA friendly name or description of the \u003ca\u003eWebACL\u003c/a\u003e. You can't change the name of a \u003ccode\u003eWebACL\u003c/code\u003e after you create it.\u003c/p\u003e" }, "webACLId": { "type": "string", "description": "\u003cp\u003eA unique identifier for a \u003ccode\u003eWebACL\u003c/code\u003e. You use \u003ccode\u003eWebACLId\u003c/code\u003e to get information about a \u003ccode\u003eWebACL\u003c/code\u003e (see \u003ca\u003eGetWebACL\u003c/a\u003e), update a \u003ccode\u003eWebACL\u003c/code\u003e (see \u003ca\u003eUpdateWebACL\u003c/a\u003e), and delete a \u003ccode\u003eWebACL\u003c/code\u003e from AWS WAF (see \u003ca\u003eDeleteWebACL\u003c/a\u003e).\u003c/p\u003e \u003cp\u003e \u003ccode\u003eWebACLId\u003c/code\u003e is returned by \u003ca\u003eCreateWebACL\u003c/a\u003e and by \u003ca\u003eListWebACLs\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:AwsWafv2LoggingConfigurationProperties": { "description": "Definition of awsWafv2LoggingConfiguration", "properties": { "logDestinationConfigs": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL." }, "loggingFilter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingFilterModelProperties", "description": "Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation." }, "managedByFirewallManager": { "type": "boolean", "description": "Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration." }, "redactedFields": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FieldToMatch" }, "description": "The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx." }, "resourceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs." } }, "type": "object" }, "azure-native:awsconnector:AwsWafv2LoggingConfigurationPropertiesResponse": { "description": "Definition of awsWafv2LoggingConfiguration", "properties": { "logDestinationConfigs": { "type": "array", "items": { "type": "string" }, "description": "The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL." }, "loggingFilter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingFilterModelPropertiesResponse", "description": "Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation." }, "managedByFirewallManager": { "type": "boolean", "description": "Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration." }, "redactedFields": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FieldToMatchResponse" }, "description": "The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx." }, "resourceArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs." } }, "type": "object" }, "azure-native:awsconnector:BackupPolicy": { "description": "Definition of BackupPolicy", "properties": { "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:BackupPolicyStatus" } ], "description": "Set the backup policy status for the file system. + *ENABLED* - Turns automatic backups on for the file system. + *DISABLED* - Turns automatic backups off for the file system." } }, "type": "object" }, "azure-native:awsconnector:BackupPolicyResponse": { "description": "Definition of BackupPolicy", "properties": { "status": { "type": "string", "description": "Set the backup policy status for the file system. + *ENABLED* - Turns automatic backups on for the file system. + *DISABLED* - Turns automatic backups off for the file system." } }, "type": "object" }, "azure-native:awsconnector:BackupPolicyStatus": { "description": "Set the backup policy status for the file system. + *ENABLED* - Turns automatic backups on for the file system. + *DISABLED* - Turns automatic backups off for the file system.", "type": "string", "enum": [ { "name": "DISABLED", "description": "BackupPolicyStatus enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "BackupPolicyStatus enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:BaselineEbsBandwidthMbpsRequest": { "description": "Definition of BaselineEbsBandwidthMbpsRequest", "properties": { "max": { "type": "integer", "description": "The maximum value in Mbps." }, "min": { "type": "integer", "description": "The minimum value in Mbps." } }, "type": "object" }, "azure-native:awsconnector:BaselineEbsBandwidthMbpsRequestResponse": { "description": "Definition of BaselineEbsBandwidthMbpsRequest", "properties": { "max": { "type": "integer", "description": "The maximum value in Mbps." }, "min": { "type": "integer", "description": "The minimum value in Mbps." } }, "type": "object" }, "azure-native:awsconnector:BatchReportModeType": { "description": "Property value", "type": "string", "enum": [ { "name": "REPORT_AGGREGATED_BATCH", "description": "BatchReportModeType enum REPORT_AGGREGATED_BATCH", "value": "REPORT_AGGREGATED_BATCH" }, { "name": "REPORT_INDIVIDUAL_BUILDS", "description": "BatchReportModeType enum REPORT_INDIVIDUAL_BUILDS", "value": "REPORT_INDIVIDUAL_BUILDS" } ] }, "azure-native:awsconnector:BatchReportModeTypeEnumValue": { "description": "Definition of BatchReportModeTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:BatchReportModeType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:BatchReportModeTypeEnumValueResponse": { "description": "Definition of BatchReportModeTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:BatchRestrictions": { "description": "Definition of BatchRestrictions", "properties": { "computeTypesAllowed": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array of strings that specify the compute types that are allowed for the batch build. See \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'\u003eBuild environment compute types\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e for these values. \u003c/p\u003e" }, "maximumBuildsAllowed": { "type": "integer", "description": "\u003cp\u003eSpecifies the maximum number of builds allowed.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:BatchRestrictionsResponse": { "description": "Definition of BatchRestrictions", "properties": { "computeTypesAllowed": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array of strings that specify the compute types that are allowed for the batch build. See \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'\u003eBuild environment compute types\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e for these values. \u003c/p\u003e" }, "maximumBuildsAllowed": { "type": "integer", "description": "\u003cp\u003eSpecifies the maximum number of builds allowed.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:BlockDeviceMapping": { "description": "Definition of BlockDeviceMapping", "properties": { "deviceName": { "type": "string", "description": "\u003cp\u003eThe device name (for example, \u003ccode\u003e/dev/sdh\u003c/code\u003e or \u003ccode\u003exvdh\u003c/code\u003e).\u003c/p\u003e" }, "ebs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EbsBlockDevice", "description": "\u003cp\u003eParameters used to automatically set up EBS volumes when the instance is launched.\u003c/p\u003e" }, "noDevice": { "type": "string", "description": "\u003cp\u003eTo omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.\u003c/p\u003e" }, "virtualName": { "type": "string", "description": "\u003cp\u003eThe virtual device name (\u003ccode\u003eephemeral\u003c/code\u003eN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for \u003ccode\u003eephemeral0\u003c/code\u003e and \u003ccode\u003eephemeral1\u003c/code\u003e. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.\u003c/p\u003e \u003cp\u003eNVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.\u003c/p\u003e \u003cp\u003eConstraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:BlockDeviceMappingResponse": { "description": "Definition of BlockDeviceMapping", "properties": { "deviceName": { "type": "string", "description": "\u003cp\u003eThe device name (for example, \u003ccode\u003e/dev/sdh\u003c/code\u003e or \u003ccode\u003exvdh\u003c/code\u003e).\u003c/p\u003e" }, "ebs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EbsBlockDeviceResponse", "description": "\u003cp\u003eParameters used to automatically set up EBS volumes when the instance is launched.\u003c/p\u003e" }, "noDevice": { "type": "string", "description": "\u003cp\u003eTo omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.\u003c/p\u003e" }, "virtualName": { "type": "string", "description": "\u003cp\u003eThe virtual device name (\u003ccode\u003eephemeral\u003c/code\u003eN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for \u003ccode\u003eephemeral0\u003c/code\u003e and \u003ccode\u003eephemeral1\u003c/code\u003e. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.\u003c/p\u003e \u003cp\u003eNVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.\u003c/p\u003e \u003cp\u003eConstraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:BootModeValues": { "description": "Property value", "type": "string", "enum": [ { "name": "LegacyBios", "description": "BootModeValues enum legacy-bios", "value": "legacy-bios" }, { "name": "Uefi", "description": "BootModeValues enum uefi", "value": "uefi" }, { "name": "UefiPreferred", "description": "BootModeValues enum uefi-preferred", "value": "uefi-preferred" } ] }, "azure-native:awsconnector:BootModeValuesEnumValue": { "description": "Definition of BootModeValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:BootModeValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:BootModeValuesEnumValueResponse": { "description": "Definition of BootModeValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:BucketEncryption": { "description": "Definition of BucketEncryption", "properties": { "serverSideEncryptionConfiguration": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerSideEncryptionRule" }, "description": "Specifies the default server-side-encryption configuration." } }, "type": "object" }, "azure-native:awsconnector:BucketEncryptionResponse": { "description": "Definition of BucketEncryption", "properties": { "serverSideEncryptionConfiguration": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerSideEncryptionRuleResponse" }, "description": "Specifies the default server-side-encryption configuration." } }, "type": "object" }, "azure-native:awsconnector:BucketOwnerAccess": { "description": "Property value", "type": "string", "enum": [ { "name": "FULL", "description": "BucketOwnerAccess enum FULL", "value": "FULL" }, { "name": "NONE", "description": "BucketOwnerAccess enum NONE", "value": "NONE" }, { "name": "READ_ONLY", "description": "BucketOwnerAccess enum READ_ONLY", "value": "READ_ONLY" } ] }, "azure-native:awsconnector:BucketOwnerAccessEnumValue": { "description": "Definition of BucketOwnerAccessEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:BucketOwnerAccess" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:BucketOwnerAccessEnumValueResponse": { "description": "Definition of BucketOwnerAccessEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:BuildStatusConfig": { "description": "Definition of BuildStatusConfig", "properties": { "context": { "type": "string", "description": "\u003cp\u003eSpecifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eBitbucket\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003ename\u003c/code\u003e parameter in the Bitbucket commit status. For more information, see \u003ca href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'\u003ebuild\u003c/a\u003e in the Bitbucket API documentation.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eGitHub/GitHub Enterprise Server\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003econtext\u003c/code\u003e parameter in the GitHub commit status. For more information, see \u003ca href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'\u003eCreate a commit status\u003c/a\u003e in the GitHub developer guide.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "targetUrl": { "type": "string", "description": "\u003cp\u003eSpecifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eBitbucket\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003eurl\u003c/code\u003e parameter in the Bitbucket commit status. For more information, see \u003ca href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'\u003ebuild\u003c/a\u003e in the Bitbucket API documentation.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eGitHub/GitHub Enterprise Server\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003etarget_url\u003c/code\u003e parameter in the GitHub commit status. For more information, see \u003ca href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'\u003eCreate a commit status\u003c/a\u003e in the GitHub developer guide.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" } }, "type": "object" }, "azure-native:awsconnector:BuildStatusConfigResponse": { "description": "Definition of BuildStatusConfig", "properties": { "context": { "type": "string", "description": "\u003cp\u003eSpecifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eBitbucket\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003ename\u003c/code\u003e parameter in the Bitbucket commit status. For more information, see \u003ca href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'\u003ebuild\u003c/a\u003e in the Bitbucket API documentation.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eGitHub/GitHub Enterprise Server\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003econtext\u003c/code\u003e parameter in the GitHub commit status. For more information, see \u003ca href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'\u003eCreate a commit status\u003c/a\u003e in the GitHub developer guide.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "targetUrl": { "type": "string", "description": "\u003cp\u003eSpecifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eBitbucket\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003eurl\u003c/code\u003e parameter in the Bitbucket commit status. For more information, see \u003ca href='https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build'\u003ebuild\u003c/a\u003e in the Bitbucket API documentation.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eGitHub/GitHub Enterprise Server\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eThis parameter is used for the \u003ccode\u003etarget_url\u003c/code\u003e parameter in the GitHub commit status. For more information, see \u003ca href='https://developer.github.com/v3/repos/statuses/#create-a-commit-status'\u003eCreate a commit status\u003c/a\u003e in the GitHub developer guide.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" } }, "type": "object" }, "azure-native:awsconnector:CFNDataSourceConfigurations": { "description": "Definition of CFNDataSourceConfigurations", "properties": { "kubernetes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNKubernetesConfiguration", "description": "Property kubernetes" }, "malwareProtection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNMalwareProtectionConfiguration", "description": "Property malwareProtection" }, "s3Logs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNS3LogsConfiguration", "description": "Property s3Logs" } }, "type": "object" }, "azure-native:awsconnector:CFNDataSourceConfigurationsResponse": { "description": "Definition of CFNDataSourceConfigurations", "properties": { "kubernetes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNKubernetesConfigurationResponse", "description": "Property kubernetes" }, "malwareProtection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNMalwareProtectionConfigurationResponse", "description": "Property malwareProtection" }, "s3Logs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNS3LogsConfigurationResponse", "description": "Property s3Logs" } }, "type": "object" }, "azure-native:awsconnector:CFNFeatureAdditionalConfiguration": { "description": "Definition of CFNFeatureAdditionalConfiguration", "properties": { "name": { "type": "string", "description": "Property name" }, "status": { "type": "string", "description": "Property status" } }, "type": "object" }, "azure-native:awsconnector:CFNFeatureAdditionalConfigurationResponse": { "description": "Definition of CFNFeatureAdditionalConfiguration", "properties": { "name": { "type": "string", "description": "Property name" }, "status": { "type": "string", "description": "Property status" } }, "type": "object" }, "azure-native:awsconnector:CFNFeatureConfiguration": { "description": "Definition of CFNFeatureConfiguration", "properties": { "additionalConfiguration": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNFeatureAdditionalConfiguration" }, "description": "Property additionalConfiguration" }, "name": { "type": "string", "description": "Property name" }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CFNFeatureConfigurationStatus" } ], "description": "Property status" } }, "type": "object" }, "azure-native:awsconnector:CFNFeatureConfigurationResponse": { "description": "Definition of CFNFeatureConfiguration", "properties": { "additionalConfiguration": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNFeatureAdditionalConfigurationResponse" }, "description": "Property additionalConfiguration" }, "name": { "type": "string", "description": "Property name" }, "status": { "type": "string", "description": "Property status" } }, "type": "object" }, "azure-native:awsconnector:CFNFeatureConfigurationStatus": { "description": "Property status", "type": "string", "enum": [ { "name": "DISABLED", "description": "CFNFeatureConfigurationStatus enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "CFNFeatureConfigurationStatus enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:CFNKubernetesAuditLogsConfiguration": { "description": "Definition of CFNKubernetesAuditLogsConfiguration", "properties": { "enable": { "type": "boolean", "description": "Property enable" } }, "type": "object" }, "azure-native:awsconnector:CFNKubernetesAuditLogsConfigurationResponse": { "description": "Definition of CFNKubernetesAuditLogsConfiguration", "properties": { "enable": { "type": "boolean", "description": "Property enable" } }, "type": "object" }, "azure-native:awsconnector:CFNKubernetesConfiguration": { "description": "Definition of CFNKubernetesConfiguration", "properties": { "auditLogs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNKubernetesAuditLogsConfiguration", "description": "Property auditLogs" } }, "type": "object" }, "azure-native:awsconnector:CFNKubernetesConfigurationResponse": { "description": "Definition of CFNKubernetesConfiguration", "properties": { "auditLogs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNKubernetesAuditLogsConfigurationResponse", "description": "Property auditLogs" } }, "type": "object" }, "azure-native:awsconnector:CFNMalwareProtectionConfiguration": { "description": "Definition of CFNMalwareProtectionConfiguration", "properties": { "scanEc2InstanceWithFindings": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNScanEc2InstanceWithFindingsConfiguration", "description": "Property scanEc2InstanceWithFindings" } }, "type": "object" }, "azure-native:awsconnector:CFNMalwareProtectionConfigurationResponse": { "description": "Definition of CFNMalwareProtectionConfiguration", "properties": { "scanEc2InstanceWithFindings": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CFNScanEc2InstanceWithFindingsConfigurationResponse", "description": "Property scanEc2InstanceWithFindings" } }, "type": "object" }, "azure-native:awsconnector:CFNS3LogsConfiguration": { "description": "Definition of CFNS3LogsConfiguration", "properties": { "enable": { "type": "boolean", "description": "Property enable" } }, "type": "object" }, "azure-native:awsconnector:CFNS3LogsConfigurationResponse": { "description": "Definition of CFNS3LogsConfiguration", "properties": { "enable": { "type": "boolean", "description": "Property enable" } }, "type": "object" }, "azure-native:awsconnector:CFNScanEc2InstanceWithFindingsConfiguration": { "description": "Definition of CFNScanEc2InstanceWithFindingsConfiguration", "properties": { "ebsVolumes": { "type": "boolean", "description": "Property ebsVolumes" } }, "type": "object" }, "azure-native:awsconnector:CFNScanEc2InstanceWithFindingsConfigurationResponse": { "description": "Definition of CFNScanEc2InstanceWithFindingsConfiguration", "properties": { "ebsVolumes": { "type": "boolean", "description": "Property ebsVolumes" } }, "type": "object" }, "azure-native:awsconnector:CacheBehavior": { "description": "Definition of CacheBehavior", "properties": { "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin." }, "cachePolicyId": { "type": "string", "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." }, "cachedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly." }, "compress": { "type": "boolean", "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." }, "defaultTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 86400 }, "fieldLevelEncryptionId": { "type": "string", "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior." }, "forwardedValues": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ForwardedValues", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." }, "functionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FunctionAssociation" }, "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior." }, "lambdaFunctionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaFunctionAssociation" }, "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior." }, "maxTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 31536000 }, "minTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." }, "originRequestPolicyId": { "type": "string", "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." }, "pathPattern": { "type": "string", "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``. The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*." }, "realtimeLogConfigArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." }, "responseHeadersPolicyId": { "type": "string", "description": "The identifier for a response headers policy." }, "smoothStreaming": { "type": "boolean", "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." }, "targetOriginId": { "type": "string", "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior." }, "trustedKeyGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "trustedSigners": { "type": "array", "items": { "type": "string" }, "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "viewerProtocolPolicy": { "type": "string", "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:CacheBehaviorResponse": { "description": "Definition of CacheBehavior", "properties": { "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin." }, "cachePolicyId": { "type": "string", "description": "The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." }, "cachedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly." }, "compress": { "type": "boolean", "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." }, "defaultTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 86400 }, "fieldLevelEncryptionId": { "type": "string", "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior." }, "forwardedValues": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ForwardedValuesResponse", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." }, "functionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FunctionAssociationResponse" }, "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior." }, "lambdaFunctionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaFunctionAssociationResponse" }, "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior." }, "maxTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 31536000 }, "minTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." }, "originRequestPolicyId": { "type": "string", "description": "The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." }, "pathPattern": { "type": "string", "description": "The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``. The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*." }, "realtimeLogConfigArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." }, "responseHeadersPolicyId": { "type": "string", "description": "The identifier for a response headers policy." }, "smoothStreaming": { "type": "boolean", "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." }, "targetOriginId": { "type": "string", "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior." }, "trustedKeyGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "trustedSigners": { "type": "array", "items": { "type": "string" }, "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "viewerProtocolPolicy": { "type": "string", "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:CacheMode": { "description": "CacheMode enum", "type": "string", "enum": [ { "name": "LOCAL_CUSTOM_CACHE", "description": "CacheMode enum LOCAL_CUSTOM_CACHE", "value": "LOCAL_CUSTOM_CACHE" }, { "name": "LOCAL_DOCKER_LAYER_CACHE", "description": "CacheMode enum LOCAL_DOCKER_LAYER_CACHE", "value": "LOCAL_DOCKER_LAYER_CACHE" }, { "name": "LOCAL_SOURCE_CACHE", "description": "CacheMode enum LOCAL_SOURCE_CACHE", "value": "LOCAL_SOURCE_CACHE" } ] }, "azure-native:awsconnector:CacheType": { "description": "Property value", "type": "string", "enum": [ { "name": "LOCAL", "description": "CacheType enum LOCAL", "value": "LOCAL" }, { "name": "NO_CACHE", "description": "CacheType enum NO_CACHE", "value": "NO_CACHE" }, { "name": "S3", "description": "CacheType enum S3", "value": "S3" } ] }, "azure-native:awsconnector:CacheTypeEnumValue": { "description": "Definition of CacheTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CacheType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CacheTypeEnumValueResponse": { "description": "Definition of CacheTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CallAs": { "description": "Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.", "type": "string", "enum": [ { "name": "DELEGATED_ADMIN", "description": "CallAs enum DELEGATED_ADMIN", "value": "DELEGATED_ADMIN" }, { "name": "SELF", "description": "CallAs enum SELF", "value": "SELF" } ] }, "azure-native:awsconnector:CanarySetting": { "description": "Definition of CanarySetting", "properties": { "deploymentId": { "type": "string", "description": "The ID of the canary deployment." }, "percentTraffic": { "type": "integer", "description": "The percent (0-100) of traffic diverted to a canary deployment." }, "stageVariableOverrides": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values." }, "useStageCache": { "type": "boolean", "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." } }, "type": "object" }, "azure-native:awsconnector:CanarySettingResponse": { "description": "Definition of CanarySetting", "properties": { "deploymentId": { "type": "string", "description": "The ID of the canary deployment." }, "percentTraffic": { "type": "integer", "description": "The percent (0-100) of traffic diverted to a canary deployment." }, "stageVariableOverrides": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values." }, "useStageCache": { "type": "boolean", "description": "A Boolean flag to indicate whether the canary deployment uses the stage cache or not." } }, "type": "object" }, "azure-native:awsconnector:Capabilities": { "description": "Capabilities enum", "type": "string", "enum": [ { "name": "CAPABILITY_AUTO_EXPAND", "description": "Capabilities enum CAPABILITY_AUTO_EXPAND", "value": "CAPABILITY_AUTO_EXPAND" }, { "name": "CAPABILITY_IAM", "description": "Capabilities enum CAPABILITY_IAM", "value": "CAPABILITY_IAM" }, { "name": "CAPABILITY_NAMED_IAM", "description": "Capabilities enum CAPABILITY_NAMED_IAM", "value": "CAPABILITY_NAMED_IAM" } ] }, "azure-native:awsconnector:CapacityProviderStrategyItem": { "description": "Definition of CapacityProviderStrategyItem", "properties": { "base": { "type": "integer", "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used." }, "capacityProvider": { "type": "string", "description": "The short name of the capacity provider." }, "weight": { "type": "integer", "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*." } }, "type": "object" }, "azure-native:awsconnector:CapacityProviderStrategyItemResponse": { "description": "Definition of CapacityProviderStrategyItem", "properties": { "base": { "type": "integer", "description": "The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used." }, "capacityProvider": { "type": "string", "description": "The short name of the capacity provider." }, "weight": { "type": "integer", "description": "The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*." } }, "type": "object" }, "azure-native:awsconnector:CapacityReservationPreference": { "description": "Property value", "type": "string", "enum": [ { "name": "None", "description": "CapacityReservationPreference enum none", "value": "none" }, { "name": "Open", "description": "CapacityReservationPreference enum open", "value": "open" } ] }, "azure-native:awsconnector:CapacityReservationPreferenceEnumValue": { "description": "Definition of CapacityReservationPreferenceEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CapacityReservationPreference" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CapacityReservationPreferenceEnumValueResponse": { "description": "Definition of CapacityReservationPreferenceEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CapacityReservationSpecificationResponse": { "description": "Definition of CapacityReservationSpecificationResponse", "properties": { "capacityReservationPreference": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityReservationPreferenceEnumValue", "description": "\u003cp\u003eDescribes the instance's Capacity Reservation preferences. Possible preferences include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eopen\u003c/code\u003e - The instance can run in any \u003ccode\u003eopen\u003c/code\u003e Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003enone\u003c/code\u003e - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "capacityReservationTarget": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityReservationTargetResponse", "description": "\u003cp\u003eInformation about the targeted Capacity Reservation or Capacity Reservation group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CapacityReservationSpecificationResponseResponse": { "description": "Definition of CapacityReservationSpecificationResponse", "properties": { "capacityReservationPreference": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityReservationPreferenceEnumValueResponse", "description": "\u003cp\u003eDescribes the instance's Capacity Reservation preferences. Possible preferences include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eopen\u003c/code\u003e - The instance can run in any \u003ccode\u003eopen\u003c/code\u003e Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003enone\u003c/code\u003e - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "capacityReservationTarget": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CapacityReservationTargetResponseResponse", "description": "\u003cp\u003eInformation about the targeted Capacity Reservation or Capacity Reservation group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CapacityReservationTargetResponse": { "description": "Definition of CapacityReservationTargetResponse", "properties": { "capacityReservationId": { "type": "string", "description": "\u003cp\u003eThe ID of the targeted Capacity Reservation.\u003c/p\u003e" }, "capacityReservationResourceGroupArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the targeted Capacity Reservation group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CapacityReservationTargetResponseResponse": { "description": "Definition of CapacityReservationTargetResponse", "properties": { "capacityReservationId": { "type": "string", "description": "\u003cp\u003eThe ID of the targeted Capacity Reservation.\u003c/p\u003e" }, "capacityReservationResourceGroupArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the targeted Capacity Reservation group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Certificate": { "description": "Definition of Certificate", "properties": { "certificateArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the certificate." }, "data": { "type": "string", "description": "\u003cp\u003eThe Base64-encoded certificate data required to communicate with your cluster. Add this to the \u003ccode\u003ecertificate-authority-data\u003c/code\u003e section of the \u003ccode\u003ekubeconfig\u003c/code\u003e file for your cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CertificateDetails": { "description": "Definition of CertificateDetails", "properties": { "caIdentifier": { "type": "string", "description": "The CA identifier of the CA certificate used for the DB instance's server certificate." }, "validTill": { "type": "string", "description": "The expiration date of the DB instance’s server certificate." } }, "type": "object" }, "azure-native:awsconnector:CertificateDetailsResponse": { "description": "Definition of CertificateDetails", "properties": { "caIdentifier": { "type": "string", "description": "The CA identifier of the CA certificate used for the DB instance's server certificate." }, "validTill": { "type": "string", "description": "The expiration date of the DB instance’s server certificate." } }, "type": "object" }, "azure-native:awsconnector:CertificateResponse": { "description": "Definition of Certificate", "properties": { "data": { "type": "string", "description": "\u003cp\u003eThe Base64-encoded certificate data required to communicate with your cluster. Add this to the \u003ccode\u003ecertificate-authority-data\u003c/code\u003e section of the \u003ccode\u003ekubeconfig\u003c/code\u003e file for your cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CertificateResponseV1": { "description": "Definition of Certificate", "properties": { "certificateArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the certificate." } }, "type": "object" }, "azure-native:awsconnector:CertificateStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "EXPIRED", "description": "CertificateStatus enum EXPIRED", "value": "EXPIRED" }, { "name": "FAILED", "description": "CertificateStatus enum FAILED", "value": "FAILED" }, { "name": "INACTIVE", "description": "CertificateStatus enum INACTIVE", "value": "INACTIVE" }, { "name": "ISSUED", "description": "CertificateStatus enum ISSUED", "value": "ISSUED" }, { "name": "PENDING_VALIDATION", "description": "CertificateStatus enum PENDING_VALIDATION", "value": "PENDING_VALIDATION" }, { "name": "REVOKED", "description": "CertificateStatus enum REVOKED", "value": "REVOKED" }, { "name": "VALIDATION_TIMED_OUT", "description": "CertificateStatus enum VALIDATION_TIMED_OUT", "value": "VALIDATION_TIMED_OUT" } ] }, "azure-native:awsconnector:CertificateStatusEnumValue": { "description": "Definition of CertificateStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CertificateStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CertificateStatusEnumValueResponse": { "description": "Definition of CertificateStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CertificateType": { "description": "Property value", "type": "string", "enum": [ { "name": "AMAZON_ISSUED", "description": "CertificateType enum AMAZON_ISSUED", "value": "AMAZON_ISSUED" }, { "name": "IMPORTED", "description": "CertificateType enum IMPORTED", "value": "IMPORTED" }, { "name": "PRIVATE", "description": "CertificateType enum PRIVATE", "value": "PRIVATE" } ] }, "azure-native:awsconnector:CertificateTypeEnumValue": { "description": "Definition of CertificateTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CertificateType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CertificateTypeEnumValueResponse": { "description": "Definition of CertificateTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ChangeProgressDetails": { "description": "Definition of ChangeProgressDetails", "properties": { "changeId": { "type": "string", "description": "\u003cp\u003eThe ID of the configuration change.\u003c/p\u003e" }, "configChangeStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigChangeStatusEnumValue", "description": "\u003cp\u003eThe current status of the configuration change.\u003c/p\u003e" }, "initiatedBy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InitiatedByEnumValue", "description": "\u003cp\u003eThe IAM principal who initiated the configuration change.\u003c/p\u003e" }, "lastUpdatedTime": { "type": "string", "description": "\u003cp\u003eThe last time that the configuration change was updated.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eA message corresponding to the status of the configuration change.\u003c/p\u003e" }, "startTime": { "type": "string", "description": "\u003cp\u003eThe time that the configuration change was initiated, in Universal Coordinated Time (UTC).\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ChangeProgressDetailsResponse": { "description": "Definition of ChangeProgressDetails", "properties": { "changeId": { "type": "string", "description": "\u003cp\u003eThe ID of the configuration change.\u003c/p\u003e" }, "configChangeStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigChangeStatusEnumValueResponse", "description": "\u003cp\u003eThe current status of the configuration change.\u003c/p\u003e" }, "initiatedBy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InitiatedByEnumValueResponse", "description": "\u003cp\u003eThe IAM principal who initiated the configuration change.\u003c/p\u003e" }, "lastUpdatedTime": { "type": "string", "description": "\u003cp\u003eThe last time that the configuration change was updated.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eA message corresponding to the status of the configuration change.\u003c/p\u003e" }, "startTime": { "type": "string", "description": "\u003cp\u003eThe time that the configuration change was initiated, in Universal Coordinated Time (UTC).\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CidrRoutingConfig": { "description": "Definition of CidrRoutingConfig", "properties": { "collectionId": { "type": "string", "description": "\u003cp\u003eThe CIDR collection ID.\u003c/p\u003e" }, "locationName": { "type": "string", "description": "\u003cp\u003eThe CIDR collection location name.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CidrRoutingConfigResponse": { "description": "Definition of CidrRoutingConfig", "properties": { "collectionId": { "type": "string", "description": "\u003cp\u003eThe CIDR collection ID.\u003c/p\u003e" }, "locationName": { "type": "string", "description": "\u003cp\u003eThe CIDR collection location name.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CloudFormationStackProperties": { "description": "Definition of CloudFormationStack", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudFormationStackProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CloudFormationStackPropertiesResponse": { "description": "Definition of CloudFormationStack", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudFormationStackPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CloudFormationStackSetProperties": { "description": "Definition of CloudFormationStackSet", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudFormationStackSetProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CloudFormationStackSetPropertiesResponse": { "description": "Definition of CloudFormationStackSet", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudFormationStackSetPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CloudFrontDistributionProperties": { "description": "Definition of CloudFrontDistribution", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudFrontDistributionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CloudFrontDistributionPropertiesResponse": { "description": "Definition of CloudFrontDistribution", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudFrontDistributionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CloudTrailTrailProperties": { "description": "Definition of CloudTrailTrail", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudTrailTrailProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CloudTrailTrailPropertiesResponse": { "description": "Definition of CloudTrailTrail", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudTrailTrailPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CloudWatchAlarmProperties": { "description": "Definition of CloudWatchAlarm", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudWatchAlarmProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CloudWatchAlarmPropertiesResponse": { "description": "Definition of CloudWatchAlarm", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCloudWatchAlarmPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CloudWatchLogsConfig": { "description": "Definition of CloudWatchLogsConfig", "properties": { "groupName": { "type": "string", "description": "\u003cp\u003e The group name of the logs in CloudWatch Logs. For more information, see \u003ca href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'\u003eWorking with Log Groups and Log Streams\u003c/a\u003e. \u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogsConfigStatusTypeEnumValue", "description": "\u003cp\u003eThe current status of the logs in CloudWatch Logs for a build project. Valid values are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e: CloudWatch Logs are enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e: CloudWatch Logs are not enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "streamName": { "type": "string", "description": "\u003cp\u003e The prefix of the stream name of the CloudWatch Logs. For more information, see \u003ca href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'\u003eWorking with Log Groups and Log Streams\u003c/a\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CloudWatchLogsConfigResponse": { "description": "Definition of CloudWatchLogsConfig", "properties": { "groupName": { "type": "string", "description": "\u003cp\u003e The group name of the logs in CloudWatch Logs. For more information, see \u003ca href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'\u003eWorking with Log Groups and Log Streams\u003c/a\u003e. \u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogsConfigStatusTypeEnumValueResponse", "description": "\u003cp\u003eThe current status of the logs in CloudWatch Logs for a build project. Valid values are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e: CloudWatch Logs are enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e: CloudWatch Logs are not enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "streamName": { "type": "string", "description": "\u003cp\u003e The prefix of the stream name of the CloudWatch Logs. For more information, see \u003ca href='https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html'\u003eWorking with Log Groups and Log Streams\u003c/a\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterConfig": { "description": "Definition of ClusterConfig", "properties": { "coldStorageOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ColdStorageOptions", "description": "\u003cp\u003eContainer for cold storage configuration options.\u003c/p\u003e" }, "dedicatedMasterCount": { "type": "integer", "description": "\u003cp\u003eNumber of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.\u003c/p\u003e" }, "dedicatedMasterEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether dedicated master nodes are enabled for the cluster.\u003ccode\u003eTrue\u003c/code\u003e if the cluster will use a dedicated master node.\u003ccode\u003eFalse\u003c/code\u003e if the cluster will not.\u003c/p\u003e" }, "dedicatedMasterType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenSearchPartitionInstanceTypeEnumValue", "description": "\u003cp\u003eOpenSearch Service instance type of the dedicated master nodes in the cluster.\u003c/p\u003e" }, "instanceCount": { "type": "integer", "description": "\u003cp\u003eNumber of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.\u003c/p\u003e" }, "instanceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenSearchPartitionInstanceTypeEnumValue", "description": "\u003cp\u003eInstance type of data nodes in the cluster.\u003c/p\u003e" }, "multiAZWithStandbyEnabled": { "type": "boolean", "description": "\u003cp\u003eA boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'\u003eConfiguring a multi-AZ domain in Amazon OpenSearch Service\u003c/a\u003e. \u003c/p\u003e" }, "warmCount": { "type": "integer", "description": "\u003cp\u003eThe number of warm nodes in the cluster.\u003c/p\u003e" }, "warmEnabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable warm storage for the cluster.\u003c/p\u003e" }, "warmType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenSearchWarmPartitionInstanceTypeEnumValue", "description": "\u003cp\u003eThe instance type for the cluster's warm nodes.\u003c/p\u003e" }, "zoneAwarenessConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ZoneAwarenessConfig", "description": "\u003cp\u003eContainer for zone awareness configuration options. Only required if \u003ccode\u003eZoneAwarenessEnabled\u003c/code\u003e is \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e" }, "zoneAwarenessEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether multiple Availability Zones are enabled. For more information, see \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'\u003eConfiguring a multi-AZ domain in Amazon OpenSearch Service\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterConfigResponse": { "description": "Definition of ClusterConfig", "properties": { "coldStorageOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ColdStorageOptionsResponse", "description": "\u003cp\u003eContainer for cold storage configuration options.\u003c/p\u003e" }, "dedicatedMasterCount": { "type": "integer", "description": "\u003cp\u003eNumber of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.\u003c/p\u003e" }, "dedicatedMasterEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether dedicated master nodes are enabled for the cluster.\u003ccode\u003eTrue\u003c/code\u003e if the cluster will use a dedicated master node.\u003ccode\u003eFalse\u003c/code\u003e if the cluster will not.\u003c/p\u003e" }, "dedicatedMasterType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenSearchPartitionInstanceTypeEnumValueResponse", "description": "\u003cp\u003eOpenSearch Service instance type of the dedicated master nodes in the cluster.\u003c/p\u003e" }, "instanceCount": { "type": "integer", "description": "\u003cp\u003eNumber of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.\u003c/p\u003e" }, "instanceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenSearchPartitionInstanceTypeEnumValueResponse", "description": "\u003cp\u003eInstance type of data nodes in the cluster.\u003c/p\u003e" }, "multiAZWithStandbyEnabled": { "type": "boolean", "description": "\u003cp\u003eA boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'\u003eConfiguring a multi-AZ domain in Amazon OpenSearch Service\u003c/a\u003e. \u003c/p\u003e" }, "warmCount": { "type": "integer", "description": "\u003cp\u003eThe number of warm nodes in the cluster.\u003c/p\u003e" }, "warmEnabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable warm storage for the cluster.\u003c/p\u003e" }, "warmType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OpenSearchWarmPartitionInstanceTypeEnumValueResponse", "description": "\u003cp\u003eThe instance type for the cluster's warm nodes.\u003c/p\u003e" }, "zoneAwarenessConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ZoneAwarenessConfigResponse", "description": "\u003cp\u003eContainer for zone awareness configuration options. Only required if \u003ccode\u003eZoneAwarenessEnabled\u003c/code\u003e is \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e" }, "zoneAwarenessEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether multiple Availability Zones are enabled. For more information, see \u003ca href='https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html'\u003eConfiguring a multi-AZ domain in Amazon OpenSearch Service\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterConfiguration": { "description": "Definition of ClusterConfiguration", "properties": { "executeCommandConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExecuteCommandConfiguration", "description": "The details of the execute command configuration. The details of the execute command configuration." } }, "type": "object" }, "azure-native:awsconnector:ClusterConfigurationResponse": { "description": "Definition of ClusterConfiguration", "properties": { "executeCommandConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExecuteCommandConfigurationResponse", "description": "The details of the execute command configuration. The details of the execute command configuration." } }, "type": "object" }, "azure-native:awsconnector:ClusterEndpointEncryptionType": { "description": "Property value", "type": "string", "enum": [ { "name": "NONE", "description": "ClusterEndpointEncryptionType enum NONE", "value": "NONE" }, { "name": "TLS", "description": "ClusterEndpointEncryptionType enum TLS", "value": "TLS" } ] }, "azure-native:awsconnector:ClusterEndpointEncryptionTypeEnumValue": { "description": "Definition of ClusterEndpointEncryptionTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ClusterEndpointEncryptionType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterEndpointEncryptionTypeEnumValueResponse": { "description": "Definition of ClusterEndpointEncryptionTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterHealth": { "description": "Definition of ClusterHealth", "properties": { "issues": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterIssue" }, "description": "\u003cp\u003eAn object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterHealthResponse": { "description": "Definition of ClusterHealth", "properties": { "issues": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterIssueResponse" }, "description": "\u003cp\u003eAn object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterIssue": { "description": "Definition of ClusterIssue", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterIssueCodeEnumValue", "description": "\u003cp\u003eThe error code of the issue.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eA description of the issue.\u003c/p\u003e" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe resource IDs that the issue relates to.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterIssueCode": { "description": "Property value", "type": "string", "enum": [ { "name": "AccessDenied", "description": "ClusterIssueCode enum AccessDenied", "value": "AccessDenied" }, { "name": "ClusterUnreachable", "description": "ClusterIssueCode enum ClusterUnreachable", "value": "ClusterUnreachable" }, { "name": "ConfigurationConflict", "description": "ClusterIssueCode enum ConfigurationConflict", "value": "ConfigurationConflict" }, { "name": "Ec2SecurityGroupNotFound", "description": "ClusterIssueCode enum Ec2SecurityGroupNotFound", "value": "Ec2SecurityGroupNotFound" }, { "name": "Ec2ServiceNotSubscribed", "description": "ClusterIssueCode enum Ec2ServiceNotSubscribed", "value": "Ec2ServiceNotSubscribed" }, { "name": "Ec2SubnetNotFound", "description": "ClusterIssueCode enum Ec2SubnetNotFound", "value": "Ec2SubnetNotFound" }, { "name": "IamRoleNotFound", "description": "ClusterIssueCode enum IamRoleNotFound", "value": "IamRoleNotFound" }, { "name": "InsufficientFreeAddresses", "description": "ClusterIssueCode enum InsufficientFreeAddresses", "value": "InsufficientFreeAddresses" }, { "name": "InternalFailure", "description": "ClusterIssueCode enum InternalFailure", "value": "InternalFailure" }, { "name": "KmsGrantRevoked", "description": "ClusterIssueCode enum KmsGrantRevoked", "value": "KmsGrantRevoked" }, { "name": "KmsKeyDisabled", "description": "ClusterIssueCode enum KmsKeyDisabled", "value": "KmsKeyDisabled" }, { "name": "KmsKeyMarkedForDeletion", "description": "ClusterIssueCode enum KmsKeyMarkedForDeletion", "value": "KmsKeyMarkedForDeletion" }, { "name": "KmsKeyNotFound", "description": "ClusterIssueCode enum KmsKeyNotFound", "value": "KmsKeyNotFound" }, { "name": "Other", "description": "ClusterIssueCode enum Other", "value": "Other" }, { "name": "ResourceLimitExceeded", "description": "ClusterIssueCode enum ResourceLimitExceeded", "value": "ResourceLimitExceeded" }, { "name": "ResourceNotFound", "description": "ClusterIssueCode enum ResourceNotFound", "value": "ResourceNotFound" }, { "name": "StsRegionalEndpointDisabled", "description": "ClusterIssueCode enum StsRegionalEndpointDisabled", "value": "StsRegionalEndpointDisabled" }, { "name": "UnsupportedVersion", "description": "ClusterIssueCode enum UnsupportedVersion", "value": "UnsupportedVersion" }, { "name": "VpcNotFound", "description": "ClusterIssueCode enum VpcNotFound", "value": "VpcNotFound" } ] }, "azure-native:awsconnector:ClusterIssueCodeEnumValue": { "description": "Definition of ClusterIssueCodeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ClusterIssueCode" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterIssueCodeEnumValueResponse": { "description": "Definition of ClusterIssueCodeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterIssueResponse": { "description": "Definition of ClusterIssue", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterIssueCodeEnumValueResponse", "description": "\u003cp\u003eThe error code of the issue.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eA description of the issue.\u003c/p\u003e" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe resource IDs that the issue relates to.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterSettings": { "description": "Definition of ClusterSettings", "properties": { "name": { "type": "string", "description": "The name of the cluster setting. The value is ``containerInsights`` ." }, "value": { "type": "string", "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)." } }, "type": "object" }, "azure-native:awsconnector:ClusterSettingsResponse": { "description": "Definition of ClusterSettings", "properties": { "name": { "type": "string", "description": "The name of the cluster setting. The value is ``containerInsights`` ." }, "value": { "type": "string", "description": "The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html)." } }, "type": "object" }, "azure-native:awsconnector:ClusterState": { "description": "Property value", "type": "string", "enum": [ { "name": "BOOTSTRAPPING", "description": "ClusterState enum BOOTSTRAPPING", "value": "BOOTSTRAPPING" }, { "name": "RUNNING", "description": "ClusterState enum RUNNING", "value": "RUNNING" }, { "name": "STARTING", "description": "ClusterState enum STARTING", "value": "STARTING" }, { "name": "TERMINATED", "description": "ClusterState enum TERMINATED", "value": "TERMINATED" }, { "name": "TERMINATED_WITH_ERRORS", "description": "ClusterState enum TERMINATED_WITH_ERRORS", "value": "TERMINATED_WITH_ERRORS" }, { "name": "TERMINATING", "description": "ClusterState enum TERMINATING", "value": "TERMINATING" }, { "name": "WAITING", "description": "ClusterState enum WAITING", "value": "WAITING" } ] }, "azure-native:awsconnector:ClusterStateChangeReason": { "description": "Definition of ClusterStateChangeReason", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStateChangeReasonCodeEnumValue", "description": "\u003cp\u003eThe programmatic code for the state change reason.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eThe descriptive message for the state change reason.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterStateChangeReasonCode": { "description": "Property value", "type": "string", "enum": [ { "name": "ALL_STEPS_COMPLETED", "description": "ClusterStateChangeReasonCode enum ALL_STEPS_COMPLETED", "value": "ALL_STEPS_COMPLETED" }, { "name": "BOOTSTRAP_FAILURE", "description": "ClusterStateChangeReasonCode enum BOOTSTRAP_FAILURE", "value": "BOOTSTRAP_FAILURE" }, { "name": "INSTANCE_FAILURE", "description": "ClusterStateChangeReasonCode enum INSTANCE_FAILURE", "value": "INSTANCE_FAILURE" }, { "name": "INSTANCE_FLEET_TIMEOUT", "description": "ClusterStateChangeReasonCode enum INSTANCE_FLEET_TIMEOUT", "value": "INSTANCE_FLEET_TIMEOUT" }, { "name": "INTERNAL_ERROR", "description": "ClusterStateChangeReasonCode enum INTERNAL_ERROR", "value": "INTERNAL_ERROR" }, { "name": "STEP_FAILURE", "description": "ClusterStateChangeReasonCode enum STEP_FAILURE", "value": "STEP_FAILURE" }, { "name": "USER_REQUEST", "description": "ClusterStateChangeReasonCode enum USER_REQUEST", "value": "USER_REQUEST" }, { "name": "VALIDATION_ERROR", "description": "ClusterStateChangeReasonCode enum VALIDATION_ERROR", "value": "VALIDATION_ERROR" } ] }, "azure-native:awsconnector:ClusterStateChangeReasonCodeEnumValue": { "description": "Definition of ClusterStateChangeReasonCodeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ClusterStateChangeReasonCode" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterStateChangeReasonCodeEnumValueResponse": { "description": "Definition of ClusterStateChangeReasonCodeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterStateChangeReasonResponse": { "description": "Definition of ClusterStateChangeReason", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStateChangeReasonCodeEnumValueResponse", "description": "\u003cp\u003eThe programmatic code for the state change reason.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eThe descriptive message for the state change reason.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterStateEnumValue": { "description": "Definition of ClusterStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ClusterState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterStateEnumValueResponse": { "description": "Definition of ClusterStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "ACTIVE", "description": "ClusterStatus enum ACTIVE", "value": "ACTIVE" }, { "name": "CREATING", "description": "ClusterStatus enum CREATING", "value": "CREATING" }, { "name": "DELETING", "description": "ClusterStatus enum DELETING", "value": "DELETING" }, { "name": "FAILED", "description": "ClusterStatus enum FAILED", "value": "FAILED" }, { "name": "PENDING", "description": "ClusterStatus enum PENDING", "value": "PENDING" }, { "name": "UPDATING", "description": "ClusterStatus enum UPDATING", "value": "UPDATING" } ] }, "azure-native:awsconnector:ClusterStatusEnumValue": { "description": "Definition of ClusterStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ClusterStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterStatusEnumValueResponse": { "description": "Definition of ClusterStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ClusterTimeline": { "description": "Definition of ClusterTimeline", "properties": { "creationDateTime": { "type": "string", "description": "\u003cp\u003eThe creation date and time of the cluster.\u003c/p\u003e" }, "endDateTime": { "type": "string", "description": "\u003cp\u003eThe date and time when the cluster was terminated.\u003c/p\u003e" }, "readyDateTime": { "type": "string", "description": "\u003cp\u003eThe date and time when the cluster was ready to run steps.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ClusterTimelineResponse": { "description": "Definition of ClusterTimeline", "properties": { "creationDateTime": { "type": "string", "description": "\u003cp\u003eThe creation date and time of the cluster.\u003c/p\u003e" }, "endDateTime": { "type": "string", "description": "\u003cp\u003eThe date and time when the cluster was terminated.\u003c/p\u003e" }, "readyDateTime": { "type": "string", "description": "\u003cp\u003eThe date and time when the cluster was ready to run steps.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Code": { "description": "Definition of Code", "properties": { "imageUri": { "type": "string", "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry." }, "s3Bucket": { "type": "string", "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account." }, "s3Key": { "type": "string", "description": "The Amazon S3 key of the deployment package." }, "s3ObjectVersion": { "type": "string", "description": "For versioned objects, the version of the deployment package object to use." }, "zipFile": { "type": "string", "description": "(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash. If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details." } }, "type": "object" }, "azure-native:awsconnector:CodeBuildProjectProperties": { "description": "Definition of CodeBuildProject", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCodeBuildProjectProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CodeBuildProjectPropertiesResponse": { "description": "Definition of CodeBuildProject", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCodeBuildProjectPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CodeBuildSourceCredentialsInfoProperties": { "description": "Definition of CodeBuildSourceCredentialsInfo", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCodeBuildSourceCredentialsInfoProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:CodeBuildSourceCredentialsInfoPropertiesResponse": { "description": "Definition of CodeBuildSourceCredentialsInfo", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsCodeBuildSourceCredentialsInfoPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:CodeResponse": { "description": "Definition of Code", "properties": { "imageUri": { "type": "string", "description": "URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry." }, "s3Bucket": { "type": "string", "description": "An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account." }, "s3Key": { "type": "string", "description": "The Amazon S3 key of the deployment package." }, "s3ObjectVersion": { "type": "string", "description": "For versioned objects, the version of the deployment package object to use." }, "zipFile": { "type": "string", "description": "(Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. For JSON, you must escape quotes and special characters such as newline (``\\n``) with a backslash. If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details." } }, "type": "object" }, "azure-native:awsconnector:CognitoOptions": { "description": "Definition of CognitoOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.\u003c/p\u003e" }, "identityPoolId": { "type": "string", "description": "\u003cp\u003eThe Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.\u003c/p\u003e" }, "roleArn": { "type": "string", "description": "\u003cp\u003eThe \u003ccode\u003eAmazonOpenSearchServiceCognitoAccess\u003c/code\u003e role that allows OpenSearch Service to configure your user pool and identity pool.\u003c/p\u003e" }, "userPoolId": { "type": "string", "description": "\u003cp\u003eThe Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CognitoOptionsResponse": { "description": "Definition of CognitoOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.\u003c/p\u003e" }, "identityPoolId": { "type": "string", "description": "\u003cp\u003eThe Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.\u003c/p\u003e" }, "roleArn": { "type": "string", "description": "\u003cp\u003eThe \u003ccode\u003eAmazonOpenSearchServiceCognitoAccess\u003c/code\u003e role that allows OpenSearch Service to configure your user pool and identity pool.\u003c/p\u003e" }, "userPoolId": { "type": "string", "description": "\u003cp\u003eThe Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CognitoUserPoolConfig": { "description": "Definition of CognitoUserPoolConfig", "properties": { "appIdClientRegex": { "type": "string", "description": "\u003cp\u003eA regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.\u003c/p\u003e" }, "awsRegion": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region in which the user pool was created.\u003c/p\u003e" }, "userPoolId": { "type": "string", "description": "\u003cp\u003eThe user pool ID.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CognitoUserPoolConfigResponse": { "description": "Definition of CognitoUserPoolConfig", "properties": { "appIdClientRegex": { "type": "string", "description": "\u003cp\u003eA regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.\u003c/p\u003e" }, "awsRegion": { "type": "string", "description": "\u003cp\u003eThe Amazon Web Services Region in which the user pool was created.\u003c/p\u003e" }, "userPoolId": { "type": "string", "description": "\u003cp\u003eThe user pool ID.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ColdStorageOptions": { "description": "Definition of ColdStorageOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ColdStorageOptionsResponse": { "description": "Definition of ColdStorageOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ComplianceExecutionSummary": { "description": "Definition of ComplianceExecutionSummary", "properties": { "executionId": { "type": "string", "description": "\u003cp\u003eAn ID created by the system when \u003ccode\u003ePutComplianceItems\u003c/code\u003e was called. For example, \u003ccode\u003eCommandID\u003c/code\u003e is a valid execution ID. You can use this ID in subsequent calls.\u003c/p\u003e" }, "executionTime": { "type": "string", "description": "\u003cp\u003eThe time the execution ran as a datetime object that is saved in the following format: \u003ccode\u003eyyyy-MM-dd'T'HH:mm:ss'Z'\u003c/code\u003e \u003c/p\u003e" }, "executionType": { "type": "string", "description": "\u003cp\u003eThe type of execution. For example, \u003ccode\u003eCommand\u003c/code\u003e is a valid execution type.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ComplianceExecutionSummaryResponse": { "description": "Definition of ComplianceExecutionSummary", "properties": { "executionId": { "type": "string", "description": "\u003cp\u003eAn ID created by the system when \u003ccode\u003ePutComplianceItems\u003c/code\u003e was called. For example, \u003ccode\u003eCommandID\u003c/code\u003e is a valid execution ID. You can use this ID in subsequent calls.\u003c/p\u003e" }, "executionTime": { "type": "string", "description": "\u003cp\u003eThe time the execution ran as a datetime object that is saved in the following format: \u003ccode\u003eyyyy-MM-dd'T'HH:mm:ss'Z'\u003c/code\u003e \u003c/p\u003e" }, "executionType": { "type": "string", "description": "\u003cp\u003eThe type of execution. For example, \u003ccode\u003eCommand\u003c/code\u003e is a valid execution type.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ComplianceSeverity": { "description": "Property value", "type": "string", "enum": [ { "name": "CRITICAL", "description": "ComplianceSeverity enum CRITICAL", "value": "CRITICAL" }, { "name": "HIGH", "description": "ComplianceSeverity enum HIGH", "value": "HIGH" }, { "name": "INFORMATIONAL", "description": "ComplianceSeverity enum INFORMATIONAL", "value": "INFORMATIONAL" }, { "name": "LOW", "description": "ComplianceSeverity enum LOW", "value": "LOW" }, { "name": "MEDIUM", "description": "ComplianceSeverity enum MEDIUM", "value": "MEDIUM" }, { "name": "UNSPECIFIED", "description": "ComplianceSeverity enum UNSPECIFIED", "value": "UNSPECIFIED" } ] }, "azure-native:awsconnector:ComplianceSeverityEnumValue": { "description": "Definition of ComplianceSeverityEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ComplianceSeverity" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ComplianceSeverityEnumValueResponse": { "description": "Definition of ComplianceSeverityEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ComplianceStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "COMPLIANT", "description": "ComplianceStatus enum COMPLIANT", "value": "COMPLIANT" }, { "name": "NON_COMPLIANT", "description": "ComplianceStatus enum NON_COMPLIANT", "value": "NON_COMPLIANT" } ] }, "azure-native:awsconnector:ComplianceStatusEnumValue": { "description": "Definition of ComplianceStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ComplianceStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ComplianceStatusEnumValueResponse": { "description": "Definition of ComplianceStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CompliantSummary": { "description": "Definition of CompliantSummary", "properties": { "compliantCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources that are compliant.\u003c/p\u003e" }, "severitySummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SeveritySummary", "description": "\u003cp\u003eA summary of the compliance severity by compliance type.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CompliantSummaryResponse": { "description": "Definition of CompliantSummary", "properties": { "compliantCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources that are compliant.\u003c/p\u003e" }, "severitySummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SeveritySummaryResponse", "description": "\u003cp\u003eA summary of the compliance severity by compliance type.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ComputeType": { "description": "Property value", "type": "string", "enum": [ { "name": "BUILD_GENERAL1_2XLARGE", "description": "ComputeType enum BUILD_GENERAL1_2XLARGE", "value": "BUILD_GENERAL1_2XLARGE" }, { "name": "BUILD_GENERAL1_LARGE", "description": "ComputeType enum BUILD_GENERAL1_LARGE", "value": "BUILD_GENERAL1_LARGE" }, { "name": "BUILD_GENERAL1_MEDIUM", "description": "ComputeType enum BUILD_GENERAL1_MEDIUM", "value": "BUILD_GENERAL1_MEDIUM" }, { "name": "BUILD_GENERAL1_SMALL", "description": "ComputeType enum BUILD_GENERAL1_SMALL", "value": "BUILD_GENERAL1_SMALL" }, { "name": "BUILD_GENERAL1_XLARGE", "description": "ComputeType enum BUILD_GENERAL1_XLARGE", "value": "BUILD_GENERAL1_XLARGE" }, { "name": "BUILD_LAMBDA_10GB", "description": "ComputeType enum BUILD_LAMBDA_10GB", "value": "BUILD_LAMBDA_10GB" }, { "name": "BUILD_LAMBDA_1GB", "description": "ComputeType enum BUILD_LAMBDA_1GB", "value": "BUILD_LAMBDA_1GB" }, { "name": "BUILD_LAMBDA_2GB", "description": "ComputeType enum BUILD_LAMBDA_2GB", "value": "BUILD_LAMBDA_2GB" }, { "name": "BUILD_LAMBDA_4GB", "description": "ComputeType enum BUILD_LAMBDA_4GB", "value": "BUILD_LAMBDA_4GB" }, { "name": "BUILD_LAMBDA_8GB", "description": "ComputeType enum BUILD_LAMBDA_8GB", "value": "BUILD_LAMBDA_8GB" } ] }, "azure-native:awsconnector:ComputeTypeEnumValue": { "description": "Definition of ComputeTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ComputeType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ComputeTypeEnumValueResponse": { "description": "Definition of ComputeTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Condition": { "description": "Definition of Condition", "properties": { "actionCondition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActionConditionModelProperties", "description": "A single action condition." }, "labelNameCondition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LabelNameConditionModelProperties", "description": "A single label name condition." } }, "type": "object" }, "azure-native:awsconnector:ConditionResponse": { "description": "Definition of Condition", "properties": { "actionCondition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActionConditionModelPropertiesResponse", "description": "A single action condition." }, "labelNameCondition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LabelNameConditionModelPropertiesResponse", "description": "A single label name condition." } }, "type": "object" }, "azure-native:awsconnector:ConfigChangeStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "ApplyingChanges", "description": "ConfigChangeStatus enum ApplyingChanges", "value": "ApplyingChanges" }, { "name": "Cancelled", "description": "ConfigChangeStatus enum Cancelled", "value": "Cancelled" }, { "name": "Completed", "description": "ConfigChangeStatus enum Completed", "value": "Completed" }, { "name": "Initializing", "description": "ConfigChangeStatus enum Initializing", "value": "Initializing" }, { "name": "Pending", "description": "ConfigChangeStatus enum Pending", "value": "Pending" }, { "name": "PendingUserInput", "description": "ConfigChangeStatus enum PendingUserInput", "value": "PendingUserInput" }, { "name": "Validating", "description": "ConfigChangeStatus enum Validating", "value": "Validating" }, { "name": "ValidationFailed", "description": "ConfigChangeStatus enum ValidationFailed", "value": "ValidationFailed" } ] }, "azure-native:awsconnector:ConfigChangeStatusEnumValue": { "description": "Definition of ConfigChangeStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ConfigChangeStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ConfigChangeStatusEnumValueResponse": { "description": "Definition of ConfigChangeStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ConfigServiceConfigurationRecorderProperties": { "description": "Definition of ConfigServiceConfigurationRecorder", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsConfigServiceConfigurationRecorderProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ConfigServiceConfigurationRecorderPropertiesResponse": { "description": "Definition of ConfigServiceConfigurationRecorder", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsConfigServiceConfigurationRecorderPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ConfigServiceConfigurationRecorderStatusProperties": { "description": "Definition of ConfigServiceConfigurationRecorderStatus", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsConfigServiceConfigurationRecorderStatusProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ConfigServiceConfigurationRecorderStatusPropertiesResponse": { "description": "Definition of ConfigServiceConfigurationRecorderStatus", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsConfigServiceConfigurationRecorderStatusPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ConfigServiceDeliveryChannelProperties": { "description": "Definition of ConfigServiceDeliveryChannel", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsConfigServiceDeliveryChannelProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ConfigServiceDeliveryChannelPropertiesResponse": { "description": "Definition of ConfigServiceDeliveryChannel", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsConfigServiceDeliveryChannelPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ConfigSnapshotDeliveryProperties": { "description": "Definition of ConfigSnapshotDeliveryProperties", "properties": { "deliveryFrequency": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MaximumExecutionFrequencyEnumValue", "description": "\u003cp\u003eThe frequency with which Config delivers configuration snapshots.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ConfigSnapshotDeliveryPropertiesResponse": { "description": "Definition of ConfigSnapshotDeliveryProperties", "properties": { "deliveryFrequency": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MaximumExecutionFrequencyEnumValueResponse", "description": "\u003cp\u003eThe frequency with which Config delivers configuration snapshots.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Configuration": { "description": "Definition of Configuration", "properties": { "classification": { "type": "string", "description": "\u003cp\u003eThe classification within a configuration.\u003c/p\u003e" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Configuration" }, "description": "\u003cp\u003eA list of additional configurations to apply within a configuration object.\u003c/p\u003e" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eA set of properties specified within a configuration classification.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ConfigurationOptionSetting": { "description": "Definition of ConfigurationOptionSetting", "properties": { "namespace": { "type": "string", "description": "A unique namespace that identifies the option's associated AWS resource." }, "optionName": { "type": "string", "description": "The name of the configuration option." }, "resourceName": { "type": "string", "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." }, "value": { "type": "string", "description": "The current value for the configuration option." } }, "type": "object" }, "azure-native:awsconnector:ConfigurationOptionSettingResponse": { "description": "Definition of ConfigurationOptionSetting", "properties": { "namespace": { "type": "string", "description": "A unique namespace that identifies the option's associated AWS resource." }, "optionName": { "type": "string", "description": "The name of the configuration option." }, "resourceName": { "type": "string", "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." }, "value": { "type": "string", "description": "The current value for the configuration option." } }, "type": "object" }, "azure-native:awsconnector:ConfigurationResponse": { "description": "Definition of Configuration", "properties": { "classification": { "type": "string", "description": "\u003cp\u003eThe classification within a configuration.\u003c/p\u003e" }, "configurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConfigurationResponse" }, "description": "\u003cp\u003eA list of additional configurations to apply within a configuration object.\u003c/p\u003e" }, "properties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\u003cp\u003eA set of properties specified within a configuration classification.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ConnectionTrackingSpecification": { "description": "Definition of ConnectionTrackingSpecification", "properties": { "tcpEstablishedTimeout": { "type": "integer", "description": "Property tcpEstablishedTimeout" }, "udpStreamTimeout": { "type": "integer", "description": "Property udpStreamTimeout" }, "udpTimeout": { "type": "integer", "description": "Property udpTimeout" } }, "type": "object" }, "azure-native:awsconnector:ConnectionTrackingSpecificationResponse": { "description": "Definition of ConnectionTrackingSpecification", "properties": { "tcpEstablishedTimeout": { "type": "integer", "description": "Property tcpEstablishedTimeout" }, "udpStreamTimeout": { "type": "integer", "description": "Property udpStreamTimeout" }, "udpTimeout": { "type": "integer", "description": "Property udpTimeout" } }, "type": "object" }, "azure-native:awsconnector:ConnectionTrackingSpecificationResponseResponse": { "description": "Definition of ConnectionTrackingSpecificationResponse", "properties": { "tcpEstablishedTimeout": { "type": "integer", "description": "\u003cp\u003eTimeout (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.\u003c/p\u003e", "default": 432000 }, "udpStreamTimeout": { "type": "integer", "description": "\u003cp\u003eTimeout (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.\u003c/p\u003e", "default": 180 }, "udpTimeout": { "type": "integer", "description": "\u003cp\u003eTimeout (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.\u003c/p\u003e", "default": 30 } }, "type": "object" }, "azure-native:awsconnector:ConnectorConfigResponse": { "description": "Definition of ConnectorConfigResponse", "properties": { "activationCode": { "type": "string", "description": "\u003cp\u003eA unique code associated with the cluster for registration purposes.\u003c/p\u003e" }, "activationExpiry": { "type": "string", "description": "\u003cp\u003eThe expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.\u003c/p\u003e" }, "activationId": { "type": "string", "description": "\u003cp\u003eA unique ID associated with the cluster for registration purposes.\u003c/p\u003e" }, "provider": { "type": "string", "description": "\u003cp\u003eThe cluster's cloud service provider.\u003c/p\u003e" }, "roleArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ConnectorConfigResponseResponse": { "description": "Definition of ConnectorConfigResponse", "properties": { "activationCode": { "type": "string", "description": "\u003cp\u003eA unique code associated with the cluster for registration purposes.\u003c/p\u003e" }, "activationExpiry": { "type": "string", "description": "\u003cp\u003eThe expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.\u003c/p\u003e" }, "activationId": { "type": "string", "description": "\u003cp\u003eA unique ID associated with the cluster for registration purposes.\u003c/p\u003e" }, "provider": { "type": "string", "description": "\u003cp\u003eThe cluster's cloud service provider.\u003c/p\u003e" }, "roleArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ContainerDefinition": { "description": "Definition of ContainerDefinition", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``COMMAND`` parameter to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array." }, "cpu": { "type": "integer", "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cpu-shares`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://aws.amazon.com/ec2/instance-types/) detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU." }, "credentialSpecs": { "type": "array", "items": { "type": "string" }, "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)." }, "dependsOn": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContainerDependency" }, "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website." }, "disableNetworking": { "type": "boolean", "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/). This parameter is not supported for Windows containers." }, "dnsSearchDomains": { "type": "array", "items": { "type": "string" }, "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--dns-search`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." }, "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--dns`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." }, "dockerLabels": { "$ref": "pulumi.json#/Any", "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--label`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" }, "dockerSecurityOptions": { "type": "array", "items": { "type": "string" }, "description": "A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--security-opt`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath'" }, "entryPoint": { "type": "array", "items": { "type": "string" }, "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--entrypoint`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint)." }, "environment": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeyValuePair" }, "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--env`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). We don't recommend that you use plaintext environment variables for sensitive information, such as credential data." }, "environmentFiles": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentFile" }, "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.docker.com/compose/env-file/). If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*." }, "essential": { "type": "boolean", "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*." }, "extraHosts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostEntry" }, "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--add-host`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode." }, "firelensConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FirelensConfiguration", "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." }, "healthCheck": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HealthCheck", "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer." }, "hostname": { "type": "string", "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--hostname`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode." }, "image": { "type": "string", "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``IMAGE`` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e:latest`` or ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``)." }, "interactive": { "type": "boolean", "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--interactive`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "links": { "type": "array", "items": { "type": "string" }, "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--link`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings." }, "linuxParameters": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LinuxParameters", "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html)." }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogConfiguration", "description": "The log configuration specification for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container." }, "memory": { "type": "integer", "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--memory`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers." }, "memoryReservation": { "type": "integer", "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--memory-reservation`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers." }, "mountPoints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MountPoint" }, "description": "The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--volume`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives." }, "name": { "type": "string", "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--name`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "portMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortMapping" }, "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to ``PortBindings`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--publish`` option to [docker run](https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses." }, "privileged": { "type": "boolean", "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--privileged`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers or tasks run on FARGATElong." }, "pseudoTerminal": { "type": "boolean", "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--tty`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "readonlyRootFilesystem": { "type": "boolean", "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--read-only`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." }, "repositoryCredentials": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RepositoryCredentials", "description": "The private repository authentication credentials to use. The repository credentials for private registry authentication." }, "resourceRequirements": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRequirement" }, "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU." }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Secret" }, "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." }, "startTimeout": { "type": "integer", "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds." }, "stopTimeout": { "type": "integer", "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds." }, "systemControls": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SystemControl" }, "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--sysctl`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections." }, "ulimits": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ulimit" }, "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--ulimit`` option to [docker run](https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` This parameter is not supported for Windows containers." }, "user": { "type": "string", "description": "The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--user`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + ``user`` + ``user:group`` + ``uid`` + ``uid:gid`` + ``user:gid`` + ``uid:group`` This parameter is not supported for Windows containers." }, "volumesFrom": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeFrom" }, "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--volumes-from`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "workingDirectory": { "type": "string", "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--workdir`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." } }, "type": "object" }, "azure-native:awsconnector:ContainerDefinitionResponse": { "description": "Definition of ContainerDefinition", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``COMMAND`` parameter to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array." }, "cpu": { "type": "integer", "description": "The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cpu-shares`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://aws.amazon.com/ec2/instance-types/) detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU." }, "credentialSpecs": { "type": "array", "items": { "type": "string" }, "description": "A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html)." }, "dependsOn": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContainerDependencyResponse" }, "description": "The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website." }, "disableNetworking": { "type": "boolean", "description": "When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/). This parameter is not supported for Windows containers." }, "dnsSearchDomains": { "type": "array", "items": { "type": "string" }, "description": "A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--dns-search`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." }, "dnsServers": { "type": "array", "items": { "type": "string" }, "description": "A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--dns`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." }, "dockerLabels": { "$ref": "pulumi.json#/Any", "description": "A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--label`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" }, "dockerSecurityOptions": { "type": "array", "items": { "type": "string" }, "description": "A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--security-opt`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath'" }, "entryPoint": { "type": "array", "items": { "type": "string" }, "description": "Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--entrypoint`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint)." }, "environment": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeyValuePairResponse" }, "description": "The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--env`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). We don't recommend that you use plaintext environment variables for sensitive information, such as credential data." }, "environmentFiles": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentFileResponse" }, "description": "A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.docker.com/compose/env-file/). If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*." }, "essential": { "type": "boolean", "description": "If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*." }, "extraHosts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostEntryResponse" }, "description": "A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--add-host`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode." }, "firelensConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FirelensConfigurationResponse", "description": "The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*." }, "healthCheck": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HealthCheckResponse", "description": "The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer." }, "hostname": { "type": "string", "description": "The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--hostname`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode." }, "image": { "type": "string", "description": "The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``IMAGE`` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e:latest`` or ``012345678910.dkr.ecr.\u003cregion-name\u003e.amazonaws.com/\u003crepository-name\u003e@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``)." }, "interactive": { "type": "boolean", "description": "When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--interactive`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "links": { "type": "array", "items": { "type": "string" }, "description": "The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--link`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings." }, "linuxParameters": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LinuxParametersResponse", "description": "Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html)." }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogConfigurationResponse", "description": "The log configuration specification for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container." }, "memory": { "type": "integer", "description": "The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--memory`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers." }, "memoryReservation": { "type": "integer", "description": "The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--memory-reservation`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers." }, "mountPoints": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MountPointResponse" }, "description": "The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--volume`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives." }, "name": { "type": "string", "description": "The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--name`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "portMappings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortMappingResponse" }, "description": "The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to ``PortBindings`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--publish`` option to [docker run](https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses." }, "privileged": { "type": "boolean", "description": "When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--privileged`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers or tasks run on FARGATElong." }, "pseudoTerminal": { "type": "boolean", "description": "When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--tty`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "readonlyRootFilesystem": { "type": "boolean", "description": "When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--read-only`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers." }, "repositoryCredentials": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RepositoryCredentialsResponse", "description": "The private repository authentication credentials to use. The repository credentials for private registry authentication." }, "resourceRequirements": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResourceRequirementResponse" }, "description": "The type and amount of a resource to assign to a container. The only supported resource is a GPU." }, "secrets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SecretResponse" }, "description": "The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." }, "startTimeout": { "type": "integer", "description": "Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds." }, "stopTimeout": { "type": "integer", "description": "Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds." }, "systemControls": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SystemControlResponse" }, "description": "A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--sysctl`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections." }, "ulimits": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UlimitResponse" }, "description": "A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--ulimit`` option to [docker run](https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` This parameter is not supported for Windows containers." }, "user": { "type": "string", "description": "The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--user`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + ``user`` + ``user:group`` + ``uid`` + ``uid:gid`` + ``user:gid`` + ``uid:group`` This parameter is not supported for Windows containers." }, "volumesFrom": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeFromResponse" }, "description": "Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--volumes-from`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." }, "workingDirectory": { "type": "string", "description": "The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--workdir`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration)." } }, "type": "object" }, "azure-native:awsconnector:ContainerDependency": { "description": "Definition of ContainerDependency", "properties": { "condition": { "type": "string", "description": "The dependency condition of the container. The following are the available conditions and their behavior: + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup." }, "containerName": { "type": "string", "description": "The name of a container." } }, "type": "object" }, "azure-native:awsconnector:ContainerDependencyResponse": { "description": "Definition of ContainerDependency", "properties": { "condition": { "type": "string", "description": "The dependency condition of the container. The following are the available conditions and their behavior: + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup." }, "containerName": { "type": "string", "description": "The name of a container." } }, "type": "object" }, "azure-native:awsconnector:ContinuousBackupsStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "ContinuousBackupsStatus enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "ContinuousBackupsStatus enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:ContinuousBackupsStatusEnumValue": { "description": "Definition of ContinuousBackupsStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ContinuousBackupsStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ContinuousBackupsStatusEnumValueResponse": { "description": "Definition of ContinuousBackupsStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ContributorInsightsSpecification": { "description": "Definition of ContributorInsightsSpecification", "properties": { "enabled": { "type": "boolean", "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false)." } }, "type": "object" }, "azure-native:awsconnector:ContributorInsightsSpecificationResponse": { "description": "Definition of ContributorInsightsSpecification", "properties": { "enabled": { "type": "boolean", "description": "Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false)." } }, "type": "object" }, "azure-native:awsconnector:ControlPlanePlacementResponse": { "description": "Definition of ControlPlanePlacementResponse", "properties": { "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the placement group for the Kubernetes control plane instances.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ControlPlanePlacementResponseResponse": { "description": "Definition of ControlPlanePlacementResponse", "properties": { "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the placement group for the Kubernetes control plane instances.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Cookies": { "description": "Definition of Cookies", "properties": { "forward": { "type": "string", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element." }, "whitelistedNames": { "type": "array", "items": { "type": "string" }, "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:CookiesResponse": { "description": "Definition of Cookies", "properties": { "forward": { "type": "string", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element." }, "whitelistedNames": { "type": "array", "items": { "type": "string" }, "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:Coordinates": { "description": "Definition of Coordinates", "properties": { "latitude": { "type": "string", "description": "\u003cp\u003e Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90). \u003c/p\u003e" }, "longitude": { "type": "string", "description": "\u003cp\u003e Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180). \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CoordinatesResponse": { "description": "Definition of Coordinates", "properties": { "latitude": { "type": "string", "description": "\u003cp\u003e Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90). \u003c/p\u003e" }, "longitude": { "type": "string", "description": "\u003cp\u003e Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180). \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CorsConfiguration": { "description": "Definition of CorsConfiguration", "properties": { "corsRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CorsRule" }, "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration." } }, "type": "object" }, "azure-native:awsconnector:CorsConfigurationResponse": { "description": "Definition of CorsConfiguration", "properties": { "corsRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CorsRuleResponse" }, "description": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration." } }, "type": "object" }, "azure-native:awsconnector:CorsRule": { "description": "Definition of CorsRule", "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed." }, "allowedMethods": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CorsRuleAllowedMethods" } ] }, "description": "An HTTP method that you allow the origin to run. *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "One or more origins you want customers to be able to access the bucket from." }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object)." }, "id": { "type": "string", "description": "A unique identifier for this rule. The value must be no more than 255 characters." }, "maxAge": { "type": "integer", "description": "The time in seconds that your browser is to cache the preflight response for the specified resource." } }, "type": "object" }, "azure-native:awsconnector:CorsRuleAllowedMethods": { "description": "CorsRuleAllowedMethods enum", "type": "string", "enum": [ { "name": "DELETE", "description": "CorsRuleAllowedMethods enum DELETE", "value": "DELETE" }, { "name": "GET", "description": "CorsRuleAllowedMethods enum GET", "value": "GET" }, { "name": "HEAD", "description": "CorsRuleAllowedMethods enum HEAD", "value": "HEAD" }, { "name": "POST", "description": "CorsRuleAllowedMethods enum POST", "value": "POST" }, { "name": "PUT", "description": "CorsRuleAllowedMethods enum PUT", "value": "PUT" } ] }, "azure-native:awsconnector:CorsRuleResponse": { "description": "Definition of CorsRule", "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed." }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "An HTTP method that you allow the origin to run. *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE``" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "One or more origins you want customers to be able to access the bucket from." }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object)." }, "id": { "type": "string", "description": "A unique identifier for this rule. The value must be no more than 255 characters." }, "maxAge": { "type": "integer", "description": "The time in seconds that your browser is to cache the preflight response for the specified resource." } }, "type": "object" }, "azure-native:awsconnector:CpuOptions": { "description": "Definition of CpuOptions", "properties": { "amdSevSnp": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AmdSevSnpSpecificationEnumValue", "description": "\u003cp\u003eIndicates whether the instance is enabled for AMD SEV-SNP. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html'\u003eAMD SEV-SNP\u003c/a\u003e.\u003c/p\u003e" }, "coreCount": { "type": "integer", "description": "\u003cp\u003eThe number of CPU cores for the instance.\u003c/p\u003e" }, "threadsPerCore": { "type": "integer", "description": "\u003cp\u003eThe number of threads per CPU core.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CpuOptionsResponse": { "description": "Definition of CpuOptions", "properties": { "amdSevSnp": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AmdSevSnpSpecificationEnumValueResponse", "description": "\u003cp\u003eIndicates whether the instance is enabled for AMD SEV-SNP. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html'\u003eAMD SEV-SNP\u003c/a\u003e.\u003c/p\u003e" }, "coreCount": { "type": "integer", "description": "\u003cp\u003eThe number of CPU cores for the instance.\u003c/p\u003e" }, "threadsPerCore": { "type": "integer", "description": "\u003cp\u003eThe number of threads per CPU core.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CredentialProviderType": { "description": "Property value", "type": "string", "enum": [ { "name": "SECRETS_MANAGER", "description": "CredentialProviderType enum SECRETS_MANAGER", "value": "SECRETS_MANAGER" } ] }, "azure-native:awsconnector:CredentialProviderTypeEnumValue": { "description": "Definition of CredentialProviderTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CredentialProviderType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:CredentialProviderTypeEnumValueResponse": { "description": "Definition of CredentialProviderTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Criteria": { "description": "Definition of Criteria", "properties": { "regex": { "type": "string", "description": "The S3 object key for the AllowList." }, "s3WordsList": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3WordsList", "description": "The S3 location for the AllowList." } }, "type": "object" }, "azure-native:awsconnector:CriteriaBlockForJob": { "description": "Definition of CriteriaBlockForJob", "properties": { "and": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaForJob" }, "description": "\u003cp\u003eAn array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CriteriaBlockForJobResponse": { "description": "Definition of CriteriaBlockForJob", "properties": { "and": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaForJobResponse" }, "description": "\u003cp\u003eAn array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CriteriaForJob": { "description": "Definition of CriteriaForJob", "properties": { "simpleCriterion": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SimpleCriterionForJob", "description": "\u003cp\u003eA property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.\u003c/p\u003e" }, "tagCriterion": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagCriterionForJob", "description": "\u003cp\u003eA tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CriteriaForJobResponse": { "description": "Definition of CriteriaForJob", "properties": { "simpleCriterion": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SimpleCriterionForJobResponse", "description": "\u003cp\u003eA property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.\u003c/p\u003e" }, "tagCriterion": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagCriterionForJobResponse", "description": "\u003cp\u003eA tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:CriteriaResponse": { "description": "Definition of Criteria", "properties": { "regex": { "type": "string", "description": "The S3 object key for the AllowList." }, "s3WordsList": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3WordsListResponse", "description": "The S3 location for the AllowList." } }, "type": "object" }, "azure-native:awsconnector:Csv": { "description": "Definition of Csv", "properties": { "delimiter": { "type": "string", "description": "The delimiter used for separating items in the CSV file being imported." }, "headerList": { "type": "array", "items": { "type": "string" }, "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header." } }, "type": "object" }, "azure-native:awsconnector:CsvResponse": { "description": "Definition of Csv", "properties": { "delimiter": { "type": "string", "description": "The delimiter used for separating items in the CSV file being imported." }, "headerList": { "type": "array", "items": { "type": "string" }, "description": "List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header." } }, "type": "object" }, "azure-native:awsconnector:CustomAction": { "description": "Definition of CustomAction", "properties": { "actionDefinition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActionDefinition", "description": "Property actionDefinition" }, "actionName": { "type": "string", "description": "Property actionName" } }, "type": "object" }, "azure-native:awsconnector:CustomActionResponse": { "description": "Definition of CustomAction", "properties": { "actionDefinition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActionDefinitionResponse", "description": "Property actionDefinition" }, "actionName": { "type": "string", "description": "Property actionName" } }, "type": "object" }, "azure-native:awsconnector:CustomActionResponseV1": { "description": "Definition of CustomAction", "properties": { "actionDefinition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ActionDefinitionResponseV1", "description": "Property actionDefinition" }, "actionName": { "type": "string", "description": "Property actionName" } }, "type": "object" }, "azure-native:awsconnector:CustomErrorResponse": { "description": "Definition of CustomErrorResponse", "properties": { "errorCachingMinTTL": { "type": "integer", "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", "default": 300 }, "errorCode": { "type": "integer", "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration." }, "responseCode": { "type": "integer", "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors. + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down. If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``." }, "responsePagePath": { "type": "string", "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``. + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable." } }, "type": "object" }, "azure-native:awsconnector:CustomErrorResponseResponse": { "description": "Definition of CustomErrorResponse", "properties": { "errorCachingMinTTL": { "type": "integer", "description": "The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*.", "default": 300 }, "errorCode": { "type": "integer", "description": "The HTTP status code for which you want to specify a custom error page and/or a caching duration." }, "responseCode": { "type": "integer", "description": "The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors. + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down. If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``." }, "responsePagePath": { "type": "string", "description": "The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``. + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable." } }, "type": "object" }, "azure-native:awsconnector:CustomOriginConfigResponse": { "description": "Definition of CustomOriginConfig", "properties": { "httpPort": { "type": "integer", "description": "The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on.", "default": 80 }, "httpsPort": { "type": "integer", "description": "The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on.", "default": 443 }, "originKeepaliveTimeout": { "type": "integer", "description": "Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*.", "default": 5 }, "originProtocolPolicy": { "type": "string", "description": "Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: + ``http-only`` – CloudFront always uses HTTP to connect to the origin. + ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. + ``https-only`` – CloudFront always uses HTTPS to connect to the origin." }, "originReadTimeout": { "type": "integer", "description": "Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*.", "default": 30 }, "originSSLProtocols": { "type": "array", "items": { "type": "string" }, "description": "Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. 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*." } }, "type": "object" }, "azure-native:awsconnector:DBClusterRole": { "description": "Definition of DBClusterRole", "properties": { "featureName": { "type": "string", "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference." }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster." } }, "type": "object" }, "azure-native:awsconnector:DBClusterRoleResponse": { "description": "Definition of DBClusterRole", "properties": { "featureName": { "type": "string", "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference." }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster." } }, "type": "object" }, "azure-native:awsconnector:DBInstanceRole": { "description": "Definition of DBInstanceRole", "properties": { "featureName": { "type": "string", "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*." }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance." } }, "type": "object" }, "azure-native:awsconnector:DBInstanceRoleResponse": { "description": "Definition of DBInstanceRole", "properties": { "featureName": { "type": "string", "description": "The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*." }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance." } }, "type": "object" }, "azure-native:awsconnector:DBSnapshotAttribute": { "description": "Definition of DBSnapshotAttribute", "properties": { "attributeName": { "type": "string", "description": "\u003cp\u003eThe name of the manual DB snapshot attribute.\u003c/p\u003e \u003cp\u003eThe attribute named \u003ccode\u003erestore\u003c/code\u003e refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the \u003ccode\u003eModifyDBSnapshotAttribute\u003c/code\u003e API action.\u003c/p\u003e" }, "attributeValues": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe value or values for the manual DB snapshot attribute.\u003c/p\u003e \u003cp\u003eIf the \u003ccode\u003eAttributeName\u003c/code\u003e field is set to \u003ccode\u003erestore\u003c/code\u003e, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of \u003ccode\u003eall\u003c/code\u003e is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:DBSnapshotAttributeResponse": { "description": "Definition of DBSnapshotAttribute", "properties": { "attributeName": { "type": "string", "description": "\u003cp\u003eThe name of the manual DB snapshot attribute.\u003c/p\u003e \u003cp\u003eThe attribute named \u003ccode\u003erestore\u003c/code\u003e refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the \u003ccode\u003eModifyDBSnapshotAttribute\u003c/code\u003e API action.\u003c/p\u003e" }, "attributeValues": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe value or values for the manual DB snapshot attribute.\u003c/p\u003e \u003cp\u003eIf the \u003ccode\u003eAttributeName\u003c/code\u003e field is set to \u003ccode\u003erestore\u003c/code\u003e, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of \u003ccode\u003eall\u003c/code\u003e is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:DataExport": { "description": "Definition of DataExport", "properties": { "destination": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Destination", "description": "The place to store the data for an analysis. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket." }, "outputSchemaVersion": { "type": "string", "description": "The version of the output schema to use when exporting data. Must be ``V_1``." } }, "type": "object" }, "azure-native:awsconnector:DataExportResponse": { "description": "Definition of DataExport", "properties": { "destination": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DestinationResponse", "description": "The place to store the data for an analysis. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket." }, "outputSchemaVersion": { "type": "string", "description": "The version of the output schema to use when exporting data. Must be ``V_1``." } }, "type": "object" }, "azure-native:awsconnector:DataResource": { "description": "Definition of DataResource", "properties": { "type": { "type": "string", "description": "The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources." }, "values": { "type": "array", "items": { "type": "string" }, "description": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects." } }, "type": "object" }, "azure-native:awsconnector:DataResourceResponse": { "description": "Definition of DataResource", "properties": { "type": { "type": "string", "description": "The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources." }, "values": { "type": "array", "items": { "type": "string" }, "description": "An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects." } }, "type": "object" }, "azure-native:awsconnector:DataSourceLevelMetricsBehavior": { "description": "Property value", "type": "string", "enum": [ { "name": "FULL_REQUEST_DATA_SOURCE_METRICS", "description": "DataSourceLevelMetricsBehavior enum FULL_REQUEST_DATA_SOURCE_METRICS", "value": "FULL_REQUEST_DATA_SOURCE_METRICS" }, { "name": "PER_DATA_SOURCE_METRICS", "description": "DataSourceLevelMetricsBehavior enum PER_DATA_SOURCE_METRICS", "value": "PER_DATA_SOURCE_METRICS" } ] }, "azure-native:awsconnector:DataSourceLevelMetricsBehaviorEnumValue": { "description": "Definition of DataSourceLevelMetricsBehaviorEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DataSourceLevelMetricsBehavior" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DataSourceLevelMetricsBehaviorEnumValueResponse": { "description": "Definition of DataSourceLevelMetricsBehaviorEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DataType": { "description": "The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``.", "type": "string", "enum": [ { "name": "AwsEc2Image", "description": "DataType enum aws:ec2:image", "value": "aws:ec2:image" }, { "name": "text", "description": "DataType enum text", "value": "text" } ] }, "azure-native:awsconnector:DatabaseMigrationServiceReplicationInstanceProperties": { "description": "Definition of DatabaseMigrationServiceReplicationInstance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDatabaseMigrationServiceReplicationInstanceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:DatabaseMigrationServiceReplicationInstancePropertiesResponse": { "description": "Definition of DatabaseMigrationServiceReplicationInstance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDatabaseMigrationServiceReplicationInstancePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:DaxClusterEndpoint": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "\u003cp\u003eThe DNS hostname of the endpoint.\u003c/p\u003e" }, "port": { "type": "integer", "description": "\u003cp\u003eThe port number that applications should use to connect to the endpoint.\u003c/p\u003e" }, "url": { "type": "string", "description": "\u003cp\u003eThe URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:DaxClusterEndpointResponse": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "\u003cp\u003eThe DNS hostname of the endpoint.\u003c/p\u003e" }, "port": { "type": "integer", "description": "\u003cp\u003eThe port number that applications should use to connect to the endpoint.\u003c/p\u003e" }, "url": { "type": "string", "description": "\u003cp\u003eThe URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:DaxClusterNotificationConfiguration": { "description": "Definition of NotificationConfiguration", "properties": { "topicArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) that identifies the topic. \u003c/p\u003e" }, "topicStatus": { "type": "string", "description": "\u003cp\u003eThe current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:DaxClusterNotificationConfigurationResponse": { "description": "Definition of NotificationConfiguration", "properties": { "topicArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) that identifies the topic. \u003c/p\u003e" }, "topicStatus": { "type": "string", "description": "\u003cp\u003eThe current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:DaxClusterProperties": { "description": "Definition of DaxCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDaxClusterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:DaxClusterPropertiesResponse": { "description": "Definition of DaxCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDaxClusterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:DeadLetterConfig": { "description": "Definition of DeadLetterConfig", "properties": { "targetArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic." } }, "type": "object" }, "azure-native:awsconnector:DeadLetterConfigResponse": { "description": "Definition of DeadLetterConfig", "properties": { "targetArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic." } }, "type": "object" }, "azure-native:awsconnector:DefaultAction": { "description": "Property value", "type": "string", "enum": [ { "name": "ALLOW", "description": "DefaultAction enum ALLOW", "value": "ALLOW" }, { "name": "DENY", "description": "DefaultAction enum DENY", "value": "DENY" } ] }, "azure-native:awsconnector:DefaultActionEnumValue": { "description": "Definition of DefaultActionEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DefaultAction" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DefaultActionEnumValueResponse": { "description": "Definition of DefaultActionEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DefaultBehavior": { "description": "Default handling for logs that don't match any of the specified filtering conditions.", "type": "string", "enum": [ { "name": "DROP", "description": "DefaultBehavior enum DROP", "value": "DROP" }, { "name": "KEEP", "description": "DefaultBehavior enum KEEP", "value": "KEEP" } ] }, "azure-native:awsconnector:DefaultCacheBehavior": { "description": "Definition of DefaultCacheBehavior", "properties": { "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin." }, "cachePolicyId": { "type": "string", "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." }, "cachedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly." }, "compress": { "type": "boolean", "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." }, "defaultTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 86400 }, "fieldLevelEncryptionId": { "type": "string", "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior." }, "forwardedValues": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ForwardedValues", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." }, "functionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FunctionAssociation" }, "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior." }, "lambdaFunctionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaFunctionAssociation" }, "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior." }, "maxTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 31536000 }, "minTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." }, "originRequestPolicyId": { "type": "string", "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." }, "realtimeLogConfigArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." }, "responseHeadersPolicyId": { "type": "string", "description": "The identifier for a response headers policy." }, "smoothStreaming": { "type": "boolean", "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." }, "targetOriginId": { "type": "string", "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior." }, "trustedKeyGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "trustedSigners": { "type": "array", "items": { "type": "string" }, "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "viewerProtocolPolicy": { "type": "string", "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:DefaultCacheBehaviorResponse": { "description": "Definition of DefaultCacheBehavior", "properties": { "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin." }, "cachePolicyId": { "type": "string", "description": "The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``." }, "cachedMethods": { "type": "array", "items": { "type": "string" }, "description": "A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly." }, "compress": { "type": "boolean", "description": "Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*." }, "defaultTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 86400 }, "fieldLevelEncryptionId": { "type": "string", "description": "The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior." }, "forwardedValues": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ForwardedValuesResponse", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers." }, "functionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FunctionAssociationResponse" }, "description": "A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior." }, "lambdaFunctionAssociations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaFunctionAssociationResponse" }, "description": "A complex type that contains zero or more Lambda@Edge function associations for a cache behavior." }, "maxTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*.", "default": 31536000 }, "minTTL": { "type": "integer", "description": "This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``)." }, "originRequestPolicyId": { "type": "string", "description": "The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*." }, "realtimeLogConfigArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*." }, "responseHeadersPolicyId": { "type": "string", "description": "The identifier for a response headers policy." }, "smoothStreaming": { "type": "boolean", "description": "Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``." }, "targetOriginId": { "type": "string", "description": "The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior." }, "trustedKeyGroups": { "type": "array", "items": { "type": "string" }, "description": "A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "trustedSigners": { "type": "array", "items": { "type": "string" }, "description": "We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." }, "viewerProtocolPolicy": { "type": "string", "description": "The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:DefaultRetention": { "description": "Definition of DefaultRetention", "properties": { "days": { "type": "integer", "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." }, "mode": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DefaultRetentionMode" } ], "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." }, "years": { "type": "integer", "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." } }, "type": "object" }, "azure-native:awsconnector:DefaultRetentionMode": { "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``.", "type": "string", "enum": [ { "name": "COMPLIANCE", "description": "DefaultRetentionMode enum COMPLIANCE", "value": "COMPLIANCE" }, { "name": "GOVERNANCE", "description": "DefaultRetentionMode enum GOVERNANCE", "value": "GOVERNANCE" } ] }, "azure-native:awsconnector:DefaultRetentionResponse": { "description": "Definition of DefaultRetention", "properties": { "days": { "type": "integer", "description": "The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." }, "mode": { "type": "string", "description": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." }, "years": { "type": "integer", "description": "The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``." } }, "type": "object" }, "azure-native:awsconnector:DeleteMarkerReplication": { "description": "Definition of DeleteMarkerReplication", "properties": { "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DeleteMarkerReplicationStatus" } ], "description": "Indicates whether to replicate delete markers. Disabled by default." } }, "type": "object" }, "azure-native:awsconnector:DeleteMarkerReplicationResponse": { "description": "Definition of DeleteMarkerReplication", "properties": { "status": { "type": "string", "description": "Indicates whether to replicate delete markers. Disabled by default." } }, "type": "object" }, "azure-native:awsconnector:DeleteMarkerReplicationStatus": { "description": "Indicates whether to replicate delete markers. Disabled by default.", "type": "string", "enum": [ { "name": "Disabled", "description": "DeleteMarkerReplicationStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "DeleteMarkerReplicationStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:DeploymentAlarms": { "description": "Definition of DeploymentAlarms", "properties": { "alarmNames": { "type": "array", "items": { "type": "string" }, "description": "One or more CloudWatch alarm names. Use a ',' to separate the alarms." }, "enable": { "type": "boolean", "description": "Determines whether to use the CloudWatch alarm option in the service deployment process." }, "rollback": { "type": "boolean", "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." } }, "type": "object" }, "azure-native:awsconnector:DeploymentAlarmsResponse": { "description": "Definition of DeploymentAlarms", "properties": { "alarmNames": { "type": "array", "items": { "type": "string" }, "description": "One or more CloudWatch alarm names. Use a ',' to separate the alarms." }, "enable": { "type": "boolean", "description": "Determines whether to use the CloudWatch alarm option in the service deployment process." }, "rollback": { "type": "boolean", "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." } }, "type": "object" }, "azure-native:awsconnector:DeploymentCircuitBreaker": { "description": "Definition of DeploymentCircuitBreaker", "properties": { "enable": { "type": "boolean", "description": "Determines whether to use the deployment circuit breaker logic for the service." }, "rollback": { "type": "boolean", "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." } }, "type": "object" }, "azure-native:awsconnector:DeploymentCircuitBreakerResponse": { "description": "Definition of DeploymentCircuitBreaker", "properties": { "enable": { "type": "boolean", "description": "Determines whether to use the deployment circuit breaker logic for the service." }, "rollback": { "type": "boolean", "description": "Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully." } }, "type": "object" }, "azure-native:awsconnector:DeploymentConfiguration": { "description": "Definition of DeploymentConfiguration", "properties": { "alarms": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentAlarms", "description": "Information about the CloudWatch alarms. One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update). For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*." }, "deploymentCircuitBreaker": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentCircuitBreaker", "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*." }, "maximumPercent": { "type": "integer", "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service." }, "minimumHealthyPercent": { "type": "integer", "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. For services that *do not* use a load balancer, the following should be noted: + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. For services that *do* use a load balancer, the following should be noted: + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service." } }, "type": "object" }, "azure-native:awsconnector:DeploymentConfigurationResponse": { "description": "Definition of DeploymentConfiguration", "properties": { "alarms": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentAlarmsResponse", "description": "Information about the CloudWatch alarms. One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update). For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*." }, "deploymentCircuitBreaker": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentCircuitBreakerResponse", "description": "The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*." }, "maximumPercent": { "type": "integer", "description": "If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service." }, "minimumHealthyPercent": { "type": "integer", "description": "If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. For services that *do not* use a load balancer, the following should be noted: + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. For services that *do* use a load balancer, the following should be noted: + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service." } }, "type": "object" }, "azure-native:awsconnector:DeploymentController": { "description": "Definition of DeploymentController", "properties": { "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DeploymentControllerType" } ], "description": "The deployment controller type to use. There are three deployment controller types available: + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service." } }, "type": "object" }, "azure-native:awsconnector:DeploymentControllerResponse": { "description": "Definition of DeploymentController", "properties": { "type": { "type": "string", "description": "The deployment controller type to use. There are three deployment controller types available: + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service." } }, "type": "object" }, "azure-native:awsconnector:DeploymentControllerType": { "description": "The deployment controller type to use. There are three deployment controller types available: + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service.", "type": "string", "enum": [ { "name": "CODE_DEPLOY", "description": "DeploymentControllerType enum CODE_DEPLOY", "value": "CODE_DEPLOY" }, { "name": "ECS", "description": "DeploymentControllerType enum ECS", "value": "ECS" }, { "name": "EXTERNAL", "description": "DeploymentControllerType enum EXTERNAL", "value": "EXTERNAL" } ] }, "azure-native:awsconnector:DeploymentStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "COMPLETED", "description": "DeploymentStatus enum COMPLETED", "value": "COMPLETED" }, { "name": "ELIGIBLE", "description": "DeploymentStatus enum ELIGIBLE", "value": "ELIGIBLE" }, { "name": "IN_PROGRESS", "description": "DeploymentStatus enum IN_PROGRESS", "value": "IN_PROGRESS" }, { "name": "NOT_ELIGIBLE", "description": "DeploymentStatus enum NOT_ELIGIBLE", "value": "NOT_ELIGIBLE" }, { "name": "PENDING_UPDATE", "description": "DeploymentStatus enum PENDING_UPDATE", "value": "PENDING_UPDATE" } ] }, "azure-native:awsconnector:DeploymentStatusEnumValue": { "description": "Definition of DeploymentStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DeploymentStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DeploymentStatusEnumValueResponse": { "description": "Definition of DeploymentStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DeploymentTargets": { "description": "Definition of DeploymentTargets", "properties": { "accountFilterType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DeploymentTargetsAccountFilterType" } ], "description": "The filter type you want to apply on organizational units and accounts." }, "accounts": { "type": "array", "items": { "type": "string" }, "description": "AWS accounts that you want to create stack instances in the specified Region(s) for." }, "accountsUrl": { "type": "string", "description": "Returns the value of the AccountsUrl property." }, "organizationalUnitIds": { "type": "array", "items": { "type": "string" }, "description": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys." } }, "type": "object" }, "azure-native:awsconnector:DeploymentTargetsAccountFilterType": { "description": "The filter type you want to apply on organizational units and accounts.", "type": "string", "enum": [ { "name": "DIFFERENCE", "description": "DeploymentTargetsAccountFilterType enum DIFFERENCE", "value": "DIFFERENCE" }, { "name": "INTERSECTION", "description": "DeploymentTargetsAccountFilterType enum INTERSECTION", "value": "INTERSECTION" }, { "name": "NONE", "description": "DeploymentTargetsAccountFilterType enum NONE", "value": "NONE" }, { "name": "UNION", "description": "DeploymentTargetsAccountFilterType enum UNION", "value": "UNION" } ] }, "azure-native:awsconnector:DeploymentTargetsResponse": { "description": "Definition of DeploymentTargets", "properties": { "accountFilterType": { "type": "string", "description": "The filter type you want to apply on organizational units and accounts." }, "accounts": { "type": "array", "items": { "type": "string" }, "description": "AWS accounts that you want to create stack instances in the specified Region(s) for." }, "accountsUrl": { "type": "string", "description": "Returns the value of the AccountsUrl property." }, "organizationalUnitIds": { "type": "array", "items": { "type": "string" }, "description": "The organization root ID or organizational unit (OU) IDs to which StackSets deploys." } }, "type": "object" }, "azure-native:awsconnector:Destination": { "description": "Definition of Destination", "properties": { "bucketAccountId": { "type": "string", "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes." }, "bucketArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the bucket to which data is exported." }, "format": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DestinationFormat" } ], "description": "Specifies the file format used when exporting data to Amazon S3. *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``" }, "prefix": { "type": "string", "description": "The prefix to use when exporting data. The prefix is prepended to all results." } }, "type": "object" }, "azure-native:awsconnector:DestinationFormat": { "description": "Specifies the file format used when exporting data to Amazon S3. *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``", "type": "string", "enum": [ { "name": "CSV", "description": "DestinationFormat enum CSV", "value": "CSV" }, { "name": "ORC", "description": "DestinationFormat enum ORC", "value": "ORC" }, { "name": "Parquet", "description": "DestinationFormat enum Parquet", "value": "Parquet" } ] }, "azure-native:awsconnector:DestinationOptionsModelProperties": { "description": "Definition of DestinationOptionsModelProperties", "properties": { "fileFormat": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FileFormat" } ], "description": "Property fileFormat" }, "hiveCompatiblePartitions": { "type": "boolean", "description": "Property hiveCompatiblePartitions" }, "perHourPartition": { "type": "boolean", "description": "Property perHourPartition" } }, "type": "object" }, "azure-native:awsconnector:DestinationOptionsModelPropertiesResponse": { "description": "Definition of DestinationOptionsModelProperties", "properties": { "fileFormat": { "type": "string", "description": "Property fileFormat" }, "hiveCompatiblePartitions": { "type": "boolean", "description": "Property hiveCompatiblePartitions" }, "perHourPartition": { "type": "boolean", "description": "Property perHourPartition" } }, "type": "object" }, "azure-native:awsconnector:DestinationResponse": { "description": "Definition of Destination", "properties": { "bucketAccountId": { "type": "string", "description": "The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes." }, "bucketArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the bucket to which data is exported." }, "format": { "type": "string", "description": "Specifies the file format used when exporting data to Amazon S3. *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet``" }, "prefix": { "type": "string", "description": "The prefix to use when exporting data. The prefix is prepended to all results." } }, "type": "object" }, "azure-native:awsconnector:Device": { "description": "Definition of Device", "properties": { "containerPath": { "type": "string", "description": "The path inside the container at which to expose the host device." }, "hostPath": { "type": "string", "description": "The path for the device on the host container instance." }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device." } }, "type": "object" }, "azure-native:awsconnector:DeviceResponse": { "description": "Definition of Device", "properties": { "containerPath": { "type": "string", "description": "The path inside the container at which to expose the host device." }, "hostPath": { "type": "string", "description": "The path for the device on the host container instance." }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device." } }, "type": "object" }, "azure-native:awsconnector:DeviceType": { "description": "Property value", "type": "string", "enum": [ { "name": "Ebs", "description": "DeviceType enum ebs", "value": "ebs" }, { "name": "InstanceStore", "description": "DeviceType enum instance-store", "value": "instance-store" } ] }, "azure-native:awsconnector:DeviceTypeEnumValue": { "description": "Definition of DeviceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DeviceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DeviceTypeEnumValueResponse": { "description": "Definition of DeviceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Dimension": { "description": "Definition of Dimension", "properties": { "key": { "type": "string", "description": "The name for the CW metric dimension that the metric filter creates. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:)." }, "name": { "type": "string", "description": "The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published." }, "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DimensionResponse": { "description": "Definition of Dimension", "properties": { "name": { "type": "string", "description": "The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published." }, "value": { "type": "string", "description": "The value for the dimension, from 1–255 characters in length." } }, "type": "object" }, "azure-native:awsconnector:DimensionResponseV1": { "description": "Definition of Dimension", "properties": { "key": { "type": "string", "description": "The name for the CW metric dimension that the metric filter creates. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:)." }, "value": { "type": "string", "description": "The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events." } }, "type": "object" }, "azure-native:awsconnector:DimensionResponseV2": { "description": "Definition of Dimension", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DimensionResponseV3": { "description": "Definition of Dimension", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Disk": { "description": "Definition of Disk", "properties": { "attachedTo": { "type": "string", "description": "Instance attached to the disk." }, "attachmentState": { "type": "string", "description": "Attachment state of the disk." }, "diskName": { "type": "string", "description": "The names to use for your new Lightsail disk." }, "iops": { "type": "integer", "description": "IOPS of disk." }, "isSystemDisk": { "type": "boolean", "description": "Is the Attached disk is the system disk of the Instance." }, "path": { "type": "string", "description": "Path of the disk attached to the instance." }, "sizeInGb": { "type": "string", "description": "Size of the disk attached to the Instance." } }, "type": "object" }, "azure-native:awsconnector:DiskResponse": { "description": "Definition of Disk", "properties": { "attachedTo": { "type": "string", "description": "Instance attached to the disk." }, "attachmentState": { "type": "string", "description": "Attachment state of the disk." }, "diskName": { "type": "string", "description": "The names to use for your new Lightsail disk." }, "iops": { "type": "integer", "description": "IOPS of disk." }, "isSystemDisk": { "type": "boolean", "description": "Is the Attached disk is the system disk of the Instance." }, "path": { "type": "string", "description": "Path of the disk attached to the instance." }, "sizeInGb": { "type": "string", "description": "Size of the disk attached to the Instance." } }, "type": "object" }, "azure-native:awsconnector:Distribution": { "description": "The method used to distribute log data to the destination, which can be either random or grouped by log stream.", "type": "string", "enum": [ { "name": "ByLogStream", "description": "Distribution enum ByLogStream", "value": "ByLogStream" }, { "name": "Random", "description": "Distribution enum Random", "value": "Random" } ] }, "azure-native:awsconnector:DistributionConfig": { "description": "Definition of DistributionConfig", "properties": { "aliases": { "type": "array", "items": { "type": "string" }, "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "cacheBehaviors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CacheBehavior" }, "description": "A complex type that contains zero or more ``CacheBehavior`` elements." }, "cnamEs": { "type": "array", "items": { "type": "string" }, "description": "Property cnamEs" }, "comment": { "type": "string", "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters." }, "continuousDeploymentPolicyId": { "type": "string", "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``." }, "customErrorResponses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CustomErrorResponse" }, "description": "A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*." }, "customOrigin": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LegacyCustomOrigin", "description": "Property customOrigin" }, "defaultCacheBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DefaultCacheBehavior", "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." }, "defaultRootObject": { "type": "string", "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*." }, "enabled": { "type": "boolean", "description": "From this field, you can enable or disable the selected distribution." }, "httpVersion": { "type": "string", "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).", "default": "http1.1" }, "ipV6Enabled": { "type": "boolean", "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request." }, "logging": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Logging", "description": "A complex type that controls whether access logs are written for the distribution. For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. A complex type that controls whether access logs are written for the distribution." }, "originGroups": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroups", "description": "A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution." }, "origins": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Origin" }, "description": "A complex type that contains information about origins for this distribution." }, "priceClass": { "type": "string", "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://aws.amazon.com/cloudfront/pricing/).", "default": "PriceClass_All" }, "restrictions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Restrictions", "description": "A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content." }, "s3Origin": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LegacyS3Origin", "description": "Property s3Origin" }, "staging": { "type": "boolean", "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution." }, "viewerCertificate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ViewerCertificate", "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*. + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.) + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.) All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``. For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*." }, "webACLId": { "type": "string", "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)." } }, "type": "object" }, "azure-native:awsconnector:DistributionConfigResponse": { "description": "Definition of DistributionConfig", "properties": { "aliases": { "type": "array", "items": { "type": "string" }, "description": "A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution." }, "cacheBehaviors": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CacheBehaviorResponse" }, "description": "A complex type that contains zero or more ``CacheBehavior`` elements." }, "cnamEs": { "type": "array", "items": { "type": "string" }, "description": "Property cnamEs" }, "comment": { "type": "string", "description": "A comment to describe the distribution. The comment cannot be longer than 128 characters." }, "continuousDeploymentPolicyId": { "type": "string", "description": "The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``." }, "customErrorResponses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CustomErrorResponseResponse" }, "description": "A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*." }, "customOrigin": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LegacyCustomOriginResponse", "description": "Property customOrigin" }, "defaultCacheBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DefaultCacheBehaviorResponse", "description": "A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior." }, "defaultRootObject": { "type": "string", "description": "The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*." }, "enabled": { "type": "boolean", "description": "From this field, you can enable or disable the selected distribution." }, "httpVersion": { "type": "string", "description": "(Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html).", "default": "http1.1" }, "ipV6Enabled": { "type": "boolean", "description": "If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request." }, "logging": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LoggingResponse", "description": "A complex type that controls whether access logs are written for the distribution. For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. A complex type that controls whether access logs are written for the distribution." }, "originGroups": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupsResponse", "description": "A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution." }, "origins": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginResponse" }, "description": "A complex type that contains information about origins for this distribution." }, "priceClass": { "type": "string", "description": "The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://aws.amazon.com/cloudfront/pricing/).", "default": "PriceClass_All" }, "restrictions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RestrictionsResponse", "description": "A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content." }, "s3Origin": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LegacyS3OriginResponse", "description": "Property s3Origin" }, "staging": { "type": "boolean", "description": "A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution." }, "viewerCertificate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ViewerCertificateResponse", "description": "A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*. + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.) + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.) All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``. For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*." }, "webACLId": { "type": "string", "description": "A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html)." } }, "type": "object" }, "azure-native:awsconnector:DockerVolumeConfiguration": { "description": "Definition of DockerVolumeConfiguration", "properties": { "autoprovision": { "type": "boolean", "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist. This field is only used if the ``scope`` is ``shared``." }, "driver": { "type": "string", "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxdriver`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/)." }, "driverOpts": { "$ref": "pulumi.json#/Any", "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxopt`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/)." }, "labels": { "$ref": "pulumi.json#/Any", "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxlabel`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/)." }, "scope": { "type": "string", "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops." } }, "type": "object" }, "azure-native:awsconnector:DockerVolumeConfigurationResponse": { "description": "Definition of DockerVolumeConfiguration", "properties": { "autoprovision": { "type": "boolean", "description": "If this value is ``true``, the Docker volume is created if it doesn't already exist. This field is only used if the ``scope`` is ``shared``." }, "driver": { "type": "string", "description": "The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxdriver`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/)." }, "driverOpts": { "$ref": "pulumi.json#/Any", "description": "A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxopt`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/)." }, "labels": { "$ref": "pulumi.json#/Any", "description": "Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxlabel`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/)." }, "scope": { "type": "string", "description": "The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops." } }, "type": "object" }, "azure-native:awsconnector:DomainEndpointOptions": { "description": "Definition of DomainEndpointOptions", "properties": { "customEndpoint": { "type": "string", "description": "\u003cp\u003eThe fully qualified URL for the custom endpoint.\u003c/p\u003e" }, "customEndpointCertificateArn": { "type": "string", "description": "\u003cp\u003eThe ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).\u003c/p\u003e" }, "customEndpointEnabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable a custom endpoint for the domain.\u003c/p\u003e" }, "enforceHTTPS": { "type": "boolean", "description": "\u003cp\u003eTrue to require that all traffic to the domain arrive over HTTPS.\u003c/p\u003e" }, "tlsSecurityPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TLSSecurityPolicyEnumValue", "description": "\u003cp\u003eSpecify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003ePolicy-Min-TLS-1-0-2019-07:\u003c/b\u003e TLS security policy that supports TLS version 1.0 to TLS version 1.2\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003ePolicy-Min-TLS-1-2-2019-07:\u003c/b\u003e TLS security policy that supports only TLS version 1.2\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003ePolicy-Min-TLS-1-2-PFS-2023-10:\u003c/b\u003e TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:DomainEndpointOptionsResponse": { "description": "Definition of DomainEndpointOptions", "properties": { "customEndpoint": { "type": "string", "description": "\u003cp\u003eThe fully qualified URL for the custom endpoint.\u003c/p\u003e" }, "customEndpointCertificateArn": { "type": "string", "description": "\u003cp\u003eThe ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).\u003c/p\u003e" }, "customEndpointEnabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable a custom endpoint for the domain.\u003c/p\u003e" }, "enforceHTTPS": { "type": "boolean", "description": "\u003cp\u003eTrue to require that all traffic to the domain arrive over HTTPS.\u003c/p\u003e" }, "tlsSecurityPolicy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TLSSecurityPolicyEnumValueResponse", "description": "\u003cp\u003eSpecify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003ePolicy-Min-TLS-1-0-2019-07:\u003c/b\u003e TLS security policy that supports TLS version 1.0 to TLS version 1.2\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003ePolicy-Min-TLS-1-2-2019-07:\u003c/b\u003e TLS security policy that supports only TLS version 1.2\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003ePolicy-Min-TLS-1-2-PFS-2023-10:\u003c/b\u003e TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:DomainProcessingStatusType": { "description": "Property value", "type": "string", "enum": [ { "name": "Active", "description": "DomainProcessingStatusType enum Active", "value": "Active" }, { "name": "Creating", "description": "DomainProcessingStatusType enum Creating", "value": "Creating" }, { "name": "Deleting", "description": "DomainProcessingStatusType enum Deleting", "value": "Deleting" }, { "name": "Isolated", "description": "DomainProcessingStatusType enum Isolated", "value": "Isolated" }, { "name": "Modifying", "description": "DomainProcessingStatusType enum Modifying", "value": "Modifying" }, { "name": "UpdatingServiceSoftware", "description": "DomainProcessingStatusType enum UpdatingServiceSoftware", "value": "UpdatingServiceSoftware" }, { "name": "UpgradingEngineVersion", "description": "DomainProcessingStatusType enum UpgradingEngineVersion", "value": "UpgradingEngineVersion" } ] }, "azure-native:awsconnector:DomainProcessingStatusTypeEnumValue": { "description": "Definition of DomainProcessingStatusTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DomainProcessingStatusType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DomainProcessingStatusTypeEnumValueResponse": { "description": "Definition of DomainProcessingStatusTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DomainType": { "description": "Property value", "type": "string", "enum": [ { "name": "Standard", "description": "DomainType enum standard", "value": "standard" }, { "name": "Vpc", "description": "DomainType enum vpc", "value": "vpc" } ] }, "azure-native:awsconnector:DomainTypeEnumValue": { "description": "Definition of DomainTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DomainType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DomainTypeEnumValueResponse": { "description": "Definition of DomainTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:DynamoDBContinuousBackupsDescriptionProperties": { "description": "Definition of DynamoDBContinuousBackupsDescription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDynamoDBContinuousBackupsDescriptionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:DynamoDBContinuousBackupsDescriptionPropertiesResponse": { "description": "Definition of DynamoDBContinuousBackupsDescription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDynamoDBContinuousBackupsDescriptionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:DynamoDBTableProperties": { "description": "Definition of DynamoDBTable", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDynamoDBTableProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:DynamoDBTablePropertiesResponse": { "description": "Definition of DynamoDBTable", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsDynamoDBTablePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EBSOptions": { "description": "Definition of EBSOptions", "properties": { "ebsEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.\u003c/p\u003e" }, "iops": { "type": "integer", "description": "\u003cp\u003eSpecifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the \u003ccode\u003egp3\u003c/code\u003e and provisioned IOPS EBS volume types.\u003c/p\u003e" }, "throughput": { "type": "integer", "description": "\u003cp\u003eSpecifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the \u003ccode\u003egp3\u003c/code\u003e volume type.\u003c/p\u003e" }, "volumeSize": { "type": "integer", "description": "\u003cp\u003eSpecifies the size (in GiB) of EBS volumes attached to data nodes.\u003c/p\u003e" }, "volumeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeTypeEnumValue", "description": "\u003cp\u003eSpecifies the type of EBS volumes attached to data nodes.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EBSOptionsResponse": { "description": "Definition of EBSOptions", "properties": { "ebsEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.\u003c/p\u003e" }, "iops": { "type": "integer", "description": "\u003cp\u003eSpecifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the \u003ccode\u003egp3\u003c/code\u003e and provisioned IOPS EBS volume types.\u003c/p\u003e" }, "throughput": { "type": "integer", "description": "\u003cp\u003eSpecifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the \u003ccode\u003egp3\u003c/code\u003e volume type.\u003c/p\u003e" }, "volumeSize": { "type": "integer", "description": "\u003cp\u003eSpecifies the size (in GiB) of EBS volumes attached to data nodes.\u003c/p\u003e" }, "volumeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeTypeEnumValueResponse", "description": "\u003cp\u003eSpecifies the type of EBS volumes attached to data nodes.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EBSTagSpecification": { "description": "Definition of EBSTagSpecification", "properties": { "propagateTags": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EBSTagSpecificationPropagateTags" } ], "description": "Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ``ServiceVolumeConfiguration``. If no value is specified, the tags aren't propagated." }, "resourceType": { "type": "string", "description": "The type of volume resource." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tag" }, "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used." } }, "type": "object" }, "azure-native:awsconnector:EBSTagSpecificationPropagateTags": { "description": "Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ``ServiceVolumeConfiguration``. If no value is specified, the tags aren't propagated.", "type": "string", "enum": [ { "name": "SERVICE", "description": "EBSTagSpecificationPropagateTags enum SERVICE", "value": "SERVICE" }, { "name": "TASK_DEFINITION", "description": "EBSTagSpecificationPropagateTags enum TASK_DEFINITION", "value": "TASK_DEFINITION" } ] }, "azure-native:awsconnector:EBSTagSpecificationResponse": { "description": "Definition of EBSTagSpecification", "properties": { "propagateTags": { "type": "string", "description": "Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ``ServiceVolumeConfiguration``. If no value is specified, the tags aren't propagated." }, "resourceType": { "type": "string", "description": "The type of volume resource." }, "tags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagResponse" }, "description": "The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used." } }, "type": "object" }, "azure-native:awsconnector:EFSVolumeConfiguration": { "description": "Definition of EFSVolumeConfiguration", "properties": { "authorizationConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthorizationConfig", "description": "The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system." }, "filesystemId": { "type": "string", "description": "The Amazon EFS file system ID to use." }, "rootDirectory": { "type": "string", "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point." }, "transitEncryption": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EFSVolumeConfigurationTransitEncryption" } ], "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*." }, "transitEncryptionPort": { "type": "integer", "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*." } }, "type": "object" }, "azure-native:awsconnector:EFSVolumeConfigurationResponse": { "description": "Definition of EFSVolumeConfiguration", "properties": { "authorizationConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AuthorizationConfigResponse", "description": "The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system." }, "filesystemId": { "type": "string", "description": "The Amazon EFS file system ID to use." }, "rootDirectory": { "type": "string", "description": "The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point." }, "transitEncryption": { "type": "string", "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*." }, "transitEncryptionPort": { "type": "integer", "description": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*." } }, "type": "object" }, "azure-native:awsconnector:EFSVolumeConfigurationTransitEncryption": { "description": "Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*.", "type": "string", "enum": [ { "name": "DISABLED", "description": "EFSVolumeConfigurationTransitEncryption enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "EFSVolumeConfigurationTransitEncryption enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:EbsBlockDevice": { "description": "Definition of EbsBlockDevice", "properties": { "deleteOnTermination": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the EBS volume is deleted on instance termination. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'\u003ePreserving Amazon EBS volumes on instance termination\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "encrypted": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to \u003ccode\u003etrue\u003c/code\u003e depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'\u003eAmazon EBS encryption\u003c/a\u003e in the \u003ci\u003eAmazon EBS User Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eIn no case can you remove encryption from an encrypted volume.\u003c/p\u003e \u003cp\u003eEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'\u003eSupported instance types\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eThis parameter is not returned by \u003ca\u003eDescribeImageAttribute\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eFor \u003ca\u003eCreateImage\u003c/a\u003e and \u003ca\u003eRegisterImage\u003c/a\u003e, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping for a \u003cb\u003enew (empty) volume\u003c/b\u003e, you can include this parameter, and specify either \u003ccode\u003etrue\u003c/code\u003e for an encrypted volume, or \u003ccode\u003efalse\u003c/code\u003e for an unencrypted volume. If you omit this parameter, it defaults to \u003ccode\u003efalse\u003c/code\u003e (unencrypted).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping from an \u003cb\u003eexisting encrypted or unencrypted snapshot\u003c/b\u003e, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping from an \u003cb\u003eexisting unencrypted volume\u003c/b\u003e, you can include this parameter, but you must specify \u003ccode\u003efalse\u003c/code\u003e. If you specify \u003ccode\u003etrue\u003c/code\u003e, the request will fail. In this case, we recommend that you omit the parameter.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping from an \u003cb\u003eexisting encrypted volume\u003c/b\u003e, you can include this parameter, and specify either \u003ccode\u003etrue\u003c/code\u003e or \u003ccode\u003efalse\u003c/code\u003e. However, if you specify \u003ccode\u003efalse\u003c/code\u003e, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "iops": { "type": "integer", "description": "\u003cp\u003eThe number of I/O operations per second (IOPS). For \u003ccode\u003egp3\u003c/code\u003e, \u003ccode\u003eio1\u003c/code\u003e, and \u003ccode\u003eio2\u003c/code\u003e volumes, this represents the number of IOPS that are provisioned for the volume. For \u003ccode\u003egp2\u003c/code\u003e volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\u003c/p\u003e \u003cp\u003eThe following are the supported values for each volume type:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003egp3\u003c/code\u003e: 3,000 - 16,000 IOPS\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio1\u003c/code\u003e: 100 - 64,000 IOPS\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio2\u003c/code\u003e: 100 - 256,000 IOPS\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor \u003ccode\u003eio2\u003c/code\u003e volumes, you can achieve up to 256,000 IOPS on \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'\u003einstances built on the Nitro System\u003c/a\u003e. On other instances, you can achieve performance up to 32,000 IOPS.\u003c/p\u003e \u003cp\u003eThis parameter is required for \u003ccode\u003eio1\u003c/code\u003e and \u003ccode\u003eio2\u003c/code\u003e volumes. The default for \u003ccode\u003egp3\u003c/code\u003e volumes is 3,000 IOPS.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eIdentifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.\u003c/p\u003e \u003cp\u003eThis parameter is only supported on \u003ccode\u003eBlockDeviceMapping\u003c/code\u003e objects called by \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'\u003eRunInstances\u003c/a\u003e, \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'\u003eRequestSpotFleet\u003c/a\u003e, and \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'\u003eRequestSpotInstances\u003c/a\u003e.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the Outpost on which the snapshot is stored.\u003c/p\u003e \u003cp\u003eThis parameter is not supported when using \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'\u003eCreateImage\u003c/a\u003e.\u003c/p\u003e" }, "snapshotId": { "type": "string", "description": "\u003cp\u003eThe ID of the snapshot.\u003c/p\u003e" }, "throughput": { "type": "integer", "description": "\u003cp\u003eThe throughput that the volume supports, in MiB/s.\u003c/p\u003e \u003cp\u003eThis parameter is valid only for \u003ccode\u003egp3\u003c/code\u003e volumes.\u003c/p\u003e \u003cp\u003eValid Range: Minimum value of 125. Maximum value of 1000.\u003c/p\u003e" }, "volumeSize": { "type": "integer", "description": "\u003cp\u003eThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\u003c/p\u003e \u003cp\u003eThe following are the supported sizes for each volume type:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003egp2\u003c/code\u003e and \u003ccode\u003egp3\u003c/code\u003e: 1 - 16,384 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio1\u003c/code\u003e: 4 - 16,384 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio2\u003c/code\u003e: 4 - 65,536 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003est1\u003c/code\u003e and \u003ccode\u003esc1\u003c/code\u003e: 125 - 16,384 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003estandard\u003c/code\u003e: 1 - 1024 GiB\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "volumeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeTypeEnumValue", "description": "\u003cp\u003eThe volume type. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'\u003eAmazon EBS volume types\u003c/a\u003e in the \u003ci\u003eAmazon EBS User Guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EbsBlockDeviceResponse": { "description": "Definition of EbsBlockDevice", "properties": { "deleteOnTermination": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the EBS volume is deleted on instance termination. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination'\u003ePreserving Amazon EBS volumes on instance termination\u003c/a\u003e in the \u003ci\u003eAmazon EC2 User Guide\u003c/i\u003e.\u003c/p\u003e" }, "encrypted": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to \u003ccode\u003etrue\u003c/code\u003e depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters'\u003eAmazon EBS encryption\u003c/a\u003e in the \u003ci\u003eAmazon EBS User Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eIn no case can you remove encryption from an encrypted volume.\u003c/p\u003e \u003cp\u003eEncrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances'\u003eSupported instance types\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eThis parameter is not returned by \u003ca\u003eDescribeImageAttribute\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eFor \u003ca\u003eCreateImage\u003c/a\u003e and \u003ca\u003eRegisterImage\u003c/a\u003e, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping for a \u003cb\u003enew (empty) volume\u003c/b\u003e, you can include this parameter, and specify either \u003ccode\u003etrue\u003c/code\u003e for an encrypted volume, or \u003ccode\u003efalse\u003c/code\u003e for an unencrypted volume. If you omit this parameter, it defaults to \u003ccode\u003efalse\u003c/code\u003e (unencrypted).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping from an \u003cb\u003eexisting encrypted or unencrypted snapshot\u003c/b\u003e, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping from an \u003cb\u003eexisting unencrypted volume\u003c/b\u003e, you can include this parameter, but you must specify \u003ccode\u003efalse\u003c/code\u003e. If you specify \u003ccode\u003etrue\u003c/code\u003e, the request will fail. In this case, we recommend that you omit the parameter.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you are creating a block device mapping from an \u003cb\u003eexisting encrypted volume\u003c/b\u003e, you can include this parameter, and specify either \u003ccode\u003etrue\u003c/code\u003e or \u003ccode\u003efalse\u003c/code\u003e. However, if you specify \u003ccode\u003efalse\u003c/code\u003e, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "iops": { "type": "integer", "description": "\u003cp\u003eThe number of I/O operations per second (IOPS). For \u003ccode\u003egp3\u003c/code\u003e, \u003ccode\u003eio1\u003c/code\u003e, and \u003ccode\u003eio2\u003c/code\u003e volumes, this represents the number of IOPS that are provisioned for the volume. For \u003ccode\u003egp2\u003c/code\u003e volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.\u003c/p\u003e \u003cp\u003eThe following are the supported values for each volume type:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003egp3\u003c/code\u003e: 3,000 - 16,000 IOPS\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio1\u003c/code\u003e: 100 - 64,000 IOPS\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio2\u003c/code\u003e: 100 - 256,000 IOPS\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor \u003ccode\u003eio2\u003c/code\u003e volumes, you can achieve up to 256,000 IOPS on \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances'\u003einstances built on the Nitro System\u003c/a\u003e. On other instances, you can achieve performance up to 32,000 IOPS.\u003c/p\u003e \u003cp\u003eThis parameter is required for \u003ccode\u003eio1\u003c/code\u003e and \u003ccode\u003eio2\u003c/code\u003e volumes. The default for \u003ccode\u003egp3\u003c/code\u003e volumes is 3,000 IOPS.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eIdentifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.\u003c/p\u003e \u003cp\u003eThis parameter is only supported on \u003ccode\u003eBlockDeviceMapping\u003c/code\u003e objects called by \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'\u003eRunInstances\u003c/a\u003e, \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html'\u003eRequestSpotFleet\u003c/a\u003e, and \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html'\u003eRequestSpotInstances\u003c/a\u003e.\u003c/p\u003e" }, "outpostArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the Outpost on which the snapshot is stored.\u003c/p\u003e \u003cp\u003eThis parameter is not supported when using \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html'\u003eCreateImage\u003c/a\u003e.\u003c/p\u003e" }, "snapshotId": { "type": "string", "description": "\u003cp\u003eThe ID of the snapshot.\u003c/p\u003e" }, "throughput": { "type": "integer", "description": "\u003cp\u003eThe throughput that the volume supports, in MiB/s.\u003c/p\u003e \u003cp\u003eThis parameter is valid only for \u003ccode\u003egp3\u003c/code\u003e volumes.\u003c/p\u003e \u003cp\u003eValid Range: Minimum value of 125. Maximum value of 1000.\u003c/p\u003e" }, "volumeSize": { "type": "integer", "description": "\u003cp\u003eThe size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.\u003c/p\u003e \u003cp\u003eThe following are the supported sizes for each volume type:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003egp2\u003c/code\u003e and \u003ccode\u003egp3\u003c/code\u003e: 1 - 16,384 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio1\u003c/code\u003e: 4 - 16,384 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eio2\u003c/code\u003e: 4 - 65,536 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003est1\u003c/code\u003e and \u003ccode\u003esc1\u003c/code\u003e: 125 - 16,384 GiB\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003estandard\u003c/code\u003e: 1 - 1024 GiB\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "volumeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VolumeTypeEnumValueResponse", "description": "\u003cp\u003eThe volume type. For more information, see \u003ca href='https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html'\u003eAmazon EBS volume types\u003c/a\u003e in the \u003ci\u003eAmazon EBS User Guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EbsInstanceBlockDevice": { "description": "Definition of EbsInstanceBlockDevice", "properties": { "associatedResource": { "type": "string", "description": "\u003cp\u003eThe ARN of the Amazon ECS or Fargate task to which the volume is attached.\u003c/p\u003e" }, "attachTime": { "type": "string", "description": "\u003cp\u003eThe time stamp when the attachment initiated.\u003c/p\u003e" }, "deleteOnTermination": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the volume is deleted on instance termination.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AttachmentStatusEnumValue", "description": "\u003cp\u003eThe attachment state.\u003c/p\u003e" }, "volumeId": { "type": "string", "description": "\u003cp\u003eThe ID of the EBS volume.\u003c/p\u003e" }, "volumeOwnerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the volume.\u003c/p\u003e \u003cp\u003eThis parameter is returned only for volumes that are attached to Fargate tasks.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EbsInstanceBlockDeviceResponse": { "description": "Definition of EbsInstanceBlockDevice", "properties": { "associatedResource": { "type": "string", "description": "\u003cp\u003eThe ARN of the Amazon ECS or Fargate task to which the volume is attached.\u003c/p\u003e" }, "attachTime": { "type": "string", "description": "\u003cp\u003eThe time stamp when the attachment initiated.\u003c/p\u003e" }, "deleteOnTermination": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the volume is deleted on instance termination.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AttachmentStatusEnumValueResponse", "description": "\u003cp\u003eThe attachment state.\u003c/p\u003e" }, "volumeId": { "type": "string", "description": "\u003cp\u003eThe ID of the EBS volume.\u003c/p\u003e" }, "volumeOwnerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that owns the volume.\u003c/p\u003e \u003cp\u003eThis parameter is returned only for volumes that are attached to Fargate tasks.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Ec2AccountAttributeProperties": { "description": "Definition of Ec2AccountAttribute", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2AccountAttributeProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2AccountAttributePropertiesResponse": { "description": "Definition of Ec2AccountAttribute", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2AccountAttributePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2AddressProperties": { "description": "Definition of Ec2Address", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2AddressProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2AddressPropertiesResponse": { "description": "Definition of Ec2Address", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2AddressPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2FlowLogProperties": { "description": "Definition of Ec2FlowLog", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2FlowLogProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2FlowLogPropertiesResponse": { "description": "Definition of Ec2FlowLog", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2FlowLogPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2ImageProperties": { "description": "Definition of Ec2Image", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2ImageProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2ImagePropertiesResponse": { "description": "Definition of Ec2Image", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2ImagePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2InstanceAttributes": { "description": "Definition of Ec2InstanceAttributes", "properties": { "additionalMasterSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of additional Amazon EC2 security group IDs for the master node.\u003c/p\u003e" }, "additionalSlaveSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of additional Amazon EC2 security group IDs for the core and task nodes.\u003c/p\u003e" }, "ec2AvailabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone in which the cluster will run. \u003c/p\u003e" }, "ec2KeyName": { "type": "string", "description": "\u003cp\u003eThe name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named 'hadoop'.\u003c/p\u003e" }, "ec2SubnetId": { "type": "string", "description": "\u003cp\u003eSet this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.\u003c/p\u003e" }, "emrManagedMasterSecurityGroup": { "type": "string", "description": "\u003cp\u003eThe identifier of the Amazon EC2 security group for the master node.\u003c/p\u003e" }, "emrManagedSlaveSecurityGroup": { "type": "string", "description": "\u003cp\u003eThe identifier of the Amazon EC2 security group for the core and task nodes.\u003c/p\u003e" }, "iamInstanceProfile": { "type": "string", "description": "\u003cp\u003eThe IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.\u003c/p\u003e" }, "requestedEc2AvailabilityZones": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eApplies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. \u003ccode\u003eRequestedEc2SubnetIDs\u003c/code\u003e and \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e cannot be specified together.\u003c/p\u003e" }, "requestedEc2SubnetIds": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eApplies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of \u003ccode\u003eRequestedEc2SubnetIds\u003c/code\u003e, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. \u003ccode\u003eRequestedEc2SubnetIDs\u003c/code\u003e and \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e cannot be specified together.\u003c/p\u003e" }, "serviceAccessSecurityGroup": { "type": "string", "description": "\u003cp\u003eThe identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Ec2InstanceAttributesResponse": { "description": "Definition of Ec2InstanceAttributes", "properties": { "additionalMasterSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of additional Amazon EC2 security group IDs for the master node.\u003c/p\u003e" }, "additionalSlaveSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA list of additional Amazon EC2 security group IDs for the core and task nodes.\u003c/p\u003e" }, "ec2AvailabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone in which the cluster will run. \u003c/p\u003e" }, "ec2KeyName": { "type": "string", "description": "\u003cp\u003eThe name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named 'hadoop'.\u003c/p\u003e" }, "ec2SubnetId": { "type": "string", "description": "\u003cp\u003eSet this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.\u003c/p\u003e" }, "emrManagedMasterSecurityGroup": { "type": "string", "description": "\u003cp\u003eThe identifier of the Amazon EC2 security group for the master node.\u003c/p\u003e" }, "emrManagedSlaveSecurityGroup": { "type": "string", "description": "\u003cp\u003eThe identifier of the Amazon EC2 security group for the core and task nodes.\u003c/p\u003e" }, "iamInstanceProfile": { "type": "string", "description": "\u003cp\u003eThe IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.\u003c/p\u003e" }, "requestedEc2AvailabilityZones": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eApplies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. \u003ccode\u003eRequestedEc2SubnetIDs\u003c/code\u003e and \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e cannot be specified together.\u003c/p\u003e" }, "requestedEc2SubnetIds": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eApplies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of \u003ccode\u003eRequestedEc2SubnetIds\u003c/code\u003e, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. \u003ccode\u003eRequestedEc2SubnetIDs\u003c/code\u003e and \u003ccode\u003eRequestedEc2AvailabilityZones\u003c/code\u003e cannot be specified together.\u003c/p\u003e" }, "serviceAccessSecurityGroup": { "type": "string", "description": "\u003cp\u003eThe identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Ec2InstanceProperties": { "description": "Definition of Ec2Instance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2InstanceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2InstancePropertiesResponse": { "description": "Definition of Ec2Instance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2InstancePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2InstanceStatusProperties": { "description": "Definition of Ec2InstanceStatus", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2InstanceStatusProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2InstanceStatusPropertiesResponse": { "description": "Definition of Ec2InstanceStatus", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2InstanceStatusPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2IpamProperties": { "description": "Definition of Ec2Ipam", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2IpamProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2IpamPropertiesResponse": { "description": "Definition of Ec2Ipam", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2IpamPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2KeyPairProperties": { "description": "Definition of Ec2KeyPair", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2KeyPairProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2KeyPairPropertiesResponse": { "description": "Definition of Ec2KeyPair", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2KeyPairPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2NetworkAclProperties": { "description": "Definition of Ec2NetworkAcl", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2NetworkAclProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2NetworkAclPropertiesResponse": { "description": "Definition of Ec2NetworkAcl", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2NetworkAclPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2NetworkInterfaceProperties": { "description": "Definition of Ec2NetworkInterface", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2NetworkInterfaceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2NetworkInterfacePropertiesResponse": { "description": "Definition of Ec2NetworkInterface", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2NetworkInterfacePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2RouteTableProperties": { "description": "Definition of Ec2RouteTable", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2RouteTableProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2RouteTablePropertiesResponse": { "description": "Definition of Ec2RouteTable", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2RouteTablePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2SecurityGroupProperties": { "description": "Definition of Ec2SecurityGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2SecurityGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2SecurityGroupPropertiesResponse": { "description": "Definition of Ec2SecurityGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2SecurityGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2SnapshotProperties": { "description": "Definition of Ec2Snapshot", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2SnapshotProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2SnapshotPropertiesResponse": { "description": "Definition of Ec2Snapshot", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2SnapshotPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2SubnetProperties": { "description": "Definition of Ec2Subnet", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2SubnetProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2SubnetPropertiesResponse": { "description": "Definition of Ec2Subnet", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2SubnetPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2VPCEndpointProperties": { "description": "Definition of Ec2VPCEndpoint", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VPCEndpointProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2VPCEndpointPropertiesResponse": { "description": "Definition of Ec2VPCEndpoint", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VPCEndpointPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2VPCPeeringConnectionProperties": { "description": "Definition of Ec2VPCPeeringConnection", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VPCPeeringConnectionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2VPCPeeringConnectionPropertiesResponse": { "description": "Definition of Ec2VPCPeeringConnection", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VPCPeeringConnectionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2VolumeProperties": { "description": "Definition of Ec2Volume", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VolumeProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2VolumePropertiesResponse": { "description": "Definition of Ec2Volume", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VolumePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Ec2VpcProperties": { "description": "Definition of Ec2Vpc", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VpcProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Ec2VpcPropertiesResponse": { "description": "Definition of Ec2Vpc", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEc2VpcPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EcrImageDetailProperties": { "description": "Definition of EcrImageDetail", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcrImageDetailProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EcrImageDetailPropertiesResponse": { "description": "Definition of EcrImageDetail", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcrImageDetailPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EcrRepositoryProperties": { "description": "Definition of EcrRepository", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcrRepositoryProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EcrRepositoryPropertiesResponse": { "description": "Definition of EcrRepository", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcrRepositoryPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EcsClusterProperties": { "description": "Definition of EcsCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcsClusterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EcsClusterPropertiesResponse": { "description": "Definition of EcsCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcsClusterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EcsServiceProperties": { "description": "Definition of EcsService", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcsServiceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EcsServicePropertiesResponse": { "description": "Definition of EcsService", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcsServicePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EcsTaskDefinitionProperties": { "description": "Definition of EcsTaskDefinition", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcsTaskDefinitionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EcsTaskDefinitionPropertiesResponse": { "description": "Definition of EcsTaskDefinition", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEcsTaskDefinitionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EfsFileSystemProperties": { "description": "Definition of EfsFileSystem", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEfsFileSystemProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EfsFileSystemPropertiesResponse": { "description": "Definition of EfsFileSystem", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEfsFileSystemPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EfsMountTargetProperties": { "description": "Definition of EfsMountTarget", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEfsMountTargetProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EfsMountTargetPropertiesResponse": { "description": "Definition of EfsMountTarget", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEfsMountTargetPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EksClusterProperties": { "description": "Definition of EksCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEksClusterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EksClusterPropertiesResponse": { "description": "Definition of EksCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEksClusterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EksNodegroupProperties": { "description": "Definition of EksNodegroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEksNodegroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EksNodegroupPropertiesResponse": { "description": "Definition of EksNodegroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEksNodegroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticBeanstalkApplicationProperties": { "description": "Definition of ElasticBeanstalkApplication", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticBeanstalkApplicationProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticBeanstalkApplicationPropertiesResponse": { "description": "Definition of ElasticBeanstalkApplication", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticBeanstalkApplicationPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticBeanstalkConfigurationTemplateProperties": { "description": "Definition of ElasticBeanstalkConfigurationTemplate", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticBeanstalkConfigurationTemplateProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticBeanstalkConfigurationTemplatePropertiesResponse": { "description": "Definition of ElasticBeanstalkConfigurationTemplate", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticBeanstalkConfigurationTemplatePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticBeanstalkEnvironmentProperties": { "description": "Definition of ElasticBeanstalkEnvironment", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticBeanstalkEnvironmentProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticBeanstalkEnvironmentPropertiesResponse": { "description": "Definition of ElasticBeanstalkEnvironment", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticBeanstalkEnvironmentPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticFileSystemTag": { "description": "Definition of ElasticFileSystemTag", "properties": { "key": { "type": "string", "description": "The tag key (String). The key can't start with ``aws:``." }, "value": { "type": "string", "description": "The value of the tag key." } }, "type": "object" }, "azure-native:awsconnector:ElasticFileSystemTagResponse": { "description": "Definition of ElasticFileSystemTag", "properties": { "key": { "type": "string", "description": "The tag key (String). The key can't start with ``aws:``." }, "value": { "type": "string", "description": "The value of the tag key." } }, "type": "object" }, "azure-native:awsconnector:ElasticGpuAssociation": { "description": "Definition of ElasticGpuAssociation", "properties": { "elasticGpuAssociationId": { "type": "string", "description": "\u003cp\u003eThe ID of the association.\u003c/p\u003e" }, "elasticGpuAssociationState": { "type": "string", "description": "\u003cp\u003eThe state of the association between the instance and the Elastic Graphics accelerator.\u003c/p\u003e" }, "elasticGpuAssociationTime": { "type": "string", "description": "\u003cp\u003eThe time the Elastic Graphics accelerator was associated with the instance.\u003c/p\u003e" }, "elasticGpuId": { "type": "string", "description": "\u003cp\u003eThe ID of the Elastic Graphics accelerator.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ElasticGpuAssociationResponse": { "description": "Definition of ElasticGpuAssociation", "properties": { "elasticGpuAssociationId": { "type": "string", "description": "\u003cp\u003eThe ID of the association.\u003c/p\u003e" }, "elasticGpuAssociationState": { "type": "string", "description": "\u003cp\u003eThe state of the association between the instance and the Elastic Graphics accelerator.\u003c/p\u003e" }, "elasticGpuAssociationTime": { "type": "string", "description": "\u003cp\u003eThe time the Elastic Graphics accelerator was associated with the instance.\u003c/p\u003e" }, "elasticGpuId": { "type": "string", "description": "\u003cp\u003eThe ID of the Elastic Graphics accelerator.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ElasticInferenceAcceleratorAssociation": { "description": "Definition of ElasticInferenceAcceleratorAssociation", "properties": { "elasticInferenceAcceleratorArn": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) of the elastic inference accelerator. \u003c/p\u003e" }, "elasticInferenceAcceleratorAssociationId": { "type": "string", "description": "\u003cp\u003e The ID of the association. \u003c/p\u003e" }, "elasticInferenceAcceleratorAssociationState": { "type": "string", "description": "\u003cp\u003e The state of the elastic inference accelerator. \u003c/p\u003e" }, "elasticInferenceAcceleratorAssociationTime": { "type": "string", "description": "\u003cp\u003e The time at which the elastic inference accelerator is associated with an instance. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ElasticInferenceAcceleratorAssociationResponse": { "description": "Definition of ElasticInferenceAcceleratorAssociation", "properties": { "elasticInferenceAcceleratorArn": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) of the elastic inference accelerator. \u003c/p\u003e" }, "elasticInferenceAcceleratorAssociationId": { "type": "string", "description": "\u003cp\u003e The ID of the association. \u003c/p\u003e" }, "elasticInferenceAcceleratorAssociationState": { "type": "string", "description": "\u003cp\u003e The state of the elastic inference accelerator. \u003c/p\u003e" }, "elasticInferenceAcceleratorAssociationTime": { "type": "string", "description": "\u003cp\u003e The time at which the elastic inference accelerator is associated with an instance. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ElasticLoadBalancingV2ListenerProperties": { "description": "Definition of ElasticLoadBalancingV2Listener", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingV2ListenerProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticLoadBalancingV2ListenerPropertiesResponse": { "description": "Definition of ElasticLoadBalancingV2Listener", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingV2ListenerPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticLoadBalancingV2LoadBalancerProperties": { "description": "Definition of ElasticLoadBalancingV2LoadBalancer", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingV2LoadBalancerProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticLoadBalancingV2LoadBalancerPropertiesResponse": { "description": "Definition of ElasticLoadBalancingV2LoadBalancer", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingV2LoadBalancerPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticLoadBalancingV2TargetGroupProperties": { "description": "Definition of ElasticLoadBalancingV2TargetGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingV2TargetGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticLoadBalancingV2TargetGroupPropertiesResponse": { "description": "Definition of ElasticLoadBalancingV2TargetGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingV2TargetGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ElasticLoadBalancingv2TargetHealthDescriptionProperties": { "description": "Definition of ElasticLoadBalancingv2TargetHealthDescription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingv2TargetHealthDescriptionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:ElasticLoadBalancingv2TargetHealthDescriptionPropertiesResponse": { "description": "Definition of ElasticLoadBalancingv2TargetHealthDescription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsElasticLoadBalancingv2TargetHealthDescriptionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EmrClusterProperties": { "description": "Definition of EmrCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEmrClusterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:EmrClusterPropertiesResponse": { "description": "Definition of EmrCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsEmrClusterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:EmrClusterStatus": { "description": "Definition of ClusterStatus", "properties": { "errorDetails": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ErrorDetail" }, "description": "\u003cp\u003eA list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different \u003ccode\u003eErrorDetail\u003c/code\u003e tuples.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStateEnumValue", "description": "\u003cp\u003eThe current state of the cluster.\u003c/p\u003e" }, "stateChangeReason": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStateChangeReason", "description": "\u003cp\u003eThe reason for the cluster status change.\u003c/p\u003e" }, "timeline": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterTimeline", "description": "\u003cp\u003eA timeline that represents the status of a cluster over the lifetime of the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EmrClusterStatusResponse": { "description": "Definition of ClusterStatus", "properties": { "errorDetails": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ErrorDetailResponse" }, "description": "\u003cp\u003eA list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different \u003ccode\u003eErrorDetail\u003c/code\u003e tuples.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStateEnumValueResponse", "description": "\u003cp\u003eThe current state of the cluster.\u003c/p\u003e" }, "stateChangeReason": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterStateChangeReasonResponse", "description": "\u003cp\u003eThe reason for the cluster status change.\u003c/p\u003e" }, "timeline": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ClusterTimelineResponse", "description": "\u003cp\u003eA timeline that represents the status of a cluster over the lifetime of the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EnclaveOptions": { "description": "Definition of EnclaveOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eIf this parameter is set to \u003ccode\u003etrue\u003c/code\u003e, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EnclaveOptionsResponse": { "description": "Definition of EnclaveOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eIf this parameter is set to \u003ccode\u003etrue\u003c/code\u003e, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EncryptionAtRestOptions": { "description": "Definition of EncryptionAtRestOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue to enable encryption at rest.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eThe KMS key ID. Takes the form \u003ccode\u003e1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EncryptionAtRestOptionsResponse": { "description": "Definition of EncryptionAtRestOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue to enable encryption at rest.\u003c/p\u003e" }, "kmsKeyId": { "type": "string", "description": "\u003cp\u003eThe KMS key ID. Takes the form \u003ccode\u003e1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EncryptionConfig": { "description": "Definition of EncryptionConfig", "properties": { "provider": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Provider", "description": "\u003cp\u003eKey Management Service (KMS) key. Either the ARN or the alias can be used.\u003c/p\u003e" }, "resources": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eSpecifies the resources to be encrypted. The only supported value is \u003ccode\u003esecrets\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EncryptionConfigResponse": { "description": "Definition of EncryptionConfig", "properties": { "provider": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProviderResponse", "description": "\u003cp\u003eKey Management Service (KMS) key. Either the ARN or the alias can be used.\u003c/p\u003e" }, "resources": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eSpecifies the resources to be encrypted. The only supported value is \u003ccode\u003esecrets\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EncryptionConfiguration": { "description": "Definition of EncryptionConfiguration", "properties": { "encryptionType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EncryptionConfigurationEncryptionType" } ], "description": "The encryption type to use. If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama The encryption type to use." }, "kmsKey": { "type": "string", "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used." }, "replicaKmsKeyID": { "type": "string", "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:EncryptionConfigurationEncryptionType": { "description": "The encryption type to use. If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama The encryption type to use.", "type": "string", "enum": [ { "name": "AES256", "description": "EncryptionConfigurationEncryptionType enum AES256", "value": "AES256" }, { "name": "KMS", "description": "EncryptionConfigurationEncryptionType enum KMS", "value": "KMS" } ] }, "azure-native:awsconnector:EncryptionConfigurationResponse": { "description": "Definition of EncryptionConfiguration", "properties": { "encryptionType": { "type": "string", "description": "The encryption type to use. If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama The encryption type to use." }, "kmsKey": { "type": "string", "description": "If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used." } }, "type": "object" }, "azure-native:awsconnector:EncryptionConfigurationResponseV1": { "description": "Definition of EncryptionConfiguration", "properties": { "replicaKmsKeyID": { "type": "string", "description": "Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:EndpointConfiguration": { "description": "Definition of EndpointConfiguration", "properties": { "types": { "type": "array", "items": { "type": "string" }, "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``'EDGE'``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``." }, "vpcEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type." } }, "type": "object" }, "azure-native:awsconnector:EndpointConfigurationResponse": { "description": "Definition of EndpointConfiguration", "properties": { "types": { "type": "array", "items": { "type": "string" }, "description": "A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``'EDGE'``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``." }, "vpcEndpointIds": { "type": "array", "items": { "type": "string" }, "description": "A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type." } }, "type": "object" }, "azure-native:awsconnector:EnhancedMetricsConfig": { "description": "Definition of EnhancedMetricsConfig", "properties": { "dataSourceLevelMetricsBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DataSourceLevelMetricsBehaviorEnumValue", "description": "\u003cp\u003eControls how data source metrics will be emitted to CloudWatch. Data source metrics include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eRequests: The number of invocations that occured during a request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eLatency: The time to complete a data source invocation.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eErrors: The number of errors that occurred during a data source invocation.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. \u003ccode\u003edataSourceLevelMetricsBehavior\u003c/code\u003e accepts one of these values at a time:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eFULL_REQUEST_DATA_SOURCE_METRICS\u003c/code\u003e: Records and emits metric data for all data sources in the request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePER_DATA_SOURCE_METRICS\u003c/code\u003e: Records and emits metric data for data sources that have the \u003ccode\u003emetricsConfig\u003c/code\u003e value set to \u003ccode\u003eENABLED\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "operationLevelMetricsConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OperationLevelMetricsConfigEnumValue", "description": "\u003cp\u003e Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eRequests: The number of times a specified GraphQL operation was called.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eMetrics will be recorded by API ID and operation name. You can set the value to \u003ccode\u003eENABLED\u003c/code\u003e or \u003ccode\u003eDISABLED\u003c/code\u003e.\u003c/p\u003e" }, "resolverLevelMetricsBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResolverLevelMetricsBehaviorEnumValue", "description": "\u003cp\u003eControls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eGraphQL errors: The number of GraphQL errors that occurred.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eRequests: The number of invocations that occurred during a request. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eLatency: The time to complete a resolver invocation.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCache hits: The number of cache hits during a request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCache misses: The number of cache misses during a request.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. \u003ccode\u003eresolverLevelMetricsBehavior\u003c/code\u003e accepts one of these values at a time:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eFULL_REQUEST_RESOLVER_METRICS\u003c/code\u003e: Records and emits metric data for all resolvers in the request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePER_RESOLVER_METRICS\u003c/code\u003e: Records and emits metric data for resolvers that have the \u003ccode\u003emetricsConfig\u003c/code\u003e value set to \u003ccode\u003eENABLED\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:EnhancedMetricsConfigResponse": { "description": "Definition of EnhancedMetricsConfig", "properties": { "dataSourceLevelMetricsBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DataSourceLevelMetricsBehaviorEnumValueResponse", "description": "\u003cp\u003eControls how data source metrics will be emitted to CloudWatch. Data source metrics include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eRequests: The number of invocations that occured during a request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eLatency: The time to complete a data source invocation.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eErrors: The number of errors that occurred during a data source invocation.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eThese metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. \u003ccode\u003edataSourceLevelMetricsBehavior\u003c/code\u003e accepts one of these values at a time:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eFULL_REQUEST_DATA_SOURCE_METRICS\u003c/code\u003e: Records and emits metric data for all data sources in the request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePER_DATA_SOURCE_METRICS\u003c/code\u003e: Records and emits metric data for data sources that have the \u003ccode\u003emetricsConfig\u003c/code\u003e value set to \u003ccode\u003eENABLED\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "operationLevelMetricsConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OperationLevelMetricsConfigEnumValueResponse", "description": "\u003cp\u003e Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eRequests: The number of times a specified GraphQL operation was called.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eGraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eMetrics will be recorded by API ID and operation name. You can set the value to \u003ccode\u003eENABLED\u003c/code\u003e or \u003ccode\u003eDISABLED\u003c/code\u003e.\u003c/p\u003e" }, "resolverLevelMetricsBehavior": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ResolverLevelMetricsBehaviorEnumValueResponse", "description": "\u003cp\u003eControls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eGraphQL errors: The number of GraphQL errors that occurred.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eRequests: The number of invocations that occurred during a request. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eLatency: The time to complete a resolver invocation.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCache hits: The number of cache hits during a request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCache misses: The number of cache misses during a request.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eThese metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. \u003ccode\u003eresolverLevelMetricsBehavior\u003c/code\u003e accepts one of these values at a time:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eFULL_REQUEST_RESOLVER_METRICS\u003c/code\u003e: Records and emits metric data for all resolvers in the request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePER_RESOLVER_METRICS\u003c/code\u003e: Records and emits metric data for resolvers that have the \u003ccode\u003emetricsConfig\u003c/code\u003e value set to \u003ccode\u003eENABLED\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:Environment": { "description": "Definition of Environment", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)." } }, "type": "object" }, "azure-native:awsconnector:EnvironmentFile": { "description": "Definition of EnvironmentFile", "properties": { "type": { "type": "string", "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``." }, "value": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file." } }, "type": "object" }, "azure-native:awsconnector:EnvironmentFileResponse": { "description": "Definition of EnvironmentFile", "properties": { "type": { "type": "string", "description": "The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``." }, "value": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file." } }, "type": "object" }, "azure-native:awsconnector:EnvironmentResponse": { "description": "Definition of Environment", "properties": { "variables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html)." } }, "type": "object" }, "azure-native:awsconnector:EnvironmentType": { "description": "Property value", "type": "string", "enum": [ { "name": "ARM_CONTAINER", "description": "EnvironmentType enum ARM_CONTAINER", "value": "ARM_CONTAINER" }, { "name": "ARM_LAMBDA_CONTAINER", "description": "EnvironmentType enum ARM_LAMBDA_CONTAINER", "value": "ARM_LAMBDA_CONTAINER" }, { "name": "LINUX_CONTAINER", "description": "EnvironmentType enum LINUX_CONTAINER", "value": "LINUX_CONTAINER" }, { "name": "LINUX_GPU_CONTAINER", "description": "EnvironmentType enum LINUX_GPU_CONTAINER", "value": "LINUX_GPU_CONTAINER" }, { "name": "LINUX_LAMBDA_CONTAINER", "description": "EnvironmentType enum LINUX_LAMBDA_CONTAINER", "value": "LINUX_LAMBDA_CONTAINER" }, { "name": "WINDOWS_CONTAINER", "description": "EnvironmentType enum WINDOWS_CONTAINER", "value": "WINDOWS_CONTAINER" }, { "name": "WINDOWS_SERVER_2019_CONTAINER", "description": "EnvironmentType enum WINDOWS_SERVER_2019_CONTAINER", "value": "WINDOWS_SERVER_2019_CONTAINER" } ] }, "azure-native:awsconnector:EnvironmentTypeEnumValue": { "description": "Definition of EnvironmentTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EnvironmentType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:EnvironmentTypeEnumValueResponse": { "description": "Definition of EnvironmentTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:EnvironmentVariable": { "description": "Definition of EnvironmentVariable", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name or key of the environment variable.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentVariableTypeEnumValue", "description": "\u003cp\u003eThe type of environment variable. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePARAMETER_STORE\u003c/code\u003e: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the \u003ccode\u003evalue\u003c/code\u003e of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store'\u003eenv/parameter-store\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePLAINTEXT\u003c/code\u003e: An environment variable in plain text format. This is the default value.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSECRETS_MANAGER\u003c/code\u003e: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the \u003ccode\u003evalue\u003c/code\u003e of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager'\u003eenv/secrets-manager\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "value": { "type": "string", "description": "\u003cp\u003eThe value of the environment variable.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eWe strongly discourage the use of \u003ccode\u003ePLAINTEXT\u003c/code\u003e environment variables to store sensitive values, especially Amazon Web Services secret key IDs. \u003ccode\u003ePLAINTEXT\u003c/code\u003e environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type \u003ccode\u003ePARAMETER_STORE\u003c/code\u003e or \u003ccode\u003eSECRETS_MANAGER\u003c/code\u003e. \u003c/p\u003e \u003c/important\u003e" } }, "type": "object" }, "azure-native:awsconnector:EnvironmentVariableResponse": { "description": "Definition of EnvironmentVariable", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name or key of the environment variable.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentVariableTypeEnumValueResponse", "description": "\u003cp\u003eThe type of environment variable. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePARAMETER_STORE\u003c/code\u003e: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the \u003ccode\u003evalue\u003c/code\u003e of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store'\u003eenv/parameter-store\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePLAINTEXT\u003c/code\u003e: An environment variable in plain text format. This is the default value.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSECRETS_MANAGER\u003c/code\u003e: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the \u003ccode\u003evalue\u003c/code\u003e of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager'\u003eenv/secrets-manager\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "value": { "type": "string", "description": "\u003cp\u003eThe value of the environment variable.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eWe strongly discourage the use of \u003ccode\u003ePLAINTEXT\u003c/code\u003e environment variables to store sensitive values, especially Amazon Web Services secret key IDs. \u003ccode\u003ePLAINTEXT\u003c/code\u003e environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type \u003ccode\u003ePARAMETER_STORE\u003c/code\u003e or \u003ccode\u003eSECRETS_MANAGER\u003c/code\u003e. \u003c/p\u003e \u003c/important\u003e" } }, "type": "object" }, "azure-native:awsconnector:EnvironmentVariableType": { "description": "Property value", "type": "string", "enum": [ { "name": "PARAMETER_STORE", "description": "EnvironmentVariableType enum PARAMETER_STORE", "value": "PARAMETER_STORE" }, { "name": "PLAINTEXT", "description": "EnvironmentVariableType enum PLAINTEXT", "value": "PLAINTEXT" }, { "name": "SECRETS_MANAGER", "description": "EnvironmentVariableType enum SECRETS_MANAGER", "value": "SECRETS_MANAGER" } ] }, "azure-native:awsconnector:EnvironmentVariableTypeEnumValue": { "description": "Definition of EnvironmentVariableTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EnvironmentVariableType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:EnvironmentVariableTypeEnumValueResponse": { "description": "Definition of EnvironmentVariableTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:EphemeralStorage": { "description": "Definition of EphemeralStorage", "properties": { "size": { "type": "integer", "description": "The size of the function's ``/tmp`` directory." }, "sizeInGiB": { "type": "integer", "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB." } }, "type": "object" }, "azure-native:awsconnector:EphemeralStorageResponse": { "description": "Definition of EphemeralStorage", "properties": { "sizeInGiB": { "type": "integer", "description": "The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB." } }, "type": "object" }, "azure-native:awsconnector:EphemeralStorageResponseV1": { "description": "Definition of EphemeralStorage", "properties": { "size": { "type": "integer", "description": "The size of the function's ``/tmp`` directory." } }, "type": "object" }, "azure-native:awsconnector:ErrorDetail": { "description": "Definition of ErrorDetail", "properties": { "errorCode": { "type": "string", "description": "\u003cp\u003eThe name or code associated with the error.\u003c/p\u003e" }, "errorData": { "type": "array", "items": { "$ref": "pulumi.json#/Any" }, "description": "\u003cp\u003eA list of key value pairs that provides contextual information about why an error occured.\u003c/p\u003e" }, "errorMessage": { "type": "string", "description": "\u003cp\u003eA message that describes the error.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ErrorDetailResponse": { "description": "Definition of ErrorDetail", "properties": { "errorCode": { "type": "string", "description": "\u003cp\u003eThe name or code associated with the error.\u003c/p\u003e" }, "errorData": { "type": "array", "items": { "$ref": "pulumi.json#/Any" }, "description": "\u003cp\u003eA list of key value pairs that provides contextual information about why an error occured.\u003c/p\u003e" }, "errorMessage": { "type": "string", "description": "\u003cp\u003eA message that describes the error.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EstablishedMultiRegionAccessPointPolicy": { "description": "Definition of EstablishedMultiRegionAccessPointPolicy", "properties": { "policy": { "type": "string", "description": "\u003cp\u003eThe details of the last established policy.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EstablishedMultiRegionAccessPointPolicyResponse": { "description": "Definition of EstablishedMultiRegionAccessPointPolicy", "properties": { "policy": { "type": "string", "description": "\u003cp\u003eThe details of the last established policy.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:EventBridgeConfiguration": { "description": "Definition of EventBridgeConfiguration", "properties": { "eventBridgeEnabled": { "type": "boolean", "description": "Enables delivery of events to Amazon EventBridge.", "default": true } }, "type": "object" }, "azure-native:awsconnector:EventBridgeConfigurationResponse": { "description": "Definition of EventBridgeConfiguration", "properties": { "eventBridgeEnabled": { "type": "boolean", "description": "Enables delivery of events to Amazon EventBridge.", "default": true } }, "type": "object" }, "azure-native:awsconnector:EventCode": { "description": "Property value", "type": "string", "enum": [ { "name": "InstanceReboot", "description": "EventCode enum instance-reboot", "value": "instance-reboot" }, { "name": "InstanceRetirement", "description": "EventCode enum instance-retirement", "value": "instance-retirement" }, { "name": "InstanceStop", "description": "EventCode enum instance-stop", "value": "instance-stop" }, { "name": "SystemMaintenance", "description": "EventCode enum system-maintenance", "value": "system-maintenance" }, { "name": "SystemReboot", "description": "EventCode enum system-reboot", "value": "system-reboot" } ] }, "azure-native:awsconnector:EventCodeEnumValue": { "description": "Definition of EventCodeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EventCode" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:EventCodeEnumValueResponse": { "description": "Definition of EventCodeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:EventSelector": { "description": "Definition of EventSelector", "properties": { "dataResources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DataResource" }, "description": "Property dataResources" }, "excludeManagementEventSources": { "type": "array", "items": { "type": "string" }, "description": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing 'kms.amazonaws.com'. By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail." }, "includeManagementEvents": { "type": "boolean", "description": "Specify if you want your event selector to include management events for your trail." }, "readWriteType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:EventSelectorReadWriteType" } ], "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation." } }, "type": "object" }, "azure-native:awsconnector:EventSelectorReadWriteType": { "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation.", "type": "string", "enum": [ { "name": "All", "description": "EventSelectorReadWriteType enum All", "value": "All" }, { "name": "ReadOnly", "description": "EventSelectorReadWriteType enum ReadOnly", "value": "ReadOnly" }, { "name": "WriteOnly", "description": "EventSelectorReadWriteType enum WriteOnly", "value": "WriteOnly" } ] }, "azure-native:awsconnector:EventSelectorResponse": { "description": "Definition of EventSelector", "properties": { "dataResources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DataResourceResponse" }, "description": "Property dataResources" }, "excludeManagementEventSources": { "type": "array", "items": { "type": "string" }, "description": "An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing 'kms.amazonaws.com'. By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail." }, "includeManagementEvents": { "type": "boolean", "description": "Specify if you want your event selector to include management events for your trail." }, "readWriteType": { "type": "string", "description": "Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation." } }, "type": "object" }, "azure-native:awsconnector:ExclusionByResourceTypes": { "description": "Definition of ExclusionByResourceTypes", "properties": { "resourceTypes": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceType" } ] }, "description": "\u003cp\u003eA comma-separated list of resource types to exclude from recording by the configuration recorder.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ExclusionByResourceTypesResponse": { "description": "Definition of ExclusionByResourceTypes", "properties": { "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA comma-separated list of resource types to exclude from recording by the configuration recorder.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ExecuteCommandConfiguration": { "description": "Definition of ExecuteCommandConfiguration", "properties": { "kmsKeyId": { "type": "string", "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container." }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExecuteCommandLogConfiguration", "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket." }, "logging": { "type": "string", "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available. + ``NONE``: The execute command session is not logged. + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required." } }, "type": "object" }, "azure-native:awsconnector:ExecuteCommandConfigurationResponse": { "description": "Definition of ExecuteCommandConfiguration", "properties": { "kmsKeyId": { "type": "string", "description": "Specify an KMSlong key ID to encrypt the data between the local client and the container." }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExecuteCommandLogConfigurationResponse", "description": "The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket." }, "logging": { "type": "string", "description": "The log setting to use for redirecting logs for your execute command results. The following log settings are available. + ``NONE``: The execute command session is not logged. + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required." } }, "type": "object" }, "azure-native:awsconnector:ExecuteCommandLogConfiguration": { "description": "Definition of ExecuteCommandLogConfiguration", "properties": { "cloudWatchEncryptionEnabled": { "type": "boolean", "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off." }, "cloudWatchLogGroupName": { "type": "string", "description": "The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created." }, "s3BucketName": { "type": "string", "description": "The name of the S3 bucket to send logs to. The S3 bucket must already be created." }, "s3EncryptionEnabled": { "type": "boolean", "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used." }, "s3KeyPrefix": { "type": "string", "description": "An optional folder in the S3 bucket to place logs in." } }, "type": "object" }, "azure-native:awsconnector:ExecuteCommandLogConfigurationResponse": { "description": "Definition of ExecuteCommandLogConfiguration", "properties": { "cloudWatchEncryptionEnabled": { "type": "boolean", "description": "Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off." }, "cloudWatchLogGroupName": { "type": "string", "description": "The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created." }, "s3BucketName": { "type": "string", "description": "The name of the S3 bucket to send logs to. The S3 bucket must already be created." }, "s3EncryptionEnabled": { "type": "boolean", "description": "Determines whether to use encryption on the S3 logs. If not specified, encryption is not used." }, "s3KeyPrefix": { "type": "string", "description": "An optional folder in the S3 bucket to place logs in." } }, "type": "object" }, "azure-native:awsconnector:ExportSourceType": { "description": "Property value", "type": "string", "enum": [ { "name": "CLUSTER", "description": "ExportSourceType enum CLUSTER", "value": "CLUSTER" }, { "name": "SNAPSHOT", "description": "ExportSourceType enum SNAPSHOT", "value": "SNAPSHOT" } ] }, "azure-native:awsconnector:ExportSourceTypeEnumValue": { "description": "Definition of ExportSourceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ExportSourceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ExportSourceTypeEnumValueResponse": { "description": "Definition of ExportSourceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ExtendedKeyUsageName": { "description": "ExtendedKeyUsageName enum", "type": "string", "enum": [ { "name": "ANY", "description": "ExtendedKeyUsageName enum ANY", "value": "ANY" }, { "name": "CODE_SIGNING", "description": "ExtendedKeyUsageName enum CODE_SIGNING", "value": "CODE_SIGNING" }, { "name": "CUSTOM", "description": "ExtendedKeyUsageName enum CUSTOM", "value": "CUSTOM" }, { "name": "EMAIL_PROTECTION", "description": "ExtendedKeyUsageName enum EMAIL_PROTECTION", "value": "EMAIL_PROTECTION" }, { "name": "IPSEC_END_SYSTEM", "description": "ExtendedKeyUsageName enum IPSEC_END_SYSTEM", "value": "IPSEC_END_SYSTEM" }, { "name": "IPSEC_TUNNEL", "description": "ExtendedKeyUsageName enum IPSEC_TUNNEL", "value": "IPSEC_TUNNEL" }, { "name": "IPSEC_USER", "description": "ExtendedKeyUsageName enum IPSEC_USER", "value": "IPSEC_USER" }, { "name": "NONE", "description": "ExtendedKeyUsageName enum NONE", "value": "NONE" }, { "name": "OCSP_SIGNING", "description": "ExtendedKeyUsageName enum OCSP_SIGNING", "value": "OCSP_SIGNING" }, { "name": "TIME_STAMPING", "description": "ExtendedKeyUsageName enum TIME_STAMPING", "value": "TIME_STAMPING" }, { "name": "TLS_WEB_CLIENT_AUTHENTICATION", "description": "ExtendedKeyUsageName enum TLS_WEB_CLIENT_AUTHENTICATION", "value": "TLS_WEB_CLIENT_AUTHENTICATION" }, { "name": "TLS_WEB_SERVER_AUTHENTICATION", "description": "ExtendedKeyUsageName enum TLS_WEB_SERVER_AUTHENTICATION", "value": "TLS_WEB_SERVER_AUTHENTICATION" } ] }, "azure-native:awsconnector:FSxAuthorizationConfig": { "description": "Definition of FSxAuthorizationConfig", "properties": { "credentialsParameter": { "type": "string", "description": "Property credentialsParameter" }, "domain": { "type": "string", "description": "Property domain" } }, "type": "object" }, "azure-native:awsconnector:FSxAuthorizationConfigResponse": { "description": "Definition of FSxAuthorizationConfig", "properties": { "credentialsParameter": { "type": "string", "description": "Property credentialsParameter" }, "domain": { "type": "string", "description": "Property domain" } }, "type": "object" }, "azure-native:awsconnector:FSxWindowsFileServerVolumeConfiguration": { "description": "Definition of FSxWindowsFileServerVolumeConfiguration", "properties": { "authorizationConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FSxAuthorizationConfig", "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." }, "fileSystemId": { "type": "string", "description": "The Amazon FSx for Windows File Server file system ID to use." }, "rootDirectory": { "type": "string", "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host." } }, "type": "object" }, "azure-native:awsconnector:FSxWindowsFileServerVolumeConfigurationResponse": { "description": "Definition of FSxWindowsFileServerVolumeConfiguration", "properties": { "authorizationConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FSxAuthorizationConfigResponse", "description": "The authorization configuration details for the Amazon FSx for Windows File Server file system." }, "fileSystemId": { "type": "string", "description": "The Amazon FSx for Windows File Server file system ID to use." }, "rootDirectory": { "type": "string", "description": "The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host." } }, "type": "object" }, "azure-native:awsconnector:FeatureSet": { "description": "Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality.", "type": "string", "enum": [ { "name": "ALL", "description": "FeatureSet enum ALL", "value": "ALL" }, { "name": "CONSOLIDATED_BILLING", "description": "FeatureSet enum CONSOLIDATED_BILLING", "value": "CONSOLIDATED_BILLING" } ] }, "azure-native:awsconnector:FieldLogLevel": { "description": "Property value", "type": "string", "enum": [ { "name": "ALL", "description": "FieldLogLevel enum ALL", "value": "ALL" }, { "name": "ERROR", "description": "FieldLogLevel enum ERROR", "value": "ERROR" }, { "name": "NONE", "description": "FieldLogLevel enum NONE", "value": "NONE" } ] }, "azure-native:awsconnector:FieldLogLevelEnumValue": { "description": "Definition of FieldLogLevelEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FieldLogLevel" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:FieldLogLevelEnumValueResponse": { "description": "Definition of FieldLogLevelEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:FieldToMatch": { "description": "Definition of FieldToMatch", "properties": { "method": { "$ref": "pulumi.json#/Any", "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform." }, "queryString": { "$ref": "pulumi.json#/Any", "description": "Inspect the query string. This is the part of a URL that appears after a ? character, if any." }, "singleHeader": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SingleHeaderModelProperties", "description": "Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive." }, "uriPath": { "$ref": "pulumi.json#/Any", "description": "Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg." } }, "type": "object" }, "azure-native:awsconnector:FieldToMatchResponse": { "description": "Definition of FieldToMatch", "properties": { "method": { "$ref": "pulumi.json#/Any", "description": "Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform." }, "queryString": { "$ref": "pulumi.json#/Any", "description": "Inspect the query string. This is the part of a URL that appears after a ? character, if any." }, "singleHeader": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SingleHeaderModelPropertiesResponse", "description": "Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive." }, "uriPath": { "$ref": "pulumi.json#/Any", "description": "Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg." } }, "type": "object" }, "azure-native:awsconnector:FileFormat": { "description": "Property fileFormat", "type": "string", "enum": [ { "name": "parquet", "description": "FileFormat enum parquet", "value": "parquet" }, { "name": "PlainText", "description": "FileFormat enum plain-text", "value": "plain-text" } ] }, "azure-native:awsconnector:FileSystemConfig": { "description": "Definition of FileSystemConfig", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system." }, "localMountPath": { "type": "string", "description": "The path where the function can access the file system, starting with ``/mnt/``." } }, "type": "object" }, "azure-native:awsconnector:FileSystemConfigResponse": { "description": "Definition of FileSystemConfig", "properties": { "arn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system." }, "localMountPath": { "type": "string", "description": "The path where the function can access the file system, starting with ``/mnt/``." } }, "type": "object" }, "azure-native:awsconnector:FileSystemProtection": { "description": "Definition of FileSystemProtection", "properties": { "replicationOverwriteProtection": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FileSystemProtectionReplicationOverwriteProtection" } ], "description": "The status of the file system's replication overwrite protection. + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable." } }, "type": "object" }, "azure-native:awsconnector:FileSystemProtectionReplicationOverwriteProtection": { "description": "The status of the file system's replication overwrite protection. + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.", "type": "string", "enum": [ { "name": "DISABLED", "description": "FileSystemProtectionReplicationOverwriteProtection enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "FileSystemProtectionReplicationOverwriteProtection enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:FileSystemProtectionResponse": { "description": "Definition of FileSystemProtection", "properties": { "replicationOverwriteProtection": { "type": "string", "description": "The status of the file system's replication overwrite protection. + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable." } }, "type": "object" }, "azure-native:awsconnector:FileSystemType": { "description": "Property value", "type": "string", "enum": [ { "name": "EFS", "description": "FileSystemType enum EFS", "value": "EFS" } ] }, "azure-native:awsconnector:FileSystemTypeEnumValue": { "description": "Definition of FileSystemTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FileSystemType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:FileSystemTypeEnumValueResponse": { "description": "Definition of FileSystemTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Filter": { "description": "Definition of Filter", "properties": { "behavior": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FilterBehavior" } ], "description": "How to handle logs that satisfy the filter's conditions and requirement." }, "conditions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Condition" }, "description": "Match conditions for the filter." }, "contains": { "type": "array", "items": { "type": "string" }, "description": "Property contains" }, "eq": { "type": "array", "items": { "type": "string" }, "description": "Property eq" }, "exists": { "type": "boolean", "description": "Property exists" }, "neq": { "type": "array", "items": { "type": "string" }, "description": "Property neq" }, "property": { "type": "string", "description": "Property property" }, "requirement": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:FilterRequirement" } ], "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." } }, "type": "object" }, "azure-native:awsconnector:FilterBehavior": { "description": "How to handle logs that satisfy the filter's conditions and requirement.", "type": "string", "enum": [ { "name": "DROP", "description": "FilterBehavior enum DROP", "value": "DROP" }, { "name": "KEEP", "description": "FilterBehavior enum KEEP", "value": "KEEP" } ] }, "azure-native:awsconnector:FilterGroup": { "description": "Definition of FilterGroup", "properties": { "webhookFilter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WebhookFilter", "description": "Property webhookFilter" } }, "type": "object" }, "azure-native:awsconnector:FilterGroupResponse": { "description": "Definition of FilterGroup", "properties": { "webhookFilter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WebhookFilterResponse", "description": "Property webhookFilter" } }, "type": "object" }, "azure-native:awsconnector:FilterRequirement": { "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.", "type": "string", "enum": [ { "name": "MEETS_ALL", "description": "FilterRequirement enum MEETS_ALL", "value": "MEETS_ALL" }, { "name": "MEETS_ANY", "description": "FilterRequirement enum MEETS_ANY", "value": "MEETS_ANY" } ] }, "azure-native:awsconnector:FilterResponse": { "description": "Definition of Filter", "properties": { "contains": { "type": "array", "items": { "type": "string" }, "description": "Property contains" }, "eq": { "type": "array", "items": { "type": "string" }, "description": "Property eq" }, "exists": { "type": "boolean", "description": "Property exists" }, "neq": { "type": "array", "items": { "type": "string" }, "description": "Property neq" }, "property": { "type": "string", "description": "Property property" } }, "type": "object" }, "azure-native:awsconnector:FilterResponseV1": { "description": "Definition of Filter", "properties": { "behavior": { "type": "string", "description": "How to handle logs that satisfy the filter's conditions and requirement." }, "conditions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConditionResponse" }, "description": "Match conditions for the filter." }, "requirement": { "type": "string", "description": "Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition." } }, "type": "object" }, "azure-native:awsconnector:FilterRule": { "description": "Definition of FilterRule", "properties": { "name": { "type": "string", "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." }, "value": { "type": "string", "description": "The value that the filter searches for in object key names." } }, "type": "object" }, "azure-native:awsconnector:FilterRuleResponse": { "description": "Definition of FilterRule", "properties": { "name": { "type": "string", "description": "The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." }, "value": { "type": "string", "description": "The value that the filter searches for in object key names." } }, "type": "object" }, "azure-native:awsconnector:FirelensConfiguration": { "description": "Definition of FirelensConfiguration", "properties": { "options": { "$ref": "pulumi.json#/Any", "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + ``config-file-type``, which can be ``s3`` or ``file`` + ``config-file-value``, which is either an S3 ARN or a file path" }, "type": { "type": "string", "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``." } }, "type": "object" }, "azure-native:awsconnector:FirelensConfigurationResponse": { "description": "Definition of FirelensConfiguration", "properties": { "options": { "$ref": "pulumi.json#/Any", "description": "The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + ``config-file-type``, which can be ``s3`` or ``file`` + ``config-file-value``, which is either an S3 ARN or a file path" }, "type": { "type": "string", "description": "The log router to use. The valid values are ``fluentd`` or ``fluentbit``." } }, "type": "object" }, "azure-native:awsconnector:FirewallPolicy": { "description": "Definition of FirewallPolicy", "properties": { "policyVariables": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleVariablesModel", "description": "Property policyVariables" }, "statefulDefaultActions": { "type": "array", "items": { "type": "string" }, "description": "Property statefulDefaultActions" }, "statefulEngineOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulEngineOptions", "description": "Property statefulEngineOptions" }, "statefulRuleGroupReferences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulRuleGroupReference" }, "description": "Property statefulRuleGroupReferences" }, "statelessCustomActions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CustomAction" }, "description": "Property statelessCustomActions" }, "statelessDefaultActions": { "type": "array", "items": { "type": "string" }, "description": "Property statelessDefaultActions" }, "statelessFragmentDefaultActions": { "type": "array", "items": { "type": "string" }, "description": "Property statelessFragmentDefaultActions" }, "statelessRuleGroupReferences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatelessRuleGroupReference" }, "description": "Property statelessRuleGroupReferences" }, "tlsInspectionConfigurationArn": { "type": "string", "description": "A resource ARN." } }, "type": "object" }, "azure-native:awsconnector:FirewallPolicyResponse": { "description": "Definition of FirewallPolicy", "properties": { "policyVariables": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleVariablesModelResponse", "description": "Property policyVariables" }, "statefulDefaultActions": { "type": "array", "items": { "type": "string" }, "description": "Property statefulDefaultActions" }, "statefulEngineOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulEngineOptionsResponse", "description": "Property statefulEngineOptions" }, "statefulRuleGroupReferences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulRuleGroupReferenceResponse" }, "description": "Property statefulRuleGroupReferences" }, "statelessCustomActions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CustomActionResponse" }, "description": "Property statelessCustomActions" }, "statelessDefaultActions": { "type": "array", "items": { "type": "string" }, "description": "Property statelessDefaultActions" }, "statelessFragmentDefaultActions": { "type": "array", "items": { "type": "string" }, "description": "Property statelessFragmentDefaultActions" }, "statelessRuleGroupReferences": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatelessRuleGroupReferenceResponse" }, "description": "Property statelessRuleGroupReferences" }, "tlsInspectionConfigurationArn": { "type": "string", "description": "A resource ARN." } }, "type": "object" }, "azure-native:awsconnector:FixedResponseConfigResponse": { "description": "Definition of FixedResponseConfig", "properties": { "contentType": { "type": "string", "description": "The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json" }, "messageBody": { "type": "string", "description": "The message." }, "statusCode": { "type": "string", "description": "The HTTP response code (2XX, 4XX, or 5XX)." } }, "type": "object" }, "azure-native:awsconnector:ForwardConfigResponse": { "description": "Definition of ForwardConfig", "properties": { "targetGroupStickinessConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetGroupStickinessConfigResponse", "description": "Information about the target group stickiness for a rule. Information about the target group stickiness for a rule." }, "targetGroups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetGroupTupleResponse" }, "description": "Information about how traffic will be distributed between multiple target groups in a forward rule." } }, "type": "object" }, "azure-native:awsconnector:ForwardedValues": { "description": "Definition of ForwardedValues", "properties": { "cookies": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Cookies", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*." }, "queryString": { "type": "boolean", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*." }, "queryStringCacheKeys": { "type": "array", "items": { "type": "string" }, "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior." } }, "type": "object" }, "azure-native:awsconnector:ForwardedValuesResponse": { "description": "Definition of ForwardedValues", "properties": { "cookies": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CookiesResponse", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*." }, "headers": { "type": "array", "items": { "type": "string" }, "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*." }, "queryString": { "type": "boolean", "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*." }, "queryStringCacheKeys": { "type": "array", "items": { "type": "string" }, "description": "This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior." } }, "type": "object" }, "azure-native:awsconnector:FunctionAssociation": { "description": "Definition of FunctionAssociation", "properties": { "eventType": { "type": "string", "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function." }, "functionARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the function." } }, "type": "object" }, "azure-native:awsconnector:FunctionAssociationResponse": { "description": "Definition of FunctionAssociation", "properties": { "eventType": { "type": "string", "description": "The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function." }, "functionARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the function." } }, "type": "object" }, "azure-native:awsconnector:GenerateSecretString": { "description": "Definition of GenerateSecretString", "properties": { "excludeCharacters": { "type": "string", "description": "A string of the characters that you don't want in the password." }, "excludeLowercase": { "type": "boolean", "description": "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters." }, "excludeNumbers": { "type": "boolean", "description": "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers." }, "excludePunctuation": { "type": "boolean", "description": "Specifies whether to exclude the following punctuation characters from the password: ``! ' # $ % \u0026 ' ( ) * + , - . / : ; \u003c = \u003e ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation." }, "excludeUppercase": { "type": "boolean", "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters." }, "generateStringKey": { "type": "string", "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``." }, "includeSpace": { "type": "boolean", "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters." }, "passwordLength": { "type": "integer", "description": "The length of the password. If you don't include this parameter, the default length is 32 characters." }, "requireEachIncludedType": { "type": "boolean", "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type." }, "secretStringTemplate": { "type": "string", "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created." } }, "type": "object" }, "azure-native:awsconnector:GenerateSecretStringResponse": { "description": "Definition of GenerateSecretString", "properties": { "excludeCharacters": { "type": "string", "description": "A string of the characters that you don't want in the password." }, "excludeLowercase": { "type": "boolean", "description": "Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters." }, "excludeNumbers": { "type": "boolean", "description": "Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers." }, "excludePunctuation": { "type": "boolean", "description": "Specifies whether to exclude the following punctuation characters from the password: ``! ' # $ % \u0026 ' ( ) * + , - . / : ; \u003c = \u003e ? @ [ \\ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation." }, "excludeUppercase": { "type": "boolean", "description": "Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters." }, "generateStringKey": { "type": "string", "description": "The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``." }, "includeSpace": { "type": "boolean", "description": "Specifies whether to include the space character. If you include this switch, the password can contain space characters." }, "passwordLength": { "type": "integer", "description": "The length of the password. If you don't include this parameter, the default length is 32 characters." }, "requireEachIncludedType": { "type": "boolean", "description": "Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type." }, "secretStringTemplate": { "type": "string", "description": "A template that the generated string must match. When you make a change to this property, a new secret version is created." } }, "type": "object" }, "azure-native:awsconnector:GeoLocation": { "description": "Definition of GeoLocation", "properties": { "continentCode": { "type": "string", "description": "\u003cp\u003eThe two-letter code for the continent.\u003c/p\u003e \u003cp\u003eAmazon Route 53 supports the following continent codes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAF\u003c/b\u003e: Africa\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAN\u003c/b\u003e: Antarctica\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAS\u003c/b\u003e: Asia\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eEU\u003c/b\u003e: Europe\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eOC\u003c/b\u003e: Oceania\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eNA\u003c/b\u003e: North America\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eSA\u003c/b\u003e: South America\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eConstraint: Specifying \u003ccode\u003eContinentCode\u003c/code\u003e with either \u003ccode\u003eCountryCode\u003c/code\u003e or \u003ccode\u003eSubdivisionCode\u003c/code\u003e returns an \u003ccode\u003eInvalidInput\u003c/code\u003e error.\u003c/p\u003e" }, "countryCode": { "type": "string", "description": "\u003cp\u003eFor geolocation resource record sets, the two-letter code for a country.\u003c/p\u003e \u003cp\u003eAmazon Route 53 uses the two-letter country codes that are specified in \u003ca href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'\u003eISO standard 3166-1 alpha-2\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eRoute 53 also supports the country code \u003cb\u003eUA\u003c/b\u003e for Ukraine.\u003c/p\u003e" }, "subdivisionCode": { "type": "string", "description": "\u003cp\u003eFor geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for \u003ccode\u003eSubdivisionCode\u003c/code\u003e. For a list of state abbreviations, see \u003ca href='https://pe.usps.com/text/pub28/28apb.htm'\u003eAppendix B: Two–Letter State and Possession Abbreviations\u003c/a\u003e on the United States Postal Service website. \u003c/p\u003e \u003cp\u003eIf you specify \u003ccode\u003esubdivisioncode\u003c/code\u003e, you must also specify \u003ccode\u003eUS\u003c/code\u003e for \u003ccode\u003eCountryCode\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GeoLocationResponse": { "description": "Definition of GeoLocation", "properties": { "continentCode": { "type": "string", "description": "\u003cp\u003eThe two-letter code for the continent.\u003c/p\u003e \u003cp\u003eAmazon Route 53 supports the following continent codes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAF\u003c/b\u003e: Africa\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAN\u003c/b\u003e: Antarctica\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eAS\u003c/b\u003e: Asia\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eEU\u003c/b\u003e: Europe\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eOC\u003c/b\u003e: Oceania\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eNA\u003c/b\u003e: North America\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eSA\u003c/b\u003e: South America\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eConstraint: Specifying \u003ccode\u003eContinentCode\u003c/code\u003e with either \u003ccode\u003eCountryCode\u003c/code\u003e or \u003ccode\u003eSubdivisionCode\u003c/code\u003e returns an \u003ccode\u003eInvalidInput\u003c/code\u003e error.\u003c/p\u003e" }, "countryCode": { "type": "string", "description": "\u003cp\u003eFor geolocation resource record sets, the two-letter code for a country.\u003c/p\u003e \u003cp\u003eAmazon Route 53 uses the two-letter country codes that are specified in \u003ca href='https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2'\u003eISO standard 3166-1 alpha-2\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eRoute 53 also supports the country code \u003cb\u003eUA\u003c/b\u003e for Ukraine.\u003c/p\u003e" }, "subdivisionCode": { "type": "string", "description": "\u003cp\u003eFor geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for \u003ccode\u003eSubdivisionCode\u003c/code\u003e. For a list of state abbreviations, see \u003ca href='https://pe.usps.com/text/pub28/28apb.htm'\u003eAppendix B: Two–Letter State and Possession Abbreviations\u003c/a\u003e on the United States Postal Service website. \u003c/p\u003e \u003cp\u003eIf you specify \u003ccode\u003esubdivisioncode\u003c/code\u003e, you must also specify \u003ccode\u003eUS\u003c/code\u003e for \u003ccode\u003eCountryCode\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GeoProximityLocation": { "description": "Definition of GeoProximityLocation", "properties": { "awsRegion": { "type": "string", "description": "\u003cp\u003e The Amazon Web Services Region the resource you are directing DNS traffic to, is in. \u003c/p\u003e" }, "bias": { "type": "integer", "description": "\u003cp\u003e The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. \u003c/p\u003e \u003cp\u003eTo use \u003ccode\u003eBias\u003c/code\u003e to change the size of the geographic region, specify the applicable value for the bias:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eTo expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eTo shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "coordinates": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Coordinates", "description": "\u003cp\u003e Contains the longitude and latitude for a geographic region. \u003c/p\u003e" }, "localZoneGroup": { "type": "string", "description": "\u003cp\u003e Specifies an Amazon Web Services Local Zone Group. \u003c/p\u003e \u003cp\u003eA local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is \u003ccode\u003eus-east-1-bue-1a\u003c/code\u003e the Local Zone Group is \u003ccode\u003eus-east-1-bue-1\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eYou can identify the Local Zones Group for a specific Local Zone by using the \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html'\u003edescribe-availability-zones\u003c/a\u003e CLI command:\u003c/p\u003e \u003cp\u003eThis command returns: \u003ccode\u003e'GroupName': 'us-west-2-den-1'\u003c/code\u003e, specifying that the Local Zone \u003ccode\u003eus-west-2-den-1a\u003c/code\u003e belongs to the Local Zone Group \u003ccode\u003eus-west-2-den-1\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GeoProximityLocationResponse": { "description": "Definition of GeoProximityLocation", "properties": { "awsRegion": { "type": "string", "description": "\u003cp\u003e The Amazon Web Services Region the resource you are directing DNS traffic to, is in. \u003c/p\u003e" }, "bias": { "type": "integer", "description": "\u003cp\u003e The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource. \u003c/p\u003e \u003cp\u003eTo use \u003ccode\u003eBias\u003c/code\u003e to change the size of the geographic region, specify the applicable value for the bias:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eTo expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eTo shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "coordinates": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CoordinatesResponse", "description": "\u003cp\u003e Contains the longitude and latitude for a geographic region. \u003c/p\u003e" }, "localZoneGroup": { "type": "string", "description": "\u003cp\u003e Specifies an Amazon Web Services Local Zone Group. \u003c/p\u003e \u003cp\u003eA local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is \u003ccode\u003eus-east-1-bue-1a\u003c/code\u003e the Local Zone Group is \u003ccode\u003eus-east-1-bue-1\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eYou can identify the Local Zones Group for a specific Local Zone by using the \u003ca href='https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-availability-zones.html'\u003edescribe-availability-zones\u003c/a\u003e CLI command:\u003c/p\u003e \u003cp\u003eThis command returns: \u003ccode\u003e'GroupName': 'us-west-2-den-1'\u003c/code\u003e, specifying that the Local Zone \u003ccode\u003eus-west-2-den-1a\u003c/code\u003e belongs to the Local Zone Group \u003ccode\u003eus-west-2-den-1\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GeoRestriction": { "description": "Definition of GeoRestriction", "properties": { "locations": { "type": "array", "items": { "type": "string" }, "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content or not distribute your content." }, "restrictionType": { "type": "string", "description": "The method that you want to use to restrict distribution of your content by country." } }, "type": "object" }, "azure-native:awsconnector:GeoRestrictionResponse": { "description": "Definition of GeoRestriction", "properties": { "locations": { "type": "array", "items": { "type": "string" }, "description": "A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content or not distribute your content." }, "restrictionType": { "type": "string", "description": "The method that you want to use to restrict distribution of your content by country." } }, "type": "object" }, "azure-native:awsconnector:GitSubmodulesConfig": { "description": "Definition of GitSubmodulesConfig", "properties": { "fetchSubmodules": { "type": "boolean", "description": "\u003cp\u003e Set to true to fetch Git submodules for your CodeBuild build project. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GitSubmodulesConfigResponse": { "description": "Definition of GitSubmodulesConfig", "properties": { "fetchSubmodules": { "type": "boolean", "description": "\u003cp\u003e Set to true to fetch Git submodules for your CodeBuild build project. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GlobalSecondaryIndex": { "description": "Definition of GlobalSecondaryIndex", "properties": { "contributorInsightsSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContributorInsightsSpecification", "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights." }, "indexName": { "type": "string", "description": "The name of the global secondary index. The name must be unique among all other indexes on this table." }, "keySchema": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeySchema" }, "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." }, "projection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Projection", "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." }, "provisionedThroughput": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProvisionedThroughput", "description": "Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html)." } }, "type": "object" }, "azure-native:awsconnector:GlobalSecondaryIndexResponse": { "description": "Definition of GlobalSecondaryIndex", "properties": { "contributorInsightsSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ContributorInsightsSpecificationResponse", "description": "The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights." }, "indexName": { "type": "string", "description": "The name of the global secondary index. The name must be unique among all other indexes on this table." }, "keySchema": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeySchemaResponse" }, "description": "The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." }, "projection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectionResponse", "description": "Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." }, "provisionedThroughput": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProvisionedThroughputResponse", "description": "Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html)." } }, "type": "object" }, "azure-native:awsconnector:Grant": { "description": "Definition of Grant", "properties": { "grantee": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Grantee", "description": "\u003cp\u003eThe person being granted permissions.\u003c/p\u003e" }, "permission": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PermissionEnumValue", "description": "\u003cp\u003eSpecifies the permission given to the grantee.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GrantResponse": { "description": "Definition of Grant", "properties": { "grantee": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GranteeResponse", "description": "\u003cp\u003eThe person being granted permissions.\u003c/p\u003e" }, "permission": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PermissionEnumValueResponse", "description": "\u003cp\u003eSpecifies the permission given to the grantee.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Grantee": { "description": "Definition of Grantee", "properties": { "displayName": { "type": "string", "description": "\u003cp\u003eScreen name of the grantee.\u003c/p\u003e" }, "emailAddress": { "type": "string", "description": "\u003cp\u003eEmail address of the grantee.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eUS East (N. Virginia)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eUS West (N. California)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e US West (Oregon)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e Asia Pacific (Singapore)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Sydney)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Tokyo)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Ireland)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eSouth America (São Paulo)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor a list of all the Amazon S3 supported Regions and endpoints, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region'\u003eRegions and Endpoints\u003c/a\u003e in the Amazon Web Services General Reference.\u003c/p\u003e \u003c/note\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe canonical user ID of the grantee.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TypeEnumValue", "description": "\u003cp\u003eType of grantee\u003c/p\u003e" }, "uri": { "type": "string", "description": "\u003cp\u003eURI of the grantee group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GranteeResponse": { "description": "Definition of Grantee", "properties": { "displayName": { "type": "string", "description": "\u003cp\u003eScreen name of the grantee.\u003c/p\u003e" }, "emailAddress": { "type": "string", "description": "\u003cp\u003eEmail address of the grantee.\u003c/p\u003e \u003cnote\u003e \u003cp\u003eUsing email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eUS East (N. Virginia)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eUS West (N. California)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e US West (Oregon)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e Asia Pacific (Singapore)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Sydney)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Tokyo)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Ireland)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eSouth America (São Paulo)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor a list of all the Amazon S3 supported Regions and endpoints, see \u003ca href='https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region'\u003eRegions and Endpoints\u003c/a\u003e in the Amazon Web Services General Reference.\u003c/p\u003e \u003c/note\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe canonical user ID of the grantee.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TypeEnumValueResponse", "description": "\u003cp\u003eType of grantee\u003c/p\u003e" }, "uri": { "type": "string", "description": "\u003cp\u003eURI of the grantee group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GraphQLApiIntrospectionConfig": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "GraphQLApiIntrospectionConfig enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "GraphQLApiIntrospectionConfig enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:GraphQLApiIntrospectionConfigEnumValue": { "description": "Definition of GraphQLApiIntrospectionConfigEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:GraphQLApiIntrospectionConfig" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:GraphQLApiIntrospectionConfigEnumValueResponse": { "description": "Definition of GraphQLApiIntrospectionConfigEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:GraphQLApiType": { "description": "Property value", "type": "string", "enum": [ { "name": "GRAPHQL", "description": "GraphQLApiType enum GRAPHQL", "value": "GRAPHQL" }, { "name": "MERGED", "description": "GraphQLApiType enum MERGED", "value": "MERGED" } ] }, "azure-native:awsconnector:GraphQLApiTypeEnumValue": { "description": "Definition of GraphQLApiTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:GraphQLApiType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:GraphQLApiTypeEnumValueResponse": { "description": "Definition of GraphQLApiTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:GraphQLApiVisibility": { "description": "Property value", "type": "string", "enum": [ { "name": "GLOBAL", "description": "GraphQLApiVisibility enum GLOBAL", "value": "GLOBAL" }, { "name": "PRIVATE", "description": "GraphQLApiVisibility enum PRIVATE", "value": "PRIVATE" } ] }, "azure-native:awsconnector:GraphQLApiVisibilityEnumValue": { "description": "Definition of GraphQLApiVisibilityEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:GraphQLApiVisibility" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:GraphQLApiVisibilityEnumValueResponse": { "description": "Definition of GraphQLApiVisibilityEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:GroupIdentifier": { "description": "Definition of GroupIdentifier", "properties": { "groupId": { "type": "string", "description": "\u003cp\u003eThe ID of the security group.\u003c/p\u003e" }, "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the security group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GroupIdentifierResponse": { "description": "Definition of GroupIdentifier", "properties": { "groupId": { "type": "string", "description": "\u003cp\u003eThe ID of the security group.\u003c/p\u003e" }, "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the security group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:GuardDutyDetectorProperties": { "description": "Definition of GuardDutyDetector", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsGuardDutyDetectorProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:GuardDutyDetectorPropertiesResponse": { "description": "Definition of GuardDutyDetector", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsGuardDutyDetectorPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Hardware": { "description": "Definition of Hardware", "properties": { "cpuCount": { "type": "integer", "description": "CPU count of the Instance." }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Disk" }, "description": "Disks attached to the Instance." }, "ramSizeInGb": { "type": "integer", "description": "RAM Size of the Instance." } }, "type": "object" }, "azure-native:awsconnector:HardwareResponse": { "description": "Definition of Hardware", "properties": { "cpuCount": { "type": "integer", "description": "CPU count of the Instance." }, "disks": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DiskResponse" }, "description": "Disks attached to the Instance." }, "ramSizeInGb": { "type": "integer", "description": "RAM Size of the Instance." } }, "type": "object" }, "azure-native:awsconnector:Header": { "description": "Definition of Header", "properties": { "destination": { "type": "string", "description": "Property destination" }, "destinationPort": { "type": "string", "description": "Property destinationPort" }, "direction": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:HeaderDirection" } ], "description": "Property direction" }, "protocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:HeaderProtocol" } ], "description": "Property protocol" }, "source": { "type": "string", "description": "Property source" }, "sourcePort": { "type": "string", "description": "Property sourcePort" } }, "type": "object" }, "azure-native:awsconnector:HeaderDirection": { "description": "Property direction", "type": "string", "enum": [ { "name": "ANY", "description": "HeaderDirection enum ANY", "value": "ANY" }, { "name": "FORWARD", "description": "HeaderDirection enum FORWARD", "value": "FORWARD" } ] }, "azure-native:awsconnector:HeaderProtocol": { "description": "Property protocol", "type": "string", "enum": [ { "name": "DCERPC", "description": "HeaderProtocol enum DCERPC", "value": "DCERPC" }, { "name": "DHCP", "description": "HeaderProtocol enum DHCP", "value": "DHCP" }, { "name": "DNS", "description": "HeaderProtocol enum DNS", "value": "DNS" }, { "name": "FTP", "description": "HeaderProtocol enum FTP", "value": "FTP" }, { "name": "HTTP", "description": "HeaderProtocol enum HTTP", "value": "HTTP" }, { "name": "ICMP", "description": "HeaderProtocol enum ICMP", "value": "ICMP" }, { "name": "IKEV2", "description": "HeaderProtocol enum IKEV2", "value": "IKEV2" }, { "name": "IMAP", "description": "HeaderProtocol enum IMAP", "value": "IMAP" }, { "name": "IP", "description": "HeaderProtocol enum IP", "value": "IP" }, { "name": "KRB5", "description": "HeaderProtocol enum KRB5", "value": "KRB5" }, { "name": "MSN", "description": "HeaderProtocol enum MSN", "value": "MSN" }, { "name": "NTP", "description": "HeaderProtocol enum NTP", "value": "NTP" }, { "name": "SMB", "description": "HeaderProtocol enum SMB", "value": "SMB" }, { "name": "SMTP", "description": "HeaderProtocol enum SMTP", "value": "SMTP" }, { "name": "SSH", "description": "HeaderProtocol enum SSH", "value": "SSH" }, { "name": "TCP", "description": "HeaderProtocol enum TCP", "value": "TCP" }, { "name": "TFTP", "description": "HeaderProtocol enum TFTP", "value": "TFTP" }, { "name": "TLS", "description": "HeaderProtocol enum TLS", "value": "TLS" }, { "name": "UDP", "description": "HeaderProtocol enum UDP", "value": "UDP" } ] }, "azure-native:awsconnector:HeaderResponse": { "description": "Definition of Header", "properties": { "destination": { "type": "string", "description": "Property destination" }, "destinationPort": { "type": "string", "description": "Property destinationPort" }, "direction": { "type": "string", "description": "Property direction" }, "protocol": { "type": "string", "description": "Property protocol" }, "source": { "type": "string", "description": "Property source" }, "sourcePort": { "type": "string", "description": "Property sourcePort" } }, "type": "object" }, "azure-native:awsconnector:HealthCheck": { "description": "Definition of HealthCheck", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. ``[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/)." }, "interval": { "type": "integer", "description": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds." }, "retries": { "type": "integer", "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3." }, "startPeriod": { "type": "integer", "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries." }, "timeout": { "type": "integer", "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5." } }, "type": "object" }, "azure-native:awsconnector:HealthCheckResponse": { "description": "Definition of HealthCheck", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. ``[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/)." }, "interval": { "type": "integer", "description": "The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds." }, "retries": { "type": "integer", "description": "The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3." }, "startPeriod": { "type": "integer", "description": "The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries." }, "timeout": { "type": "integer", "description": "The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5." } }, "type": "object" }, "azure-native:awsconnector:HibernationOptions": { "description": "Definition of HibernationOptions", "properties": { "configured": { "type": "boolean", "description": "\u003cp\u003eIf \u003ccode\u003etrue\u003c/code\u003e, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:HibernationOptionsResponse": { "description": "Definition of HibernationOptions", "properties": { "configured": { "type": "boolean", "description": "\u003cp\u003eIf \u003ccode\u003etrue\u003c/code\u003e, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:HostEntry": { "description": "Definition of HostEntry", "properties": { "hostname": { "type": "string", "description": "The hostname to use in the ``/etc/hosts`` entry." }, "ipAddress": { "type": "string", "description": "The IP address to use in the ``/etc/hosts`` entry." } }, "type": "object" }, "azure-native:awsconnector:HostEntryResponse": { "description": "Definition of HostEntry", "properties": { "hostname": { "type": "string", "description": "The hostname to use in the ``/etc/hosts`` entry." }, "ipAddress": { "type": "string", "description": "The IP address to use in the ``/etc/hosts`` entry." } }, "type": "object" }, "azure-native:awsconnector:HostVolumeProperties": { "description": "Definition of HostVolumeProperties", "properties": { "sourcePath": { "type": "string", "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported." } }, "type": "object" }, "azure-native:awsconnector:HostVolumePropertiesResponse": { "description": "Definition of HostVolumeProperties", "properties": { "sourcePath": { "type": "string", "description": "When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported." } }, "type": "object" }, "azure-native:awsconnector:HostedZoneConfig": { "description": "Definition of HostedZoneConfig", "properties": { "comment": { "type": "string", "description": "Any comments that you want to include about the hosted zone." } }, "type": "object" }, "azure-native:awsconnector:HostedZoneConfigResponse": { "description": "Definition of HostedZoneConfig", "properties": { "comment": { "type": "string", "description": "Any comments that you want to include about the hosted zone." } }, "type": "object" }, "azure-native:awsconnector:HostedZoneTag": { "description": "Definition of HostedZoneTag", "properties": { "key": { "type": "string", "description": "The value of ``Key`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + *Delete a key*: ``Key`` is the name of the tag you want to remove. + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check." }, "value": { "type": "string", "description": "The value of ``Value`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + *Edit a tag*: ``Value`` is the new value that you want to assign the tag." } }, "type": "object" }, "azure-native:awsconnector:HostedZoneTagResponse": { "description": "Definition of HostedZoneTag", "properties": { "key": { "type": "string", "description": "The value of ``Key`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + *Delete a key*: ``Key`` is the name of the tag you want to remove. + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check." }, "value": { "type": "string", "description": "The value of ``Value`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + *Edit a tag*: ``Value`` is the new value that you want to assign the tag." } }, "type": "object" }, "azure-native:awsconnector:HostnameType": { "description": "Property value", "type": "string", "enum": [ { "name": "IpName", "description": "HostnameType enum ip-name", "value": "ip-name" }, { "name": "ResourceName", "description": "HostnameType enum resource-name", "value": "resource-name" } ] }, "azure-native:awsconnector:HostnameTypeEnumValue": { "description": "Definition of HostnameTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:HostnameType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:HostnameTypeEnumValueResponse": { "description": "Definition of HostnameTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:HttpTokensState": { "description": "Property value", "type": "string", "enum": [ { "name": "Optional", "description": "HttpTokensState enum optional", "value": "optional" }, { "name": "Required", "description": "HttpTokensState enum required", "value": "required" } ] }, "azure-native:awsconnector:HttpTokensStateEnumValue": { "description": "Definition of HttpTokensStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:HttpTokensState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:HttpTokensStateEnumValueResponse": { "description": "Definition of HttpTokensStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:HypervisorType": { "description": "Property value", "type": "string", "enum": [ { "name": "Ovm", "description": "HypervisorType enum ovm", "value": "ovm" }, { "name": "Xen", "description": "HypervisorType enum xen", "value": "xen" } ] }, "azure-native:awsconnector:HypervisorTypeEnumValue": { "description": "Definition of HypervisorTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:HypervisorType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:HypervisorTypeEnumValueResponse": { "description": "Definition of HypervisorTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IPAddressType": { "description": "Property value", "type": "string", "enum": [ { "name": "Dualstack", "description": "IPAddressType enum dualstack", "value": "dualstack" }, { "name": "Ipv4", "description": "IPAddressType enum ipv4", "value": "ipv4" } ] }, "azure-native:awsconnector:IPAddressTypeEnumValue": { "description": "Definition of IPAddressTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:IPAddressType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IPAddressTypeEnumValueResponse": { "description": "Definition of IPAddressTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IPSet": { "description": "Definition of IPSet", "properties": { "definition": { "type": "array", "items": { "type": "string" }, "description": "Property definition" } }, "type": "object" }, "azure-native:awsconnector:IPSetReference": { "description": "Definition of IPSetReference", "properties": { "referenceArn": { "type": "string", "description": "A resource ARN." } }, "type": "object" }, "azure-native:awsconnector:IPSetReferenceResponse": { "description": "Definition of IPSetReference", "properties": { "referenceArn": { "type": "string", "description": "A resource ARN." } }, "type": "object" }, "azure-native:awsconnector:IPSetResponse": { "description": "Definition of IPSet", "properties": { "definition": { "type": "array", "items": { "type": "string" }, "description": "Property definition" } }, "type": "object" }, "azure-native:awsconnector:IamAccessKeyLastUsedProperties": { "description": "Definition of IamAccessKeyLastUsed", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamAccessKeyLastUsedProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamAccessKeyLastUsedPropertiesResponse": { "description": "Definition of IamAccessKeyLastUsed", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamAccessKeyLastUsedPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamAccessKeyMetadataProperties": { "description": "Definition of IamAccessKeyMetadata", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamAccessKeyMetadataProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamAccessKeyMetadataPropertiesResponse": { "description": "Definition of IamAccessKeyMetadata", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamAccessKeyMetadataPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamGroupProperties": { "description": "Definition of IamGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamGroupPropertiesResponse": { "description": "Definition of IamGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamInstanceProfile": { "description": "Definition of IamInstanceProfile", "properties": { "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the instance profile.\u003c/p\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe ID of the instance profile.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IamInstanceProfileProperties": { "description": "Definition of IamInstanceProfile", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamInstanceProfileProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamInstanceProfilePropertiesResponse": { "description": "Definition of IamInstanceProfile", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamInstanceProfilePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamInstanceProfileResponse": { "description": "Definition of IamInstanceProfile", "properties": { "arn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the instance profile.\u003c/p\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eThe ID of the instance profile.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IamMFADeviceProperties": { "description": "Definition of IamMFADevice", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamMFADeviceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamMFADevicePropertiesResponse": { "description": "Definition of IamMFADevice", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamMFADevicePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamPasswordPolicyProperties": { "description": "Definition of IamPasswordPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamPasswordPolicyProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamPasswordPolicyPropertiesResponse": { "description": "Definition of IamPasswordPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamPasswordPolicyPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamPolicyVersionProperties": { "description": "Definition of IamPolicyVersion", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamPolicyVersionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamPolicyVersionPropertiesResponse": { "description": "Definition of IamPolicyVersion", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamPolicyVersionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamRoleProperties": { "description": "Definition of IamRole", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamRoleProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamRolePropertiesResponse": { "description": "Definition of IamRole", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamRolePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamServerCertificateProperties": { "description": "Definition of IamServerCertificate", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamServerCertificateProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamServerCertificatePropertiesResponse": { "description": "Definition of IamServerCertificate", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamServerCertificatePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:IamVirtualMFADeviceProperties": { "description": "Definition of IamVirtualMFADevice", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamVirtualMFADeviceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:IamVirtualMFADevicePropertiesResponse": { "description": "Definition of IamVirtualMFADevice", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsIamVirtualMFADevicePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Identity": { "description": "Definition of Identity", "properties": { "oidc": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OIDC", "description": "\u003cp\u003eAn object representing the \u003ca href='https://openid.net/connect/'\u003eOpenID Connect\u003c/a\u003e identity provider information.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IdentityResponse": { "description": "Definition of Identity", "properties": { "oidc": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OIDCResponse", "description": "\u003cp\u003eAn object representing the \u003ca href='https://openid.net/connect/'\u003eOpenID Connect\u003c/a\u003e identity provider information.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ImageConfig": { "description": "Definition of ImageConfig", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list." }, "entryPoint": { "type": "array", "items": { "type": "string" }, "description": "Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list." }, "workingDirectory": { "type": "string", "description": "Specifies the working directory. The length of the directory string cannot exceed 1,000 characters." } }, "type": "object" }, "azure-native:awsconnector:ImageConfigResponse": { "description": "Definition of ImageConfig", "properties": { "command": { "type": "array", "items": { "type": "string" }, "description": "Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list." }, "entryPoint": { "type": "array", "items": { "type": "string" }, "description": "Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list." }, "workingDirectory": { "type": "string", "description": "Specifies the working directory. The length of the directory string cannot exceed 1,000 characters." } }, "type": "object" }, "azure-native:awsconnector:ImagePullCredentialsType": { "description": "Property value", "type": "string", "enum": [ { "name": "CODEBUILD", "description": "ImagePullCredentialsType enum CODEBUILD", "value": "CODEBUILD" }, { "name": "SERVICE_ROLE", "description": "ImagePullCredentialsType enum SERVICE_ROLE", "value": "SERVICE_ROLE" } ] }, "azure-native:awsconnector:ImagePullCredentialsTypeEnumValue": { "description": "Definition of ImagePullCredentialsTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ImagePullCredentialsType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImagePullCredentialsTypeEnumValueResponse": { "description": "Definition of ImagePullCredentialsTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImageScanFindingsSummary": { "description": "Definition of ImageScanFindingsSummary", "properties": { "findingSeverityCounts": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "\u003cp\u003eThe image vulnerability counts, sorted by severity.\u003c/p\u003e" }, "imageScanCompletedAt": { "type": "string", "description": "\u003cp\u003eThe time of the last completed image scan.\u003c/p\u003e" }, "vulnerabilitySourceUpdatedAt": { "type": "string", "description": "\u003cp\u003eThe time when the vulnerability data was last scanned.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ImageScanFindingsSummaryResponse": { "description": "Definition of ImageScanFindingsSummary", "properties": { "findingSeverityCounts": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "\u003cp\u003eThe image vulnerability counts, sorted by severity.\u003c/p\u003e" }, "imageScanCompletedAt": { "type": "string", "description": "\u003cp\u003eThe time of the last completed image scan.\u003c/p\u003e" }, "vulnerabilitySourceUpdatedAt": { "type": "string", "description": "\u003cp\u003eThe time when the vulnerability data was last scanned.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ImageScanStatus": { "description": "Definition of ImageScanStatus", "properties": { "description": { "type": "string", "description": "\u003cp\u003eThe description of the image scan status.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScanStatusEnumValue", "description": "\u003cp\u003eThe current state of an image scan.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ImageScanStatusResponse": { "description": "Definition of ImageScanStatus", "properties": { "description": { "type": "string", "description": "\u003cp\u003eThe description of the image scan status.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ScanStatusEnumValueResponse", "description": "\u003cp\u003eThe current state of an image scan.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ImageScanningConfiguration": { "description": "Definition of ImageScanningConfiguration", "properties": { "scanOnPush": { "type": "boolean", "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. The setting that determines whether images are scanned after being pushed to a repository." } }, "type": "object" }, "azure-native:awsconnector:ImageScanningConfigurationResponse": { "description": "Definition of ImageScanningConfiguration", "properties": { "scanOnPush": { "type": "boolean", "description": "The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. The setting that determines whether images are scanned after being pushed to a repository." } }, "type": "object" }, "azure-native:awsconnector:ImageState": { "description": "Property value", "type": "string", "enum": [ { "name": "Available", "description": "ImageState enum available", "value": "available" }, { "name": "Deregistered", "description": "ImageState enum deregistered", "value": "deregistered" }, { "name": "Disabled", "description": "ImageState enum disabled", "value": "disabled" }, { "name": "Error", "description": "ImageState enum error", "value": "error" }, { "name": "Failed", "description": "ImageState enum failed", "value": "failed" }, { "name": "Invalid", "description": "ImageState enum invalid", "value": "invalid" }, { "name": "Pending", "description": "ImageState enum pending", "value": "pending" }, { "name": "Transient", "description": "ImageState enum transient", "value": "transient" } ] }, "azure-native:awsconnector:ImageStateEnumValue": { "description": "Definition of ImageStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ImageState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImageStateEnumValueResponse": { "description": "Definition of ImageStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImageTagMutability": { "description": "The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.", "type": "string", "enum": [ { "name": "IMMUTABLE", "description": "ImageTagMutability enum IMMUTABLE", "value": "IMMUTABLE" }, { "name": "MUTABLE", "description": "ImageTagMutability enum MUTABLE", "value": "MUTABLE" } ] }, "azure-native:awsconnector:ImageTypeValues": { "description": "Property value", "type": "string", "enum": [ { "name": "Kernel", "description": "ImageTypeValues enum kernel", "value": "kernel" }, { "name": "Machine", "description": "ImageTypeValues enum machine", "value": "machine" }, { "name": "Ramdisk", "description": "ImageTypeValues enum ramdisk", "value": "ramdisk" } ] }, "azure-native:awsconnector:ImageTypeValuesEnumValue": { "description": "Definition of ImageTypeValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ImageTypeValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImageTypeValuesEnumValueResponse": { "description": "Definition of ImageTypeValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImdsSupportValues": { "description": "Property value", "type": "string", "enum": [ { "name": "V20", "description": "ImdsSupportValues enum v2.0", "value": "v2.0" } ] }, "azure-native:awsconnector:ImdsSupportValuesEnumValue": { "description": "Definition of ImdsSupportValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ImdsSupportValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImdsSupportValuesEnumValueResponse": { "description": "Definition of ImdsSupportValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ImportSourceSpecification": { "description": "Definition of ImportSourceSpecification", "properties": { "inputCompressionType": { "type": "string", "description": "Type of compression to be used on the input coming from the imported table." }, "inputFormat": { "type": "string", "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``." }, "inputFormatOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InputFormatOptions", "description": "Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption." }, "s3BucketSource": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3BucketSource", "description": "The S3 bucket that provides the source for the import. The S3 bucket that is being imported from." } }, "type": "object" }, "azure-native:awsconnector:ImportSourceSpecificationResponse": { "description": "Definition of ImportSourceSpecification", "properties": { "inputCompressionType": { "type": "string", "description": "Type of compression to be used on the input coming from the imported table." }, "inputFormat": { "type": "string", "description": "The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``." }, "inputFormatOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InputFormatOptionsResponse", "description": "Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption." }, "s3BucketSource": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3BucketSourceResponse", "description": "The S3 bucket that provides the source for the import. The S3 bucket that is being imported from." } }, "type": "object" }, "azure-native:awsconnector:InferenceAccelerator": { "description": "Definition of InferenceAccelerator", "properties": { "deviceName": { "type": "string", "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html)." }, "deviceType": { "type": "string", "description": "The Elastic Inference accelerator type to use." } }, "type": "object" }, "azure-native:awsconnector:InferenceAcceleratorResponse": { "description": "Definition of InferenceAccelerator", "properties": { "deviceName": { "type": "string", "description": "The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html)." }, "deviceType": { "type": "string", "description": "The Elastic Inference accelerator type to use." } }, "type": "object" }, "azure-native:awsconnector:InitiatedBy": { "description": "Property value", "type": "string", "enum": [ { "name": "CUSTOMER", "description": "InitiatedBy enum CUSTOMER", "value": "CUSTOMER" }, { "name": "SERVICE", "description": "InitiatedBy enum SERVICE", "value": "SERVICE" } ] }, "azure-native:awsconnector:InitiatedByEnumValue": { "description": "Definition of InitiatedByEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InitiatedBy" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InitiatedByEnumValueResponse": { "description": "Definition of InitiatedByEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InputFormatOptions": { "description": "Definition of InputFormatOptions", "properties": { "csv": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Csv", "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList." } }, "type": "object" }, "azure-native:awsconnector:InputFormatOptionsResponse": { "description": "Definition of InputFormatOptions", "properties": { "csv": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CsvResponse", "description": "The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList." } }, "type": "object" }, "azure-native:awsconnector:InsightSelector": { "description": "Definition of InsightSelector", "properties": { "insightType": { "type": "string", "description": "The type of insight to log on a trail." } }, "type": "object" }, "azure-native:awsconnector:InsightSelectorResponse": { "description": "Definition of InsightSelector", "properties": { "insightType": { "type": "string", "description": "The type of insight to log on a trail." } }, "type": "object" }, "azure-native:awsconnector:InstanceAggregatedAssociationOverview": { "description": "Definition of InstanceAggregatedAssociationOverview", "properties": { "detailedStatus": { "type": "string", "description": "\u003cp\u003eDetailed status information about the aggregated associations.\u003c/p\u003e" }, "instanceAssociationStatusAggregatedCount": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "\u003cp\u003eThe number of associations for the managed nodes.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceAggregatedAssociationOverviewResponse": { "description": "Definition of InstanceAggregatedAssociationOverview", "properties": { "detailedStatus": { "type": "string", "description": "\u003cp\u003eDetailed status information about the aggregated associations.\u003c/p\u003e" }, "instanceAssociationStatusAggregatedCount": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "\u003cp\u003eThe number of associations for the managed nodes.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceAttachmentEnaSrdSpecification": { "description": "Definition of InstanceAttachmentEnaSrdSpecification", "properties": { "enaSrdEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether ENA Express is enabled for the network interface.\u003c/p\u003e" }, "enaSrdUdpSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAttachmentEnaSrdUdpSpecification", "description": "\u003cp\u003eConfigures ENA Express for UDP network traffic.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceAttachmentEnaSrdSpecificationResponse": { "description": "Definition of InstanceAttachmentEnaSrdSpecification", "properties": { "enaSrdEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether ENA Express is enabled for the network interface.\u003c/p\u003e" }, "enaSrdUdpSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAttachmentEnaSrdUdpSpecificationResponse", "description": "\u003cp\u003eConfigures ENA Express for UDP network traffic.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceAttachmentEnaSrdUdpSpecification": { "description": "Definition of InstanceAttachmentEnaSrdUdpSpecification", "properties": { "enaSrdUdpEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceAttachmentEnaSrdUdpSpecificationResponse": { "description": "Definition of InstanceAttachmentEnaSrdUdpSpecification", "properties": { "enaSrdUdpEnabled": { "type": "boolean", "description": "\u003cp\u003eIndicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceAutoRecoveryState": { "description": "Property value", "type": "string", "enum": [ { "name": "Default", "description": "InstanceAutoRecoveryState enum default", "value": "default" }, { "name": "Disabled", "description": "InstanceAutoRecoveryState enum disabled", "value": "disabled" } ] }, "azure-native:awsconnector:InstanceAutoRecoveryStateEnumValue": { "description": "Definition of InstanceAutoRecoveryStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceAutoRecoveryState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceAutoRecoveryStateEnumValueResponse": { "description": "Definition of InstanceAutoRecoveryStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceBlockDeviceMapping": { "description": "Definition of InstanceBlockDeviceMapping", "properties": { "deviceName": { "type": "string", "description": "\u003cp\u003eThe device name (for example, \u003ccode\u003e/dev/sdh\u003c/code\u003e or \u003ccode\u003exvdh\u003c/code\u003e).\u003c/p\u003e" }, "ebs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EbsInstanceBlockDevice", "description": "\u003cp\u003eParameters used to automatically set up EBS volumes when the instance is launched.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceBlockDeviceMappingResponse": { "description": "Definition of InstanceBlockDeviceMapping", "properties": { "deviceName": { "type": "string", "description": "\u003cp\u003eThe device name (for example, \u003ccode\u003e/dev/sdh\u003c/code\u003e or \u003ccode\u003exvdh\u003c/code\u003e).\u003c/p\u003e" }, "ebs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EbsInstanceBlockDeviceResponse", "description": "\u003cp\u003eParameters used to automatically set up EBS volumes when the instance is launched.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceBootModeValues": { "description": "Property value", "type": "string", "enum": [ { "name": "LegacyBios", "description": "InstanceBootModeValues enum legacy-bios", "value": "legacy-bios" }, { "name": "Uefi", "description": "InstanceBootModeValues enum uefi", "value": "uefi" } ] }, "azure-native:awsconnector:InstanceBootModeValuesEnumValue": { "description": "Definition of InstanceBootModeValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceBootModeValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceBootModeValuesEnumValueResponse": { "description": "Definition of InstanceBootModeValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceCollectionType": { "description": "Property value", "type": "string", "enum": [ { "name": "INSTANCE_FLEET", "description": "InstanceCollectionType enum INSTANCE_FLEET", "value": "INSTANCE_FLEET" }, { "name": "INSTANCE_GROUP", "description": "InstanceCollectionType enum INSTANCE_GROUP", "value": "INSTANCE_GROUP" } ] }, "azure-native:awsconnector:InstanceCollectionTypeEnumValue": { "description": "Definition of InstanceCollectionTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceCollectionType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceCollectionTypeEnumValueResponse": { "description": "Definition of InstanceCollectionTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv4Prefix": { "description": "Definition of InstanceIpv4Prefix", "properties": { "ipv4Prefix": { "type": "string", "description": "\u003cp\u003eOne or more IPv4 prefixes assigned to the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv4PrefixResponse": { "description": "Definition of InstanceIpv4Prefix", "properties": { "ipv4Prefix": { "type": "string", "description": "\u003cp\u003eOne or more IPv4 prefixes assigned to the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv6Address": { "description": "Definition of InstanceIpv6Address", "properties": { "ipv6Address": { "type": "string", "description": "Property ipv6Address" }, "isPrimaryIpv6": { "type": "boolean", "description": "\u003cp\u003eDetermines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'\u003eRunInstances\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv6AddressResponse": { "description": "Definition of InstanceIpv6Address", "properties": { "ipv6Address": { "type": "string", "description": "\u003cp\u003eThe IPv6 address.\u003c/p\u003e" }, "isPrimaryIpv6": { "type": "boolean", "description": "\u003cp\u003eDetermines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html'\u003eRunInstances\u003c/a\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv6AddressResponseV1": { "description": "Definition of InstanceIpv6Address", "properties": { "ipv6Address": { "type": "string", "description": "Property ipv6Address" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv6Prefix": { "description": "Definition of InstanceIpv6Prefix", "properties": { "ipv6Prefix": { "type": "string", "description": "\u003cp\u003eOne or more IPv6 prefixes assigned to the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceIpv6PrefixResponse": { "description": "Definition of InstanceIpv6Prefix", "properties": { "ipv6Prefix": { "type": "string", "description": "\u003cp\u003eOne or more IPv6 prefixes assigned to the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceLifecycleType": { "description": "Property value", "type": "string", "enum": [ { "name": "CapacityBlock", "description": "InstanceLifecycleType enum capacity-block", "value": "capacity-block" }, { "name": "Scheduled", "description": "InstanceLifecycleType enum scheduled", "value": "scheduled" }, { "name": "Spot", "description": "InstanceLifecycleType enum spot", "value": "spot" } ] }, "azure-native:awsconnector:InstanceLifecycleTypeEnumValue": { "description": "Definition of InstanceLifecycleTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceLifecycleType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceLifecycleTypeEnumValueResponse": { "description": "Definition of InstanceLifecycleTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceMaintenanceOptions": { "description": "Definition of InstanceMaintenanceOptions", "properties": { "autoRecovery": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAutoRecoveryStateEnumValue", "description": "\u003cp\u003eProvides information on the current automatic recovery behavior of your instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceMaintenanceOptionsResponse": { "description": "Definition of InstanceMaintenanceOptions", "properties": { "autoRecovery": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAutoRecoveryStateEnumValueResponse", "description": "\u003cp\u003eProvides information on the current automatic recovery behavior of your instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceMaintenancePolicy": { "description": "Definition of InstanceMaintenancePolicy", "properties": { "maxHealthyPercentage": { "type": "integer", "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time." }, "minHealthyPercentage": { "type": "integer", "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``." } }, "type": "object" }, "azure-native:awsconnector:InstanceMaintenancePolicyResponse": { "description": "Definition of InstanceMaintenancePolicy", "properties": { "maxHealthyPercentage": { "type": "integer", "description": "Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time." }, "minHealthyPercentage": { "type": "integer", "description": "Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``." } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataEndpointState": { "description": "Property value", "type": "string", "enum": [ { "name": "Disabled", "description": "InstanceMetadataEndpointState enum disabled", "value": "disabled" }, { "name": "Enabled", "description": "InstanceMetadataEndpointState enum enabled", "value": "enabled" } ] }, "azure-native:awsconnector:InstanceMetadataEndpointStateEnumValue": { "description": "Definition of InstanceMetadataEndpointStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceMetadataEndpointState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataEndpointStateEnumValueResponse": { "description": "Definition of InstanceMetadataEndpointStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataOptionsResponse": { "description": "Definition of InstanceMetadataOptionsResponse", "properties": { "httpEndpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataEndpointStateEnumValue", "description": "\u003cp\u003eIndicates whether the HTTP metadata endpoint on your instances is enabled or disabled.\u003c/p\u003e \u003cp\u003eIf the value is \u003ccode\u003edisabled\u003c/code\u003e, you cannot access your instance metadata.\u003c/p\u003e" }, "httpProtocolIpv6": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataProtocolStateEnumValue", "description": "\u003cp\u003eIndicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.\u003c/p\u003e \u003cp\u003eDefault: \u003ccode\u003edisabled\u003c/code\u003e \u003c/p\u003e" }, "httpPutResponseHopLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum number of hops that the metadata token can travel.\u003c/p\u003e \u003cp\u003ePossible values: Integers from \u003ccode\u003e1\u003c/code\u003e to \u003ccode\u003e64\u003c/code\u003e \u003c/p\u003e" }, "httpTokens": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HttpTokensStateEnumValue", "description": "\u003cp\u003eIndicates whether IMDSv2 is required.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eoptional\u003c/code\u003e - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003erequired\u003c/code\u003e - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "instanceMetadataTags": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataTagsStateEnumValue", "description": "\u003cp\u003eIndicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS'\u003eWork with instance tags using the instance metadata\u003c/a\u003e.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataOptionsStateEnumValue", "description": "\u003cp\u003eThe state of the metadata option changes.\u003c/p\u003e \u003cp\u003e \u003ccode\u003epending\u003c/code\u003e - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.\u003c/p\u003e \u003cp\u003e \u003ccode\u003eapplied\u003c/code\u003e - The metadata options have been successfully applied on the instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataOptionsResponseResponse": { "description": "Definition of InstanceMetadataOptionsResponse", "properties": { "httpEndpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataEndpointStateEnumValueResponse", "description": "\u003cp\u003eIndicates whether the HTTP metadata endpoint on your instances is enabled or disabled.\u003c/p\u003e \u003cp\u003eIf the value is \u003ccode\u003edisabled\u003c/code\u003e, you cannot access your instance metadata.\u003c/p\u003e" }, "httpProtocolIpv6": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataProtocolStateEnumValueResponse", "description": "\u003cp\u003eIndicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.\u003c/p\u003e \u003cp\u003eDefault: \u003ccode\u003edisabled\u003c/code\u003e \u003c/p\u003e" }, "httpPutResponseHopLimit": { "type": "integer", "description": "\u003cp\u003eThe maximum number of hops that the metadata token can travel.\u003c/p\u003e \u003cp\u003ePossible values: Integers from \u003ccode\u003e1\u003c/code\u003e to \u003ccode\u003e64\u003c/code\u003e \u003c/p\u003e" }, "httpTokens": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HttpTokensStateEnumValueResponse", "description": "\u003cp\u003eIndicates whether IMDSv2 is required.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eoptional\u003c/code\u003e - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003erequired\u003c/code\u003e - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "instanceMetadataTags": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataTagsStateEnumValueResponse", "description": "\u003cp\u003eIndicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#work-with-tags-in-IMDS'\u003eWork with instance tags using the instance metadata\u003c/a\u003e.\u003c/p\u003e" }, "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceMetadataOptionsStateEnumValueResponse", "description": "\u003cp\u003eThe state of the metadata option changes.\u003c/p\u003e \u003cp\u003e \u003ccode\u003epending\u003c/code\u003e - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.\u003c/p\u003e \u003cp\u003e \u003ccode\u003eapplied\u003c/code\u003e - The metadata options have been successfully applied on the instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataOptionsState": { "description": "Property value", "type": "string", "enum": [ { "name": "Applied", "description": "InstanceMetadataOptionsState enum applied", "value": "applied" }, { "name": "Pending", "description": "InstanceMetadataOptionsState enum pending", "value": "pending" } ] }, "azure-native:awsconnector:InstanceMetadataOptionsStateEnumValue": { "description": "Definition of InstanceMetadataOptionsStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceMetadataOptionsState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataOptionsStateEnumValueResponse": { "description": "Definition of InstanceMetadataOptionsStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataProtocolState": { "description": "Property value", "type": "string", "enum": [ { "name": "Disabled", "description": "InstanceMetadataProtocolState enum disabled", "value": "disabled" }, { "name": "Enabled", "description": "InstanceMetadataProtocolState enum enabled", "value": "enabled" } ] }, "azure-native:awsconnector:InstanceMetadataProtocolStateEnumValue": { "description": "Definition of InstanceMetadataProtocolStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceMetadataProtocolState" } ], "description": "Property value", "default": "disabled" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataProtocolStateEnumValueResponse": { "description": "Definition of InstanceMetadataProtocolStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value", "default": "disabled" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataTagsState": { "description": "Property value", "type": "string", "enum": [ { "name": "Disabled", "description": "InstanceMetadataTagsState enum disabled", "value": "disabled" }, { "name": "Enabled", "description": "InstanceMetadataTagsState enum enabled", "value": "enabled" } ] }, "azure-native:awsconnector:InstanceMetadataTagsStateEnumValue": { "description": "Definition of InstanceMetadataTagsStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceMetadataTagsState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceMetadataTagsStateEnumValueResponse": { "description": "Definition of InstanceMetadataTagsStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceNetworkInterface": { "description": "Definition of InstanceNetworkInterface", "properties": { "association": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceAssociation", "description": "\u003cp\u003eThe association information for an Elastic IPv4 associated with the network interface.\u003c/p\u003e" }, "attachment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceAttachment", "description": "\u003cp\u003eThe network interface attachment.\u003c/p\u003e" }, "connectionTrackingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConnectionTrackingSpecificationResponse", "description": "\u003cp\u003eA security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts'\u003eConnection tracking timeouts\u003c/a\u003e in the \u003ci\u003eAmazon Elastic Compute Cloud User Guide\u003c/i\u003e.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description.\u003c/p\u003e" }, "groups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GroupIdentifier" }, "description": "\u003cp\u003eThe security groups.\u003c/p\u003e" }, "interfaceType": { "type": "string", "description": "\u003cp\u003eThe type of network interface.\u003c/p\u003e \u003cp\u003eValid values: \u003ccode\u003einterface\u003c/code\u003e | \u003ccode\u003eefa\u003c/code\u003e | \u003ccode\u003etrunk\u003c/code\u003e \u003c/p\u003e" }, "ipv4Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv4Prefix" }, "description": "\u003cp\u003eThe IPv4 delegated prefixes that are assigned to the network interface.\u003c/p\u003e" }, "ipv6Addresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv6Address" }, "description": "\u003cp\u003eThe IPv6 addresses associated with the network interface.\u003c/p\u003e" }, "ipv6Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv6Prefix" }, "description": "\u003cp\u003eThe IPv6 delegated prefixes that are assigned to the network interface.\u003c/p\u003e" }, "macAddress": { "type": "string", "description": "\u003cp\u003eThe MAC address.\u003c/p\u003e" }, "networkInterfaceId": { "type": "string", "description": "\u003cp\u003eThe ID of the network interface.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that created the network interface.\u003c/p\u003e" }, "privateDnsName": { "type": "string", "description": "\u003cp\u003eThe private DNS name.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe IPv4 address of the network interface within the subnet.\u003c/p\u003e" }, "privateIpAddresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstancePrivateIpAddress" }, "description": "\u003cp\u003eThe private IPv4 addresses associated with the network interface.\u003c/p\u003e" }, "sourceDestCheck": { "type": "boolean", "description": "\u003cp\u003eIndicates whether source/destination checking is enabled.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkInterfaceStatusEnumValue", "description": "\u003cp\u003eThe status of the network interface.\u003c/p\u003e" }, "subnetId": { "type": "string", "description": "\u003cp\u003eThe ID of the subnet.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceNetworkInterfaceAssociation": { "description": "Definition of InstanceNetworkInterfaceAssociation", "properties": { "carrierIp": { "type": "string", "description": "\u003cp\u003eThe carrier IP address associated with the network interface.\u003c/p\u003e" }, "customerOwnedIp": { "type": "string", "description": "\u003cp\u003eThe customer-owned IP address associated with the network interface.\u003c/p\u003e" }, "ipOwnerId": { "type": "string", "description": "\u003cp\u003eThe ID of the owner of the Elastic IP address.\u003c/p\u003e" }, "publicDnsName": { "type": "string", "description": "\u003cp\u003eThe public DNS name.\u003c/p\u003e" }, "publicIp": { "type": "string", "description": "\u003cp\u003eThe public IP address or Elastic IP address bound to the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceNetworkInterfaceAssociationResponse": { "description": "Definition of InstanceNetworkInterfaceAssociation", "properties": { "carrierIp": { "type": "string", "description": "\u003cp\u003eThe carrier IP address associated with the network interface.\u003c/p\u003e" }, "customerOwnedIp": { "type": "string", "description": "\u003cp\u003eThe customer-owned IP address associated with the network interface.\u003c/p\u003e" }, "ipOwnerId": { "type": "string", "description": "\u003cp\u003eThe ID of the owner of the Elastic IP address.\u003c/p\u003e" }, "publicDnsName": { "type": "string", "description": "\u003cp\u003eThe public DNS name.\u003c/p\u003e" }, "publicIp": { "type": "string", "description": "\u003cp\u003eThe public IP address or Elastic IP address bound to the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceNetworkInterfaceAttachment": { "description": "Definition of InstanceNetworkInterfaceAttachment", "properties": { "attachTime": { "type": "string", "description": "\u003cp\u003eThe time stamp when the attachment initiated.\u003c/p\u003e" }, "attachmentId": { "type": "string", "description": "\u003cp\u003eThe ID of the network interface attachment.\u003c/p\u003e" }, "deleteOnTermination": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the network interface is deleted when the instance is terminated.\u003c/p\u003e" }, "deviceIndex": { "type": "integer", "description": "\u003cp\u003eThe index of the device on the instance for the network interface attachment.\u003c/p\u003e" }, "enaSrdSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAttachmentEnaSrdSpecification", "description": "\u003cp\u003eContains the ENA Express settings for the network interface that's attached to the instance.\u003c/p\u003e" }, "networkCardIndex": { "type": "integer", "description": "\u003cp\u003eThe index of the network card.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AttachmentStatusEnumValue", "description": "\u003cp\u003eThe attachment state.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceNetworkInterfaceAttachmentResponse": { "description": "Definition of InstanceNetworkInterfaceAttachment", "properties": { "attachTime": { "type": "string", "description": "\u003cp\u003eThe time stamp when the attachment initiated.\u003c/p\u003e" }, "attachmentId": { "type": "string", "description": "\u003cp\u003eThe ID of the network interface attachment.\u003c/p\u003e" }, "deleteOnTermination": { "type": "boolean", "description": "\u003cp\u003eIndicates whether the network interface is deleted when the instance is terminated.\u003c/p\u003e" }, "deviceIndex": { "type": "integer", "description": "\u003cp\u003eThe index of the device on the instance for the network interface attachment.\u003c/p\u003e" }, "enaSrdSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceAttachmentEnaSrdSpecificationResponse", "description": "\u003cp\u003eContains the ENA Express settings for the network interface that's attached to the instance.\u003c/p\u003e" }, "networkCardIndex": { "type": "integer", "description": "\u003cp\u003eThe index of the network card.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AttachmentStatusEnumValueResponse", "description": "\u003cp\u003eThe attachment state.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceNetworkInterfaceResponse": { "description": "Definition of InstanceNetworkInterface", "properties": { "association": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceAssociationResponse", "description": "\u003cp\u003eThe association information for an Elastic IPv4 associated with the network interface.\u003c/p\u003e" }, "attachment": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceAttachmentResponse", "description": "\u003cp\u003eThe network interface attachment.\u003c/p\u003e" }, "connectionTrackingConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ConnectionTrackingSpecificationResponseResponse", "description": "\u003cp\u003eA security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts'\u003eConnection tracking timeouts\u003c/a\u003e in the \u003ci\u003eAmazon Elastic Compute Cloud User Guide\u003c/i\u003e.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eThe description.\u003c/p\u003e" }, "groups": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GroupIdentifierResponse" }, "description": "\u003cp\u003eThe security groups.\u003c/p\u003e" }, "interfaceType": { "type": "string", "description": "\u003cp\u003eThe type of network interface.\u003c/p\u003e \u003cp\u003eValid values: \u003ccode\u003einterface\u003c/code\u003e | \u003ccode\u003eefa\u003c/code\u003e | \u003ccode\u003etrunk\u003c/code\u003e \u003c/p\u003e" }, "ipv4Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv4PrefixResponse" }, "description": "\u003cp\u003eThe IPv4 delegated prefixes that are assigned to the network interface.\u003c/p\u003e" }, "ipv6Addresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv6AddressResponse" }, "description": "\u003cp\u003eThe IPv6 addresses associated with the network interface.\u003c/p\u003e" }, "ipv6Prefixes": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceIpv6PrefixResponse" }, "description": "\u003cp\u003eThe IPv6 delegated prefixes that are assigned to the network interface.\u003c/p\u003e" }, "macAddress": { "type": "string", "description": "\u003cp\u003eThe MAC address.\u003c/p\u003e" }, "networkInterfaceId": { "type": "string", "description": "\u003cp\u003eThe ID of the network interface.\u003c/p\u003e" }, "ownerId": { "type": "string", "description": "\u003cp\u003eThe ID of the Amazon Web Services account that created the network interface.\u003c/p\u003e" }, "privateDnsName": { "type": "string", "description": "\u003cp\u003eThe private DNS name.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe IPv4 address of the network interface within the subnet.\u003c/p\u003e" }, "privateIpAddresses": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstancePrivateIpAddressResponse" }, "description": "\u003cp\u003eThe private IPv4 addresses associated with the network interface.\u003c/p\u003e" }, "sourceDestCheck": { "type": "boolean", "description": "\u003cp\u003eIndicates whether source/destination checking is enabled.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkInterfaceStatusEnumValueResponse", "description": "\u003cp\u003eThe status of the network interface.\u003c/p\u003e" }, "subnetId": { "type": "string", "description": "\u003cp\u003eThe ID of the subnet.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstancePrivateIpAddress": { "description": "Definition of InstancePrivateIpAddress", "properties": { "association": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceAssociation", "description": "\u003cp\u003eThe association information for an Elastic IP address for the network interface.\u003c/p\u003e" }, "primary": { "type": "boolean", "description": "\u003cp\u003eIndicates whether this IPv4 address is the primary private IP address of the network interface.\u003c/p\u003e" }, "privateDnsName": { "type": "string", "description": "\u003cp\u003eThe private IPv4 DNS name.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IPv4 address of the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstancePrivateIpAddressResponse": { "description": "Definition of InstancePrivateIpAddress", "properties": { "association": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceNetworkInterfaceAssociationResponse", "description": "\u003cp\u003eThe association information for an Elastic IP address for the network interface.\u003c/p\u003e" }, "primary": { "type": "boolean", "description": "\u003cp\u003eIndicates whether this IPv4 address is the primary private IP address of the network interface.\u003c/p\u003e" }, "privateDnsName": { "type": "string", "description": "\u003cp\u003eThe private IPv4 DNS name.\u003c/p\u003e" }, "privateIpAddress": { "type": "string", "description": "\u003cp\u003eThe private IPv4 address of the network interface.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceRequirements": { "description": "Definition of InstanceRequirements", "properties": { "acceleratorCount": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AcceleratorCountRequest", "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type." }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "Indicates whether instance types must have accelerators by specific manufacturers. + For instance types with NVIDIA devices, specify ``nvidia``. + For instance types with AMD devices, specify ``amd``. + For instance types with AWS devices, specify ``amazon-web-services``. + For instance types with Xilinx devices, specify ``xilinx``. Default: Any manufacturer" }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "Lists the accelerators that must be on an instance type. + For instance types with NVIDIA A100 GPUs, specify ``a100``. + For instance types with NVIDIA V100 GPUs, specify ``v100``. + For instance types with NVIDIA K80 GPUs, specify ``k80``. + For instance types with NVIDIA T4 GPUs, specify ``t4``. + For instance types with NVIDIA M60 GPUs, specify ``m60``. + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. Default: Any accelerator" }, "acceleratorTotalMemoryMiB": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AcceleratorTotalMemoryMiBRequest", "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB." }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "Lists the accelerator types that must be on an instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type" }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. 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*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. Default: All instance types" }, "bareMetal": { "type": "string", "description": "Indicates whether bare metal instance types are included, excluded, or required. Default: ``excluded``" }, "baselineEbsBandwidthMbps": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BaselineEbsBandwidthMbpsRequest", "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: No minimum or maximum limits ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps." }, "burstablePerformance": { "type": "string", "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``excluded``" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "Lists which specific CPU manufacturers to include. + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. 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. Default: Any manufacturer" }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. Default: No excluded instance types" }, "instanceGenerations": { "type": "array", "items": { "type": "string" }, "description": "Indicates whether current or previous generation instance types are included. + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + For previous generation instance types, specify ``previous``. Default: Any current or previous generation" }, "localStorage": { "type": "string", "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``included``" }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "Indicates the type of local storage that is required. + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + For instance types with solid state drive (SSD) storage, specify ``ssd``. Default: Any local storage type" }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer", "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To indicate no price protection threshold, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``." }, "memoryGiBPerVCpu": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MemoryGiBPerVCpuRequest", "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB." }, "memoryMiB": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MemoryMiBRequest", "description": "The minimum and maximum instance memory size for an instance type, in MiB. ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB." }, "networkBandwidthGbps": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkBandwidthGbpsRequest", "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps. Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*." }, "networkInterfaceCount": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkInterfaceCountRequest", "description": "The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type." }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. 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``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default: ``20``" }, "requireHibernateSupport": { "type": "boolean", "description": "Indicates whether instance types must provide On-Demand Instance hibernation support. Default: ``false``" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. 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``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. Default: ``100``" }, "totalLocalStorageGB": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TotalLocalStorageGBRequest", "description": "The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB." }, "vCpuCount": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VCpuCountRequest", "description": "The minimum and maximum number of vCPUs for an instance type. ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type." } }, "type": "object" }, "azure-native:awsconnector:InstanceRequirementsResponse": { "description": "Definition of InstanceRequirements", "properties": { "acceleratorCount": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AcceleratorCountRequestResponse", "description": "The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type." }, "acceleratorManufacturers": { "type": "array", "items": { "type": "string" }, "description": "Indicates whether instance types must have accelerators by specific manufacturers. + For instance types with NVIDIA devices, specify ``nvidia``. + For instance types with AMD devices, specify ``amd``. + For instance types with AWS devices, specify ``amazon-web-services``. + For instance types with Xilinx devices, specify ``xilinx``. Default: Any manufacturer" }, "acceleratorNames": { "type": "array", "items": { "type": "string" }, "description": "Lists the accelerators that must be on an instance type. + For instance types with NVIDIA A100 GPUs, specify ``a100``. + For instance types with NVIDIA V100 GPUs, specify ``v100``. + For instance types with NVIDIA K80 GPUs, specify ``k80``. + For instance types with NVIDIA T4 GPUs, specify ``t4``. + For instance types with NVIDIA M60 GPUs, specify ``m60``. + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. Default: Any accelerator" }, "acceleratorTotalMemoryMiB": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AcceleratorTotalMemoryMiBRequestResponse", "description": "The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB." }, "acceleratorTypes": { "type": "array", "items": { "type": "string" }, "description": "Lists the accelerator types that must be on an instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type" }, "allowedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. 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*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. Default: All instance types" }, "bareMetal": { "type": "string", "description": "Indicates whether bare metal instance types are included, excluded, or required. Default: ``excluded``" }, "baselineEbsBandwidthMbps": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BaselineEbsBandwidthMbpsRequestResponse", "description": "The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: No minimum or maximum limits ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps." }, "burstablePerformance": { "type": "string", "description": "Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``excluded``" }, "cpuManufacturers": { "type": "array", "items": { "type": "string" }, "description": "Lists which specific CPU manufacturers to include. + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. 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. Default: Any manufacturer" }, "excludedInstanceTypes": { "type": "array", "items": { "type": "string" }, "description": "The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. Default: No excluded instance types" }, "instanceGenerations": { "type": "array", "items": { "type": "string" }, "description": "Indicates whether current or previous generation instance types are included. + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + For previous generation instance types, specify ``previous``. Default: Any current or previous generation" }, "localStorage": { "type": "string", "description": "Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``included``" }, "localStorageTypes": { "type": "array", "items": { "type": "string" }, "description": "Indicates the type of local storage that is required. + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + For instance types with solid state drive (SSD) storage, specify ``ssd``. Default: Any local storage type" }, "maxSpotPriceAsPercentageOfOptimalOnDemandPrice": { "type": "integer", "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To indicate no price protection threshold, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``." }, "memoryGiBPerVCpu": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MemoryGiBPerVCpuRequestResponse", "description": "The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB." }, "memoryMiB": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MemoryMiBRequestResponse", "description": "The minimum and maximum instance memory size for an instance type, in MiB. ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB." }, "networkBandwidthGbps": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkBandwidthGbpsRequestResponse", "description": "The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps. Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*." }, "networkInterfaceCount": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NetworkInterfaceCountRequestResponse", "description": "The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type." }, "onDemandMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. 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``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default: ``20``" }, "requireHibernateSupport": { "type": "boolean", "description": "Indicates whether instance types must provide On-Demand Instance hibernation support. Default: ``false``" }, "spotMaxPricePercentageOverLowestPrice": { "type": "integer", "description": "[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. 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``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. Default: ``100``" }, "totalLocalStorageGB": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TotalLocalStorageGBRequestResponse", "description": "The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB." }, "vCpuCount": { "type": "object", "$ref": "#/types/azure-native:awsconnector:VCpuCountRequestResponse", "description": "The minimum and maximum number of vCPUs for an instance type. ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type." } }, "type": "object" }, "azure-native:awsconnector:InstanceRoleType": { "description": "Property value", "type": "string", "enum": [ { "name": "CORE", "description": "InstanceRoleType enum CORE", "value": "CORE" }, { "name": "MASTER", "description": "InstanceRoleType enum MASTER", "value": "MASTER" }, { "name": "TASK", "description": "InstanceRoleType enum TASK", "value": "TASK" } ] }, "azure-native:awsconnector:InstanceRoleTypeEnumValue": { "description": "Definition of InstanceRoleTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceRoleType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceRoleTypeEnumValueResponse": { "description": "Definition of InstanceRoleTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceState": { "description": "Definition of InstanceState", "properties": { "code": { "type": "integer", "description": "\u003cp\u003eThe state of the instance as a 16-bit unsigned integer. \u003c/p\u003e \u003cp\u003eThe high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.\u003c/p\u003e \u003cp\u003eThe low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. \u003c/p\u003e \u003cp\u003eThe valid values for instance-state-code will all be in the range of the low byte and they are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e0\u003c/code\u003e : \u003ccode\u003epending\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e16\u003c/code\u003e : \u003ccode\u003erunning\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e32\u003c/code\u003e : \u003ccode\u003eshutting-down\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e48\u003c/code\u003e : \u003ccode\u003eterminated\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e64\u003c/code\u003e : \u003ccode\u003estopping\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e80\u003c/code\u003e : \u003ccode\u003estopped\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eYou can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.\u003c/p\u003e" }, "name": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStateNameEnumValue", "description": "\u003cp\u003eThe current state of the instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStateName": { "description": "Property value", "type": "string", "enum": [ { "name": "Pending", "description": "InstanceStateName enum pending", "value": "pending" }, { "name": "Running", "description": "InstanceStateName enum running", "value": "running" }, { "name": "ShuttingDown", "description": "InstanceStateName enum shutting-down", "value": "shutting-down" }, { "name": "Stopped", "description": "InstanceStateName enum stopped", "value": "stopped" }, { "name": "Stopping", "description": "InstanceStateName enum stopping", "value": "stopping" }, { "name": "Terminated", "description": "InstanceStateName enum terminated", "value": "terminated" } ] }, "azure-native:awsconnector:InstanceStateNameEnumValue": { "description": "Definition of InstanceStateNameEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceStateName" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceStateNameEnumValueResponse": { "description": "Definition of InstanceStateNameEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceStateResponse": { "description": "Definition of InstanceState", "properties": { "code": { "type": "integer", "description": "\u003cp\u003eThe state of the instance as a 16-bit unsigned integer. \u003c/p\u003e \u003cp\u003eThe high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.\u003c/p\u003e \u003cp\u003eThe low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255. \u003c/p\u003e \u003cp\u003eThe valid values for instance-state-code will all be in the range of the low byte and they are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e0\u003c/code\u003e : \u003ccode\u003epending\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e16\u003c/code\u003e : \u003ccode\u003erunning\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e32\u003c/code\u003e : \u003ccode\u003eshutting-down\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e48\u003c/code\u003e : \u003ccode\u003eterminated\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e64\u003c/code\u003e : \u003ccode\u003estopping\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003e80\u003c/code\u003e : \u003ccode\u003estopped\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eYou can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.\u003c/p\u003e" }, "name": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStateNameEnumValueResponse", "description": "\u003cp\u003eThe current state of the instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStatusDetails": { "description": "Definition of InstanceStatusDetails", "properties": { "impairedSince": { "type": "string", "description": "\u003cp\u003eThe time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.\u003c/p\u003e" }, "name": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusNameEnumValue", "description": "\u003cp\u003eThe type of instance status.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusTypeEnumValue", "description": "\u003cp\u003eThe status.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStatusDetailsResponse": { "description": "Definition of InstanceStatusDetails", "properties": { "impairedSince": { "type": "string", "description": "\u003cp\u003eThe time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.\u003c/p\u003e" }, "name": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusNameEnumValueResponse", "description": "\u003cp\u003eThe type of instance status.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusTypeEnumValueResponse", "description": "\u003cp\u003eThe status.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStatusEvent": { "description": "Definition of InstanceStatusEvent", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EventCodeEnumValue", "description": "\u003cp\u003eThe event code.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description of the event.\u003c/p\u003e \u003cp\u003eAfter a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].\u003c/p\u003e" }, "instanceEventId": { "type": "string", "description": "\u003cp\u003eThe ID of the event.\u003c/p\u003e" }, "notAfter": { "type": "string", "description": "\u003cp\u003eThe latest scheduled end time for the event.\u003c/p\u003e" }, "notBefore": { "type": "string", "description": "\u003cp\u003eThe earliest scheduled start time for the event.\u003c/p\u003e" }, "notBeforeDeadline": { "type": "string", "description": "\u003cp\u003eThe deadline for starting the event.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStatusEventResponse": { "description": "Definition of InstanceStatusEvent", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EventCodeEnumValueResponse", "description": "\u003cp\u003eThe event code.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description of the event.\u003c/p\u003e \u003cp\u003eAfter a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].\u003c/p\u003e" }, "instanceEventId": { "type": "string", "description": "\u003cp\u003eThe ID of the event.\u003c/p\u003e" }, "notAfter": { "type": "string", "description": "\u003cp\u003eThe latest scheduled end time for the event.\u003c/p\u003e" }, "notBefore": { "type": "string", "description": "\u003cp\u003eThe earliest scheduled start time for the event.\u003c/p\u003e" }, "notBeforeDeadline": { "type": "string", "description": "\u003cp\u003eThe deadline for starting the event.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStatusSummary": { "description": "Definition of InstanceStatusSummary", "properties": { "details": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusDetails" }, "description": "\u003cp\u003eThe system instance health or application instance health.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SummaryStatusEnumValue", "description": "\u003cp\u003eThe status.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceStatusSummaryResponse": { "description": "Definition of InstanceStatusSummary", "properties": { "details": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceStatusDetailsResponse" }, "description": "\u003cp\u003eThe system instance health or application instance health.\u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SummaryStatusEnumValueResponse", "description": "\u003cp\u003eThe status.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:InstanceType": { "description": "Property value", "type": "string", "enum": [ { "name": "MlC42xlarge", "description": "InstanceType enum ml.c4.2xlarge", "value": "ml.c4.2xlarge" }, { "name": "MlC44xlarge", "description": "InstanceType enum ml.c4.4xlarge", "value": "ml.c4.4xlarge" }, { "name": "MlC48xlarge", "description": "InstanceType enum ml.c4.8xlarge", "value": "ml.c4.8xlarge" }, { "name": "MlC4Xlarge", "description": "InstanceType enum ml.c4.xlarge", "value": "ml.c4.xlarge" }, { "name": "MlC518xlarge", "description": "InstanceType enum ml.c5.18xlarge", "value": "ml.c5.18xlarge" }, { "name": "MlC52xlarge", "description": "InstanceType enum ml.c5.2xlarge", "value": "ml.c5.2xlarge" }, { "name": "MlC54xlarge", "description": "InstanceType enum ml.c5.4xlarge", "value": "ml.c5.4xlarge" }, { "name": "MlC59xlarge", "description": "InstanceType enum ml.c5.9xlarge", "value": "ml.c5.9xlarge" }, { "name": "MlC5Xlarge", "description": "InstanceType enum ml.c5.xlarge", "value": "ml.c5.xlarge" }, { "name": "MlC5d18xlarge", "description": "InstanceType enum ml.c5d.18xlarge", "value": "ml.c5d.18xlarge" }, { "name": "MlC5d2xlarge", "description": "InstanceType enum ml.c5d.2xlarge", "value": "ml.c5d.2xlarge" }, { "name": "MlC5d4xlarge", "description": "InstanceType enum ml.c5d.4xlarge", "value": "ml.c5d.4xlarge" }, { "name": "MlC5d9xlarge", "description": "InstanceType enum ml.c5d.9xlarge", "value": "ml.c5d.9xlarge" }, { "name": "MlC5dXlarge", "description": "InstanceType enum ml.c5d.xlarge", "value": "ml.c5d.xlarge" }, { "name": "MlC6i12xlarge", "description": "InstanceType enum ml.c6i.12xlarge", "value": "ml.c6i.12xlarge" }, { "name": "MlC6i16xlarge", "description": "InstanceType enum ml.c6i.16xlarge", "value": "ml.c6i.16xlarge" }, { "name": "MlC6i24xlarge", "description": "InstanceType enum ml.c6i.24xlarge", "value": "ml.c6i.24xlarge" }, { "name": "MlC6i2xlarge", "description": "InstanceType enum ml.c6i.2xlarge", "value": "ml.c6i.2xlarge" }, { "name": "MlC6i32xlarge", "description": "InstanceType enum ml.c6i.32xlarge", "value": "ml.c6i.32xlarge" }, { "name": "MlC6i4xlarge", "description": "InstanceType enum ml.c6i.4xlarge", "value": "ml.c6i.4xlarge" }, { "name": "MlC6i8xlarge", "description": "InstanceType enum ml.c6i.8xlarge", "value": "ml.c6i.8xlarge" }, { "name": "MlC6iLarge", "description": "InstanceType enum ml.c6i.large", "value": "ml.c6i.large" }, { "name": "MlC6iXlarge", "description": "InstanceType enum ml.c6i.xlarge", "value": "ml.c6i.xlarge" }, { "name": "MlC6id12xlarge", "description": "InstanceType enum ml.c6id.12xlarge", "value": "ml.c6id.12xlarge" }, { "name": "MlC6id16xlarge", "description": "InstanceType enum ml.c6id.16xlarge", "value": "ml.c6id.16xlarge" }, { "name": "MlC6id24xlarge", "description": "InstanceType enum ml.c6id.24xlarge", "value": "ml.c6id.24xlarge" }, { "name": "MlC6id2xlarge", "description": "InstanceType enum ml.c6id.2xlarge", "value": "ml.c6id.2xlarge" }, { "name": "MlC6id32xlarge", "description": "InstanceType enum ml.c6id.32xlarge", "value": "ml.c6id.32xlarge" }, { "name": "MlC6id4xlarge", "description": "InstanceType enum ml.c6id.4xlarge", "value": "ml.c6id.4xlarge" }, { "name": "MlC6id8xlarge", "description": "InstanceType enum ml.c6id.8xlarge", "value": "ml.c6id.8xlarge" }, { "name": "MlC6idLarge", "description": "InstanceType enum ml.c6id.large", "value": "ml.c6id.large" }, { "name": "MlC6idXlarge", "description": "InstanceType enum ml.c6id.xlarge", "value": "ml.c6id.xlarge" }, { "name": "MlC7i12xlarge", "description": "InstanceType enum ml.c7i.12xlarge", "value": "ml.c7i.12xlarge" }, { "name": "MlC7i16xlarge", "description": "InstanceType enum ml.c7i.16xlarge", "value": "ml.c7i.16xlarge" }, { "name": "MlC7i24xlarge", "description": "InstanceType enum ml.c7i.24xlarge", "value": "ml.c7i.24xlarge" }, { "name": "MlC7i2xlarge", "description": "InstanceType enum ml.c7i.2xlarge", "value": "ml.c7i.2xlarge" }, { "name": "MlC7i48xlarge", "description": "InstanceType enum ml.c7i.48xlarge", "value": "ml.c7i.48xlarge" }, { "name": "MlC7i4xlarge", "description": "InstanceType enum ml.c7i.4xlarge", "value": "ml.c7i.4xlarge" }, { "name": "MlC7i8xlarge", "description": "InstanceType enum ml.c7i.8xlarge", "value": "ml.c7i.8xlarge" }, { "name": "MlC7iLarge", "description": "InstanceType enum ml.c7i.large", "value": "ml.c7i.large" }, { "name": "MlC7iXlarge", "description": "InstanceType enum ml.c7i.xlarge", "value": "ml.c7i.xlarge" }, { "name": "MlG4dn12xlarge", "description": "InstanceType enum ml.g4dn.12xlarge", "value": "ml.g4dn.12xlarge" }, { "name": "MlG4dn16xlarge", "description": "InstanceType enum ml.g4dn.16xlarge", "value": "ml.g4dn.16xlarge" }, { "name": "MlG4dn2xlarge", "description": "InstanceType enum ml.g4dn.2xlarge", "value": "ml.g4dn.2xlarge" }, { "name": "MlG4dn4xlarge", "description": "InstanceType enum ml.g4dn.4xlarge", "value": "ml.g4dn.4xlarge" }, { "name": "MlG4dn8xlarge", "description": "InstanceType enum ml.g4dn.8xlarge", "value": "ml.g4dn.8xlarge" }, { "name": "MlG4dnXlarge", "description": "InstanceType enum ml.g4dn.xlarge", "value": "ml.g4dn.xlarge" }, { "name": "MlG512xlarge", "description": "InstanceType enum ml.g5.12xlarge", "value": "ml.g5.12xlarge" }, { "name": "MlG516xlarge", "description": "InstanceType enum ml.g5.16xlarge", "value": "ml.g5.16xlarge" }, { "name": "MlG524xlarge", "description": "InstanceType enum ml.g5.24xlarge", "value": "ml.g5.24xlarge" }, { "name": "MlG52xlarge", "description": "InstanceType enum ml.g5.2xlarge", "value": "ml.g5.2xlarge" }, { "name": "MlG548xlarge", "description": "InstanceType enum ml.g5.48xlarge", "value": "ml.g5.48xlarge" }, { "name": "MlG54xlarge", "description": "InstanceType enum ml.g5.4xlarge", "value": "ml.g5.4xlarge" }, { "name": "MlG58xlarge", "description": "InstanceType enum ml.g5.8xlarge", "value": "ml.g5.8xlarge" }, { "name": "MlG5Xlarge", "description": "InstanceType enum ml.g5.xlarge", "value": "ml.g5.xlarge" }, { "name": "MlInf124xlarge", "description": "InstanceType enum ml.inf1.24xlarge", "value": "ml.inf1.24xlarge" }, { "name": "MlInf12xlarge", "description": "InstanceType enum ml.inf1.2xlarge", "value": "ml.inf1.2xlarge" }, { "name": "MlInf16xlarge", "description": "InstanceType enum ml.inf1.6xlarge", "value": "ml.inf1.6xlarge" }, { "name": "MlInf1Xlarge", "description": "InstanceType enum ml.inf1.xlarge", "value": "ml.inf1.xlarge" }, { "name": "MlM410xlarge", "description": "InstanceType enum ml.m4.10xlarge", "value": "ml.m4.10xlarge" }, { "name": "MlM416xlarge", "description": "InstanceType enum ml.m4.16xlarge", "value": "ml.m4.16xlarge" }, { "name": "MlM42xlarge", "description": "InstanceType enum ml.m4.2xlarge", "value": "ml.m4.2xlarge" }, { "name": "MlM44xlarge", "description": "InstanceType enum ml.m4.4xlarge", "value": "ml.m4.4xlarge" }, { "name": "MlM4Xlarge", "description": "InstanceType enum ml.m4.xlarge", "value": "ml.m4.xlarge" }, { "name": "MlM512xlarge", "description": "InstanceType enum ml.m5.12xlarge", "value": "ml.m5.12xlarge" }, { "name": "MlM524xlarge", "description": "InstanceType enum ml.m5.24xlarge", "value": "ml.m5.24xlarge" }, { "name": "MlM52xlarge", "description": "InstanceType enum ml.m5.2xlarge", "value": "ml.m5.2xlarge" }, { "name": "MlM54xlarge", "description": "InstanceType enum ml.m5.4xlarge", "value": "ml.m5.4xlarge" }, { "name": "MlM5Xlarge", "description": "InstanceType enum ml.m5.xlarge", "value": "ml.m5.xlarge" }, { "name": "MlM5d12xlarge", "description": "InstanceType enum ml.m5d.12xlarge", "value": "ml.m5d.12xlarge" }, { "name": "MlM5d16xlarge", "description": "InstanceType enum ml.m5d.16xlarge", "value": "ml.m5d.16xlarge" }, { "name": "MlM5d24xlarge", "description": "InstanceType enum ml.m5d.24xlarge", "value": "ml.m5d.24xlarge" }, { "name": "MlM5d2xlarge", "description": "InstanceType enum ml.m5d.2xlarge", "value": "ml.m5d.2xlarge" }, { "name": "MlM5d4xlarge", "description": "InstanceType enum ml.m5d.4xlarge", "value": "ml.m5d.4xlarge" }, { "name": "MlM5d8xlarge", "description": "InstanceType enum ml.m5d.8xlarge", "value": "ml.m5d.8xlarge" }, { "name": "MlM5dLarge", "description": "InstanceType enum ml.m5d.large", "value": "ml.m5d.large" }, { "name": "MlM5dXlarge", "description": "InstanceType enum ml.m5d.xlarge", "value": "ml.m5d.xlarge" }, { "name": "MlM6i12xlarge", "description": "InstanceType enum ml.m6i.12xlarge", "value": "ml.m6i.12xlarge" }, { "name": "MlM6i16xlarge", "description": "InstanceType enum ml.m6i.16xlarge", "value": "ml.m6i.16xlarge" }, { "name": "MlM6i24xlarge", "description": "InstanceType enum ml.m6i.24xlarge", "value": "ml.m6i.24xlarge" }, { "name": "MlM6i2xlarge", "description": "InstanceType enum ml.m6i.2xlarge", "value": "ml.m6i.2xlarge" }, { "name": "MlM6i32xlarge", "description": "InstanceType enum ml.m6i.32xlarge", "value": "ml.m6i.32xlarge" }, { "name": "MlM6i4xlarge", "description": "InstanceType enum ml.m6i.4xlarge", "value": "ml.m6i.4xlarge" }, { "name": "MlM6i8xlarge", "description": "InstanceType enum ml.m6i.8xlarge", "value": "ml.m6i.8xlarge" }, { "name": "MlM6iLarge", "description": "InstanceType enum ml.m6i.large", "value": "ml.m6i.large" }, { "name": "MlM6iXlarge", "description": "InstanceType enum ml.m6i.xlarge", "value": "ml.m6i.xlarge" }, { "name": "MlM6id12xlarge", "description": "InstanceType enum ml.m6id.12xlarge", "value": "ml.m6id.12xlarge" }, { "name": "MlM6id16xlarge", "description": "InstanceType enum ml.m6id.16xlarge", "value": "ml.m6id.16xlarge" }, { "name": "MlM6id24xlarge", "description": "InstanceType enum ml.m6id.24xlarge", "value": "ml.m6id.24xlarge" }, { "name": "MlM6id2xlarge", "description": "InstanceType enum ml.m6id.2xlarge", "value": "ml.m6id.2xlarge" }, { "name": "MlM6id32xlarge", "description": "InstanceType enum ml.m6id.32xlarge", "value": "ml.m6id.32xlarge" }, { "name": "MlM6id4xlarge", "description": "InstanceType enum ml.m6id.4xlarge", "value": "ml.m6id.4xlarge" }, { "name": "MlM6id8xlarge", "description": "InstanceType enum ml.m6id.8xlarge", "value": "ml.m6id.8xlarge" }, { "name": "MlM6idLarge", "description": "InstanceType enum ml.m6id.large", "value": "ml.m6id.large" }, { "name": "MlM6idXlarge", "description": "InstanceType enum ml.m6id.xlarge", "value": "ml.m6id.xlarge" }, { "name": "MlM7i12xlarge", "description": "InstanceType enum ml.m7i.12xlarge", "value": "ml.m7i.12xlarge" }, { "name": "MlM7i16xlarge", "description": "InstanceType enum ml.m7i.16xlarge", "value": "ml.m7i.16xlarge" }, { "name": "MlM7i24xlarge", "description": "InstanceType enum ml.m7i.24xlarge", "value": "ml.m7i.24xlarge" }, { "name": "MlM7i2xlarge", "description": "InstanceType enum ml.m7i.2xlarge", "value": "ml.m7i.2xlarge" }, { "name": "MlM7i48xlarge", "description": "InstanceType enum ml.m7i.48xlarge", "value": "ml.m7i.48xlarge" }, { "name": "MlM7i4xlarge", "description": "InstanceType enum ml.m7i.4xlarge", "value": "ml.m7i.4xlarge" }, { "name": "MlM7i8xlarge", "description": "InstanceType enum ml.m7i.8xlarge", "value": "ml.m7i.8xlarge" }, { "name": "MlM7iLarge", "description": "InstanceType enum ml.m7i.large", "value": "ml.m7i.large" }, { "name": "MlM7iXlarge", "description": "InstanceType enum ml.m7i.xlarge", "value": "ml.m7i.xlarge" }, { "name": "MlP216xlarge", "description": "InstanceType enum ml.p2.16xlarge", "value": "ml.p2.16xlarge" }, { "name": "MlP28xlarge", "description": "InstanceType enum ml.p2.8xlarge", "value": "ml.p2.8xlarge" }, { "name": "MlP2Xlarge", "description": "InstanceType enum ml.p2.xlarge", "value": "ml.p2.xlarge" }, { "name": "MlP316xlarge", "description": "InstanceType enum ml.p3.16xlarge", "value": "ml.p3.16xlarge" }, { "name": "MlP32xlarge", "description": "InstanceType enum ml.p3.2xlarge", "value": "ml.p3.2xlarge" }, { "name": "MlP38xlarge", "description": "InstanceType enum ml.p3.8xlarge", "value": "ml.p3.8xlarge" }, { "name": "MlP3dn24xlarge", "description": "InstanceType enum ml.p3dn.24xlarge", "value": "ml.p3dn.24xlarge" }, { "name": "MlP4d24xlarge", "description": "InstanceType enum ml.p4d.24xlarge", "value": "ml.p4d.24xlarge" }, { "name": "MlP4de24xlarge", "description": "InstanceType enum ml.p4de.24xlarge", "value": "ml.p4de.24xlarge" }, { "name": "MlP548xlarge", "description": "InstanceType enum ml.p5.48xlarge", "value": "ml.p5.48xlarge" }, { "name": "MlR512xlarge", "description": "InstanceType enum ml.r5.12xlarge", "value": "ml.r5.12xlarge" }, { "name": "MlR516xlarge", "description": "InstanceType enum ml.r5.16xlarge", "value": "ml.r5.16xlarge" }, { "name": "MlR524xlarge", "description": "InstanceType enum ml.r5.24xlarge", "value": "ml.r5.24xlarge" }, { "name": "MlR52xlarge", "description": "InstanceType enum ml.r5.2xlarge", "value": "ml.r5.2xlarge" }, { "name": "MlR54xlarge", "description": "InstanceType enum ml.r5.4xlarge", "value": "ml.r5.4xlarge" }, { "name": "MlR58xlarge", "description": "InstanceType enum ml.r5.8xlarge", "value": "ml.r5.8xlarge" }, { "name": "MlR5Large", "description": "InstanceType enum ml.r5.large", "value": "ml.r5.large" }, { "name": "MlR5Xlarge", "description": "InstanceType enum ml.r5.xlarge", "value": "ml.r5.xlarge" }, { "name": "MlR6i12xlarge", "description": "InstanceType enum ml.r6i.12xlarge", "value": "ml.r6i.12xlarge" }, { "name": "MlR6i16xlarge", "description": "InstanceType enum ml.r6i.16xlarge", "value": "ml.r6i.16xlarge" }, { "name": "MlR6i24xlarge", "description": "InstanceType enum ml.r6i.24xlarge", "value": "ml.r6i.24xlarge" }, { "name": "MlR6i2xlarge", "description": "InstanceType enum ml.r6i.2xlarge", "value": "ml.r6i.2xlarge" }, { "name": "MlR6i32xlarge", "description": "InstanceType enum ml.r6i.32xlarge", "value": "ml.r6i.32xlarge" }, { "name": "MlR6i4xlarge", "description": "InstanceType enum ml.r6i.4xlarge", "value": "ml.r6i.4xlarge" }, { "name": "MlR6i8xlarge", "description": "InstanceType enum ml.r6i.8xlarge", "value": "ml.r6i.8xlarge" }, { "name": "MlR6iLarge", "description": "InstanceType enum ml.r6i.large", "value": "ml.r6i.large" }, { "name": "MlR6iXlarge", "description": "InstanceType enum ml.r6i.xlarge", "value": "ml.r6i.xlarge" }, { "name": "MlR6id12xlarge", "description": "InstanceType enum ml.r6id.12xlarge", "value": "ml.r6id.12xlarge" }, { "name": "MlR6id16xlarge", "description": "InstanceType enum ml.r6id.16xlarge", "value": "ml.r6id.16xlarge" }, { "name": "MlR6id24xlarge", "description": "InstanceType enum ml.r6id.24xlarge", "value": "ml.r6id.24xlarge" }, { "name": "MlR6id2xlarge", "description": "InstanceType enum ml.r6id.2xlarge", "value": "ml.r6id.2xlarge" }, { "name": "MlR6id32xlarge", "description": "InstanceType enum ml.r6id.32xlarge", "value": "ml.r6id.32xlarge" }, { "name": "MlR6id4xlarge", "description": "InstanceType enum ml.r6id.4xlarge", "value": "ml.r6id.4xlarge" }, { "name": "MlR6id8xlarge", "description": "InstanceType enum ml.r6id.8xlarge", "value": "ml.r6id.8xlarge" }, { "name": "MlR6idLarge", "description": "InstanceType enum ml.r6id.large", "value": "ml.r6id.large" }, { "name": "MlR6idXlarge", "description": "InstanceType enum ml.r6id.xlarge", "value": "ml.r6id.xlarge" }, { "name": "MlR7i12xlarge", "description": "InstanceType enum ml.r7i.12xlarge", "value": "ml.r7i.12xlarge" }, { "name": "MlR7i16xlarge", "description": "InstanceType enum ml.r7i.16xlarge", "value": "ml.r7i.16xlarge" }, { "name": "MlR7i24xlarge", "description": "InstanceType enum ml.r7i.24xlarge", "value": "ml.r7i.24xlarge" }, { "name": "MlR7i2xlarge", "description": "InstanceType enum ml.r7i.2xlarge", "value": "ml.r7i.2xlarge" }, { "name": "MlR7i48xlarge", "description": "InstanceType enum ml.r7i.48xlarge", "value": "ml.r7i.48xlarge" }, { "name": "MlR7i4xlarge", "description": "InstanceType enum ml.r7i.4xlarge", "value": "ml.r7i.4xlarge" }, { "name": "MlR7i8xlarge", "description": "InstanceType enum ml.r7i.8xlarge", "value": "ml.r7i.8xlarge" }, { "name": "MlR7iLarge", "description": "InstanceType enum ml.r7i.large", "value": "ml.r7i.large" }, { "name": "MlR7iXlarge", "description": "InstanceType enum ml.r7i.xlarge", "value": "ml.r7i.xlarge" }, { "name": "MlT22xlarge", "description": "InstanceType enum ml.t2.2xlarge", "value": "ml.t2.2xlarge" }, { "name": "MlT2Large", "description": "InstanceType enum ml.t2.large", "value": "ml.t2.large" }, { "name": "MlT2Medium", "description": "InstanceType enum ml.t2.medium", "value": "ml.t2.medium" }, { "name": "MlT2Xlarge", "description": "InstanceType enum ml.t2.xlarge", "value": "ml.t2.xlarge" }, { "name": "MlT32xlarge", "description": "InstanceType enum ml.t3.2xlarge", "value": "ml.t3.2xlarge" }, { "name": "MlT3Large", "description": "InstanceType enum ml.t3.large", "value": "ml.t3.large" }, { "name": "MlT3Medium", "description": "InstanceType enum ml.t3.medium", "value": "ml.t3.medium" }, { "name": "MlT3Xlarge", "description": "InstanceType enum ml.t3.xlarge", "value": "ml.t3.xlarge" } ] }, "azure-native:awsconnector:InstanceTypeEnumValue": { "description": "Definition of InstanceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InstanceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstanceTypeEnumValueResponse": { "description": "Definition of InstanceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:InstancesDistribution": { "description": "Definition of InstancesDistribution", "properties": { "onDemandAllocationStrategy": { "type": "string", "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do." }, "onDemandBaseCapacity": { "type": "integer", "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. Default: 0 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. Default: 100 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." }, "spotAllocationStrategy": { "type": "string", "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price." }, "spotInstancePools": { "type": "integer", "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. Default: 2" }, "spotMaxPrice": { "type": "string", "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ('') for the value. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. Valid Range: Minimum value of 0.001" } }, "type": "object" }, "azure-native:awsconnector:InstancesDistributionResponse": { "description": "Definition of InstancesDistribution", "properties": { "onDemandAllocationStrategy": { "type": "string", "description": "The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do." }, "onDemandBaseCapacity": { "type": "integer", "description": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. Default: 0 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." }, "onDemandPercentageAboveBaseCapacity": { "type": "integer", "description": "Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. Default: 100 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones." }, "spotAllocationStrategy": { "type": "string", "description": "The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price." }, "spotInstancePools": { "type": "integer", "description": "The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. Default: 2" }, "spotMaxPrice": { "type": "string", "description": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ('') for the value. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. Valid Range: Minimum value of 0.001" } }, "type": "object" }, "azure-native:awsconnector:IntelligentTieringConfiguration": { "description": "Definition of IntelligentTieringConfiguration", "properties": { "id": { "type": "string", "description": "The ID used to identify the S3 Intelligent-Tiering configuration." }, "prefix": { "type": "string", "description": "An object key name prefix that identifies the subset of objects to which the rule applies." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:IntelligentTieringConfigurationStatus" } ], "description": "Specifies the status of the configuration." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilter" }, "description": "A container for a key-value pair." }, "tierings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tiering" }, "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``. You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers." } }, "type": "object" }, "azure-native:awsconnector:IntelligentTieringConfigurationResponse": { "description": "Definition of IntelligentTieringConfiguration", "properties": { "id": { "type": "string", "description": "The ID used to identify the S3 Intelligent-Tiering configuration." }, "prefix": { "type": "string", "description": "An object key name prefix that identifies the subset of objects to which the rule applies." }, "status": { "type": "string", "description": "Specifies the status of the configuration." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilterResponse" }, "description": "A container for a key-value pair." }, "tierings": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TieringResponse" }, "description": "Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``. You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers." } }, "type": "object" }, "azure-native:awsconnector:IntelligentTieringConfigurationStatus": { "description": "Specifies the status of the configuration.", "type": "string", "enum": [ { "name": "Disabled", "description": "IntelligentTieringConfigurationStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "IntelligentTieringConfigurationStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:InventoryConfiguration": { "description": "Definition of InventoryConfiguration", "properties": { "destination": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Destination", "description": "Contains information about where to publish the inventory results. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket." }, "enabled": { "type": "boolean", "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated." }, "id": { "type": "string", "description": "The ID used to identify the inventory configuration." }, "includedObjectVersions": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InventoryConfigurationIncludedObjectVersions" } ], "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields." }, "optionalFields": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InventoryConfigurationOptionalFields" } ] }, "description": "Contains the optional fields that are included in the inventory results." }, "prefix": { "type": "string", "description": "Specifies the inventory filter prefix." }, "scheduleFrequency": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:InventoryConfigurationScheduleFrequency" } ], "description": "Specifies the schedule for generating inventory results." } }, "type": "object" }, "azure-native:awsconnector:InventoryConfigurationIncludedObjectVersions": { "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields.", "type": "string", "enum": [ { "name": "All", "description": "InventoryConfigurationIncludedObjectVersions enum All", "value": "All" }, { "name": "Current", "description": "InventoryConfigurationIncludedObjectVersions enum Current", "value": "Current" } ] }, "azure-native:awsconnector:InventoryConfigurationOptionalFields": { "description": "InventoryConfigurationOptionalFields enum", "type": "string", "enum": [ { "name": "BucketKeyStatus", "description": "InventoryConfigurationOptionalFields enum BucketKeyStatus", "value": "BucketKeyStatus" }, { "name": "ChecksumAlgorithm", "description": "InventoryConfigurationOptionalFields enum ChecksumAlgorithm", "value": "ChecksumAlgorithm" }, { "name": "ETag", "description": "InventoryConfigurationOptionalFields enum ETag", "value": "ETag" }, { "name": "EncryptionStatus", "description": "InventoryConfigurationOptionalFields enum EncryptionStatus", "value": "EncryptionStatus" }, { "name": "IntelligentTieringAccessTier", "description": "InventoryConfigurationOptionalFields enum IntelligentTieringAccessTier", "value": "IntelligentTieringAccessTier" }, { "name": "IsMultipartUploaded", "description": "InventoryConfigurationOptionalFields enum IsMultipartUploaded", "value": "IsMultipartUploaded" }, { "name": "LastModifiedDate", "description": "InventoryConfigurationOptionalFields enum LastModifiedDate", "value": "LastModifiedDate" }, { "name": "ObjectAccessControlList", "description": "InventoryConfigurationOptionalFields enum ObjectAccessControlList", "value": "ObjectAccessControlList" }, { "name": "ObjectLockLegalHoldStatus", "description": "InventoryConfigurationOptionalFields enum ObjectLockLegalHoldStatus", "value": "ObjectLockLegalHoldStatus" }, { "name": "ObjectLockMode", "description": "InventoryConfigurationOptionalFields enum ObjectLockMode", "value": "ObjectLockMode" }, { "name": "ObjectLockRetainUntilDate", "description": "InventoryConfigurationOptionalFields enum ObjectLockRetainUntilDate", "value": "ObjectLockRetainUntilDate" }, { "name": "ObjectOwner", "description": "InventoryConfigurationOptionalFields enum ObjectOwner", "value": "ObjectOwner" }, { "name": "ReplicationStatus", "description": "InventoryConfigurationOptionalFields enum ReplicationStatus", "value": "ReplicationStatus" }, { "name": "Size", "description": "InventoryConfigurationOptionalFields enum Size", "value": "Size" }, { "name": "StorageClass", "description": "InventoryConfigurationOptionalFields enum StorageClass", "value": "StorageClass" } ] }, "azure-native:awsconnector:InventoryConfigurationResponse": { "description": "Definition of InventoryConfiguration", "properties": { "destination": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DestinationResponse", "description": "Contains information about where to publish the inventory results. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket." }, "enabled": { "type": "boolean", "description": "Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated." }, "id": { "type": "string", "description": "The ID used to identify the inventory configuration." }, "includedObjectVersions": { "type": "string", "description": "Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields." }, "optionalFields": { "type": "array", "items": { "type": "string" }, "description": "Contains the optional fields that are included in the inventory results." }, "prefix": { "type": "string", "description": "Specifies the inventory filter prefix." }, "scheduleFrequency": { "type": "string", "description": "Specifies the schedule for generating inventory results." } }, "type": "object" }, "azure-native:awsconnector:InventoryConfigurationScheduleFrequency": { "description": "Specifies the schedule for generating inventory results.", "type": "string", "enum": [ { "name": "Daily", "description": "InventoryConfigurationScheduleFrequency enum Daily", "value": "Daily" }, { "name": "Weekly", "description": "InventoryConfigurationScheduleFrequency enum Weekly", "value": "Weekly" } ] }, "azure-native:awsconnector:IpFamily": { "description": "Property value", "type": "string", "enum": [ { "name": "Ipv4", "description": "IpFamily enum ipv4", "value": "ipv4" }, { "name": "Ipv6", "description": "IpFamily enum ipv6", "value": "ipv6" } ] }, "azure-native:awsconnector:IpFamilyEnumValue": { "description": "Definition of IpFamilyEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:IpFamily" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IpFamilyEnumValueResponse": { "description": "Definition of IpFamilyEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IpPermission": { "description": "Definition of IpPermission", "properties": { "fromPort": { "type": "integer", "description": "\u003cp\u003eIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).\u003c/p\u003e" }, "ipProtocol": { "type": "string", "description": "\u003cp\u003eThe IP protocol name (\u003ccode\u003etcp\u003c/code\u003e, \u003ccode\u003eudp\u003c/code\u003e, \u003ccode\u003eicmp\u003c/code\u003e, \u003ccode\u003eicmpv6\u003c/code\u003e) or number (see \u003ca href='http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml'\u003eProtocol Numbers\u003c/a\u003e).\u003c/p\u003e \u003cp\u003eUse \u003ccode\u003e-1\u003c/code\u003e to specify all protocols. When authorizing security group rules, specifying \u003ccode\u003e-1\u003c/code\u003e or a protocol number other than \u003ccode\u003etcp\u003c/code\u003e, \u003ccode\u003eudp\u003c/code\u003e, \u003ccode\u003eicmp\u003c/code\u003e, or \u003ccode\u003eicmpv6\u003c/code\u003e allows traffic on all ports, regardless of any port range you specify. For \u003ccode\u003etcp\u003c/code\u003e, \u003ccode\u003eudp\u003c/code\u003e, and \u003ccode\u003eicmp\u003c/code\u003e, you must specify a port range. For \u003ccode\u003eicmpv6\u003c/code\u003e, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.\u003c/p\u003e" }, "ipRanges": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpRange" }, "description": "\u003cp\u003eThe IPv4 address ranges.\u003c/p\u003e" }, "ipv6Ranges": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ipv6Range" }, "description": "\u003cp\u003eThe IPv6 address ranges.\u003c/p\u003e" }, "prefixListIds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrefixListId" }, "description": "\u003cp\u003eThe prefix list IDs.\u003c/p\u003e" }, "toPort": { "type": "integer", "description": "\u003cp\u003eIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).\u003c/p\u003e" }, "userIdGroupPairs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UserIdGroupPair" }, "description": "\u003cp\u003eThe security group and Amazon Web Services account ID pairs.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IpPermissionResponse": { "description": "Definition of IpPermission", "properties": { "fromPort": { "type": "integer", "description": "\u003cp\u003eIf the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).\u003c/p\u003e" }, "ipProtocol": { "type": "string", "description": "\u003cp\u003eThe IP protocol name (\u003ccode\u003etcp\u003c/code\u003e, \u003ccode\u003eudp\u003c/code\u003e, \u003ccode\u003eicmp\u003c/code\u003e, \u003ccode\u003eicmpv6\u003c/code\u003e) or number (see \u003ca href='http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml'\u003eProtocol Numbers\u003c/a\u003e).\u003c/p\u003e \u003cp\u003eUse \u003ccode\u003e-1\u003c/code\u003e to specify all protocols. When authorizing security group rules, specifying \u003ccode\u003e-1\u003c/code\u003e or a protocol number other than \u003ccode\u003etcp\u003c/code\u003e, \u003ccode\u003eudp\u003c/code\u003e, \u003ccode\u003eicmp\u003c/code\u003e, or \u003ccode\u003eicmpv6\u003c/code\u003e allows traffic on all ports, regardless of any port range you specify. For \u003ccode\u003etcp\u003c/code\u003e, \u003ccode\u003eudp\u003c/code\u003e, and \u003ccode\u003eicmp\u003c/code\u003e, you must specify a port range. For \u003ccode\u003eicmpv6\u003c/code\u003e, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.\u003c/p\u003e" }, "ipRanges": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpRangeResponse" }, "description": "\u003cp\u003eThe IPv4 address ranges.\u003c/p\u003e" }, "ipv6Ranges": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Ipv6RangeResponse" }, "description": "\u003cp\u003eThe IPv6 address ranges.\u003c/p\u003e" }, "prefixListIds": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PrefixListIdResponse" }, "description": "\u003cp\u003eThe prefix list IDs.\u003c/p\u003e" }, "toPort": { "type": "integer", "description": "\u003cp\u003eIf the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).\u003c/p\u003e" }, "userIdGroupPairs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:UserIdGroupPairResponse" }, "description": "\u003cp\u003eThe security group and Amazon Web Services account ID pairs.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IpRange": { "description": "Definition of IpRange", "properties": { "cidrIp": { "type": "string", "description": "\u003cp\u003eThe IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description for the security group rule that references this IPv4 address range.\u003c/p\u003e \u003cp\u003eConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$*\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IpRangeResponse": { "description": "Definition of IpRange", "properties": { "cidrIp": { "type": "string", "description": "\u003cp\u003eThe IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description for the security group rule that references this IPv4 address range.\u003c/p\u003e \u003cp\u003eConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$*\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IpamOperatingRegion": { "description": "Definition of IpamOperatingRegion", "properties": { "regionName": { "type": "string", "description": "\u003cp\u003eThe name of the operating Region.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IpamOperatingRegionResponse": { "description": "Definition of IpamOperatingRegion", "properties": { "regionName": { "type": "string", "description": "\u003cp\u003eThe name of the operating Region.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:IpamState": { "description": "Property value", "type": "string", "enum": [ { "name": "CreateComplete", "description": "IpamState enum create-complete", "value": "create-complete" }, { "name": "CreateFailed", "description": "IpamState enum create-failed", "value": "create-failed" }, { "name": "CreateInProgress", "description": "IpamState enum create-in-progress", "value": "create-in-progress" }, { "name": "DeleteComplete", "description": "IpamState enum delete-complete", "value": "delete-complete" }, { "name": "DeleteFailed", "description": "IpamState enum delete-failed", "value": "delete-failed" }, { "name": "DeleteInProgress", "description": "IpamState enum delete-in-progress", "value": "delete-in-progress" }, { "name": "IsolateComplete", "description": "IpamState enum isolate-complete", "value": "isolate-complete" }, { "name": "IsolateInProgress", "description": "IpamState enum isolate-in-progress", "value": "isolate-in-progress" }, { "name": "ModifyComplete", "description": "IpamState enum modify-complete", "value": "modify-complete" }, { "name": "ModifyFailed", "description": "IpamState enum modify-failed", "value": "modify-failed" }, { "name": "ModifyInProgress", "description": "IpamState enum modify-in-progress", "value": "modify-in-progress" }, { "name": "RestoreInProgress", "description": "IpamState enum restore-in-progress", "value": "restore-in-progress" } ] }, "azure-native:awsconnector:IpamStateEnumValue": { "description": "Definition of IpamStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:IpamState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IpamStateEnumValueResponse": { "description": "Definition of IpamStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IpamTier": { "description": "Property value", "type": "string", "enum": [ { "name": "Advanced", "description": "IpamTier enum advanced", "value": "advanced" }, { "name": "Free", "description": "IpamTier enum free", "value": "free" } ] }, "azure-native:awsconnector:IpamTierEnumValue": { "description": "Definition of IpamTierEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:IpamTier" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:IpamTierEnumValueResponse": { "description": "Definition of IpamTierEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Ipv4PrefixSpecification": { "description": "Definition of Ipv4PrefixSpecification", "properties": { "ipv4Prefix": { "type": "string", "description": "Property ipv4Prefix" } }, "type": "object" }, "azure-native:awsconnector:Ipv4PrefixSpecificationResponse": { "description": "Definition of Ipv4PrefixSpecification", "properties": { "ipv4Prefix": { "type": "string", "description": "Property ipv4Prefix" } }, "type": "object" }, "azure-native:awsconnector:Ipv6PrefixSpecification": { "description": "Definition of Ipv6PrefixSpecification", "properties": { "ipv6Prefix": { "type": "string", "description": "Property ipv6Prefix" } }, "type": "object" }, "azure-native:awsconnector:Ipv6PrefixSpecificationResponse": { "description": "Definition of Ipv6PrefixSpecification", "properties": { "ipv6Prefix": { "type": "string", "description": "Property ipv6Prefix" } }, "type": "object" }, "azure-native:awsconnector:Ipv6Range": { "description": "Definition of Ipv6Range", "properties": { "cidrIpv6": { "type": "string", "description": "\u003cp\u003eThe IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description for the security group rule that references this IPv6 address range.\u003c/p\u003e \u003cp\u003eConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$*\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Ipv6RangeResponse": { "description": "Definition of Ipv6Range", "properties": { "cidrIpv6": { "type": "string", "description": "\u003cp\u003eThe IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description for the security group rule that references this IPv6 address range.\u003c/p\u003e \u003cp\u003eConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=\u0026amp;;{}!$*\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:JobComparator": { "description": "Property value", "type": "string", "enum": [ { "name": "CONTAINS", "description": "JobComparator enum CONTAINS", "value": "CONTAINS" }, { "name": "EQ", "description": "JobComparator enum EQ", "value": "EQ" }, { "name": "GT", "description": "JobComparator enum GT", "value": "GT" }, { "name": "GTE", "description": "JobComparator enum GTE", "value": "GTE" }, { "name": "LT", "description": "JobComparator enum LT", "value": "LT" }, { "name": "LTE", "description": "JobComparator enum LTE", "value": "LTE" }, { "name": "NE", "description": "JobComparator enum NE", "value": "NE" }, { "name": "STARTS_WITH", "description": "JobComparator enum STARTS_WITH", "value": "STARTS_WITH" } ] }, "azure-native:awsconnector:JobComparatorEnumValue": { "description": "Definition of JobComparatorEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:JobComparator" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:JobComparatorEnumValueResponse": { "description": "Definition of JobComparatorEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:JobStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "CANCELLED", "description": "JobStatus enum CANCELLED", "value": "CANCELLED" }, { "name": "COMPLETE", "description": "JobStatus enum COMPLETE", "value": "COMPLETE" }, { "name": "IDLE", "description": "JobStatus enum IDLE", "value": "IDLE" }, { "name": "PAUSED", "description": "JobStatus enum PAUSED", "value": "PAUSED" }, { "name": "RUNNING", "description": "JobStatus enum RUNNING", "value": "RUNNING" }, { "name": "USER_PAUSED", "description": "JobStatus enum USER_PAUSED", "value": "USER_PAUSED" } ] }, "azure-native:awsconnector:JobStatusEnumValue": { "description": "Definition of JobStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:JobStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:JobStatusEnumValueResponse": { "description": "Definition of JobStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:JobType": { "description": "Property value", "type": "string", "enum": [ { "name": "ONE_TIME", "description": "JobType enum ONE_TIME", "value": "ONE_TIME" }, { "name": "SCHEDULED", "description": "JobType enum SCHEDULED", "value": "SCHEDULED" } ] }, "azure-native:awsconnector:JobTypeEnumValue": { "description": "Definition of JobTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:JobType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:JobTypeEnumValueResponse": { "description": "Definition of JobTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:JoinedMethod": { "description": "The method by which the account joined the organization.", "type": "string", "enum": [ { "name": "CREATED", "description": "JoinedMethod enum CREATED", "value": "CREATED" }, { "name": "INVITED", "description": "JoinedMethod enum INVITED", "value": "INVITED" } ] }, "azure-native:awsconnector:KerberosAttributes": { "description": "Definition of KerberosAttributes", "properties": { "adDomainJoinPassword": { "type": "string", "description": "\u003cp\u003eThe Active Directory password for \u003ccode\u003eADDomainJoinUser\u003c/code\u003e.\u003c/p\u003e" }, "adDomainJoinUser": { "type": "string", "description": "\u003cp\u003eRequired only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.\u003c/p\u003e" }, "crossRealmTrustPrincipalPassword": { "type": "string", "description": "\u003cp\u003eRequired 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.\u003c/p\u003e" }, "kdcAdminPassword": { "type": "string", "description": "\u003cp\u003eThe 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.\u003c/p\u003e" }, "realm": { "type": "string", "description": "\u003cp\u003eThe name of the Kerberos realm to which all nodes in a cluster belong. For example, \u003ccode\u003eEC2.INTERNAL\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:KerberosAttributesResponse": { "description": "Definition of KerberosAttributes", "properties": { "adDomainJoinPassword": { "type": "string", "description": "\u003cp\u003eThe Active Directory password for \u003ccode\u003eADDomainJoinUser\u003c/code\u003e.\u003c/p\u003e" }, "adDomainJoinUser": { "type": "string", "description": "\u003cp\u003eRequired only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.\u003c/p\u003e" }, "crossRealmTrustPrincipalPassword": { "type": "string", "description": "\u003cp\u003eRequired 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.\u003c/p\u003e" }, "kdcAdminPassword": { "type": "string", "description": "\u003cp\u003eThe 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.\u003c/p\u003e" }, "realm": { "type": "string", "description": "\u003cp\u003eThe name of the Kerberos realm to which all nodes in a cluster belong. For example, \u003ccode\u003eEC2.INTERNAL\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:KernelCapabilities": { "description": "Definition of KernelCapabilities", "properties": { "add": { "type": "array", "items": { "type": "string" }, "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cap-add`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``" }, "drop": { "type": "array", "items": { "type": "string" }, "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cap-drop`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``" } }, "type": "object" }, "azure-native:awsconnector:KernelCapabilitiesResponse": { "description": "Definition of KernelCapabilities", "properties": { "add": { "type": "array", "items": { "type": "string" }, "description": "The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cap-add`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``" }, "drop": { "type": "array", "items": { "type": "string" }, "description": "The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cap-drop`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'``" } }, "type": "object" }, "azure-native:awsconnector:KeyAlgorithm": { "description": "Property value", "type": "string", "enum": [ { "name": "EC_prime256v1", "description": "KeyAlgorithm enum EC_prime256v1", "value": "EC_prime256v1" }, { "name": "EC_secp384r1", "description": "KeyAlgorithm enum EC_secp384r1", "value": "EC_secp384r1" }, { "name": "EC_secp521r1", "description": "KeyAlgorithm enum EC_secp521r1", "value": "EC_secp521r1" }, { "name": "RSA_1024", "description": "KeyAlgorithm enum RSA_1024", "value": "RSA_1024" }, { "name": "RSA_2048", "description": "KeyAlgorithm enum RSA_2048", "value": "RSA_2048" }, { "name": "RSA_3072", "description": "KeyAlgorithm enum RSA_3072", "value": "RSA_3072" }, { "name": "RSA_4096", "description": "KeyAlgorithm enum RSA_4096", "value": "RSA_4096" } ] }, "azure-native:awsconnector:KeyAlgorithmEnumValue": { "description": "Definition of KeyAlgorithmEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KeyAlgorithm" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:KeyAlgorithmEnumValueResponse": { "description": "Definition of KeyAlgorithmEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:KeyFormat": { "description": "The format of the key pair. Default: ``pem``", "type": "string", "enum": [ { "name": "pem", "description": "KeyFormat enum pem", "value": "pem" }, { "name": "ppk", "description": "KeyFormat enum ppk", "value": "ppk" } ] }, "azure-native:awsconnector:KeySchema": { "description": "Definition of KeySchema", "properties": { "attributeName": { "type": "string", "description": "The name of a key attribute." }, "keyType": { "type": "string", "description": "The role that this key attribute will assume: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." } }, "type": "object" }, "azure-native:awsconnector:KeySchemaResponse": { "description": "Definition of KeySchema", "properties": { "attributeName": { "type": "string", "description": "The name of a key attribute." }, "keyType": { "type": "string", "description": "The role that this key attribute will assume: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." } }, "type": "object" }, "azure-native:awsconnector:KeySpec": { "description": "Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [Services that are integrated with](https://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + HMAC keys (symmetric) + ``HMAC_224`` + ``HMAC_256`` + ``HMAC_384`` + ``HMAC_512`` + Asymmetric RSA key pairs + ``RSA_2048`` + ``RSA_3072`` + ``RSA_4096`` + Asymmetric NIST-recommended elliptic curve key pairs + ``ECC_NIST_P256`` (secp256r1) + ``ECC_NIST_P384`` (secp384r1) + ``ECC_NIST_P521`` (secp521r1) + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + SM2 key pairs (China Regions only) + ``SM2``", "type": "string", "enum": [ { "name": "ECC_NIST_P256", "description": "KeySpec enum ECC_NIST_P256", "value": "ECC_NIST_P256" }, { "name": "ECC_NIST_P384", "description": "KeySpec enum ECC_NIST_P384", "value": "ECC_NIST_P384" }, { "name": "ECC_NIST_P521", "description": "KeySpec enum ECC_NIST_P521", "value": "ECC_NIST_P521" }, { "name": "ECC_SECG_P256K1", "description": "KeySpec enum ECC_SECG_P256K1", "value": "ECC_SECG_P256K1" }, { "name": "HMAC_224", "description": "KeySpec enum HMAC_224", "value": "HMAC_224" }, { "name": "HMAC_256", "description": "KeySpec enum HMAC_256", "value": "HMAC_256" }, { "name": "HMAC_384", "description": "KeySpec enum HMAC_384", "value": "HMAC_384" }, { "name": "HMAC_512", "description": "KeySpec enum HMAC_512", "value": "HMAC_512" }, { "name": "RSA_2048", "description": "KeySpec enum RSA_2048", "value": "RSA_2048" }, { "name": "RSA_3072", "description": "KeySpec enum RSA_3072", "value": "RSA_3072" }, { "name": "RSA_4096", "description": "KeySpec enum RSA_4096", "value": "RSA_4096" }, { "name": "SM2", "description": "KeySpec enum SM2", "value": "SM2" }, { "name": "SYMMETRIC_DEFAULT", "description": "KeySpec enum SYMMETRIC_DEFAULT", "value": "SYMMETRIC_DEFAULT" } ] }, "azure-native:awsconnector:KeyType": { "description": "The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. Default: ``rsa``", "type": "string", "enum": [ { "name": "ed25519", "description": "KeyType enum ed25519", "value": "ed25519" }, { "name": "rsa", "description": "KeyType enum rsa", "value": "rsa" } ] }, "azure-native:awsconnector:KeyUsage": { "description": "Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``.", "type": "string", "enum": [ { "name": "ENCRYPT_DECRYPT", "description": "KeyUsage enum ENCRYPT_DECRYPT", "value": "ENCRYPT_DECRYPT" }, { "name": "GENERATE_VERIFY_MAC", "description": "KeyUsage enum GENERATE_VERIFY_MAC", "value": "GENERATE_VERIFY_MAC" }, { "name": "SIGN_VERIFY", "description": "KeyUsage enum SIGN_VERIFY", "value": "SIGN_VERIFY" } ] }, "azure-native:awsconnector:KeyUsageName": { "description": "KeyUsageName enum", "type": "string", "enum": [ { "name": "ANY", "description": "KeyUsageName enum ANY", "value": "ANY" }, { "name": "CERTIFICATE_SIGNING", "description": "KeyUsageName enum CERTIFICATE_SIGNING", "value": "CERTIFICATE_SIGNING" }, { "name": "CRL_SIGNING", "description": "KeyUsageName enum CRL_SIGNING", "value": "CRL_SIGNING" }, { "name": "CUSTOM", "description": "KeyUsageName enum CUSTOM", "value": "CUSTOM" }, { "name": "DATA_ENCIPHERMENT", "description": "KeyUsageName enum DATA_ENCIPHERMENT", "value": "DATA_ENCIPHERMENT" }, { "name": "DECIPHER_ONLY", "description": "KeyUsageName enum DECIPHER_ONLY", "value": "DECIPHER_ONLY" }, { "name": "DIGITAL_SIGNATURE", "description": "KeyUsageName enum DIGITAL_SIGNATURE", "value": "DIGITAL_SIGNATURE" }, { "name": "ENCIPHER_ONLY", "description": "KeyUsageName enum ENCIPHER_ONLY", "value": "ENCIPHER_ONLY" }, { "name": "KEY_AGREEMENT", "description": "KeyUsageName enum KEY_AGREEMENT", "value": "KEY_AGREEMENT" }, { "name": "KEY_ENCIPHERMENT", "description": "KeyUsageName enum KEY_ENCIPHERMENT", "value": "KEY_ENCIPHERMENT" }, { "name": "NON_REPUDIATION", "description": "KeyUsageName enum NON_REPUDIATION", "value": "NON_REPUDIATION" } ] }, "azure-native:awsconnector:KeyValuePair": { "description": "Definition of KeyValuePair", "properties": { "name": { "type": "string", "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable." }, "value": { "type": "string", "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable." } }, "type": "object" }, "azure-native:awsconnector:KeyValuePairResponse": { "description": "Definition of KeyValuePair", "properties": { "name": { "type": "string", "description": "The name of the key-value pair. For environment variables, this is the name of the environment variable." }, "value": { "type": "string", "description": "The value of the key-value pair. For environment variables, this is the value of the environment variable." } }, "type": "object" }, "azure-native:awsconnector:KinesisStreamSpecification": { "description": "Definition of KinesisStreamSpecification", "properties": { "approximateCreationDateTimePrecision": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:KinesisStreamSpecificationApproximateCreationDateTimePrecision" } ], "description": "The precision for the time and date that the stream was created." }, "streamArn": { "type": "string", "description": "The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024." } }, "type": "object" }, "azure-native:awsconnector:KinesisStreamSpecificationApproximateCreationDateTimePrecision": { "description": "The precision for the time and date that the stream was created.", "type": "string", "enum": [ { "name": "MICROSECOND", "description": "KinesisStreamSpecificationApproximateCreationDateTimePrecision enum MICROSECOND", "value": "MICROSECOND" }, { "name": "MILLISECOND", "description": "KinesisStreamSpecificationApproximateCreationDateTimePrecision enum MILLISECOND", "value": "MILLISECOND" } ] }, "azure-native:awsconnector:KinesisStreamSpecificationResponse": { "description": "Definition of KinesisStreamSpecification", "properties": { "approximateCreationDateTimePrecision": { "type": "string", "description": "The precision for the time and date that the stream was created." }, "streamArn": { "type": "string", "description": "The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024." } }, "type": "object" }, "azure-native:awsconnector:KmsAliasProperties": { "description": "Definition of KmsAlias", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsKmsAliasProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:KmsAliasPropertiesResponse": { "description": "Definition of KmsAlias", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsKmsAliasPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:KmsKeyProperties": { "description": "Definition of KmsKey", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsKmsKeyProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:KmsKeyPropertiesResponse": { "description": "Definition of KmsKey", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsKmsKeyPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:KubernetesNetworkConfigResponse": { "description": "Definition of KubernetesNetworkConfigResponse", "properties": { "ipFamily": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpFamilyEnumValue", "description": "\u003cp\u003eThe IP family used to assign Kubernetes \u003ccode\u003ePod\u003c/code\u003e and \u003ccode\u003eService\u003c/code\u003e objects IP addresses. The IP family is always \u003ccode\u003eipv4\u003c/code\u003e, unless you have a \u003ccode\u003e1.21\u003c/code\u003e or later cluster running version \u003ccode\u003e1.10.1\u003c/code\u003e or later of the Amazon VPC CNI plugin for Kubernetes and specified \u003ccode\u003eipv6\u003c/code\u003e when you created the cluster. \u003c/p\u003e" }, "serviceIpv4Cidr": { "type": "string", "description": "\u003cp\u003eThe CIDR block that Kubernetes \u003ccode\u003ePod\u003c/code\u003e and \u003ccode\u003eService\u003c/code\u003e object IP addresses are assigned from. Kubernetes assigns addresses from an \u003ccode\u003eIPv4\u003c/code\u003e CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the \u003ccode\u003e10.100.0.0/16\u003c/code\u003e or \u003ccode\u003e172.20.0.0/16\u003c/code\u003e CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.\u003c/p\u003e" }, "serviceIpv6Cidr": { "type": "string", "description": "\u003cp\u003eThe CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified \u003ccode\u003eipv6\u003c/code\u003e for \u003cb\u003eipFamily\u003c/b\u003e when you created the cluster. Kubernetes assigns service addresses from the unique local address range (\u003ccode\u003efc00::/7\u003c/code\u003e) because you can't specify a custom IPv6 CIDR block when you create the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:KubernetesNetworkConfigResponseResponse": { "description": "Definition of KubernetesNetworkConfigResponse", "properties": { "ipFamily": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IpFamilyEnumValueResponse", "description": "\u003cp\u003eThe IP family used to assign Kubernetes \u003ccode\u003ePod\u003c/code\u003e and \u003ccode\u003eService\u003c/code\u003e objects IP addresses. The IP family is always \u003ccode\u003eipv4\u003c/code\u003e, unless you have a \u003ccode\u003e1.21\u003c/code\u003e or later cluster running version \u003ccode\u003e1.10.1\u003c/code\u003e or later of the Amazon VPC CNI plugin for Kubernetes and specified \u003ccode\u003eipv6\u003c/code\u003e when you created the cluster. \u003c/p\u003e" }, "serviceIpv4Cidr": { "type": "string", "description": "\u003cp\u003eThe CIDR block that Kubernetes \u003ccode\u003ePod\u003c/code\u003e and \u003ccode\u003eService\u003c/code\u003e object IP addresses are assigned from. Kubernetes assigns addresses from an \u003ccode\u003eIPv4\u003c/code\u003e CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the \u003ccode\u003e10.100.0.0/16\u003c/code\u003e or \u003ccode\u003e172.20.0.0/16\u003c/code\u003e CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.\u003c/p\u003e" }, "serviceIpv6Cidr": { "type": "string", "description": "\u003cp\u003eThe CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified \u003ccode\u003eipv6\u003c/code\u003e for \u003cb\u003eipFamily\u003c/b\u003e when you created the cluster. Kubernetes assigns service addresses from the unique local address range (\u003ccode\u003efc00::/7\u003c/code\u003e) because you can't specify a custom IPv6 CIDR block when you create the cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LabelNameConditionModelProperties": { "description": "Definition of LabelNameConditionModelProperties", "properties": { "labelName": { "type": "string", "description": "The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label." } }, "type": "object" }, "azure-native:awsconnector:LabelNameConditionModelPropertiesResponse": { "description": "Definition of LabelNameConditionModelProperties", "properties": { "labelName": { "type": "string", "description": "The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label." } }, "type": "object" }, "azure-native:awsconnector:LambdaAuthorizerConfig": { "description": "Definition of LambdaAuthorizerConfig", "properties": { "authorizerResultTtlInSeconds": { "type": "integer", "description": "\u003cp\u003eThe number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for \u003ccode\u003eauthorizerResultTtlInSeconds\u003c/code\u003e, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a \u003ccode\u003ettlOverride\u003c/code\u003e key in its response.\u003c/p\u003e" }, "authorizerUri": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (\u003ccode\u003e.../v3\u003c/code\u003e), or an alias ARN. \u003c/p\u003e \u003cp\u003e \u003cb\u003eNote\u003c/b\u003e: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:\u003c/p\u003e \u003cp\u003e \u003ccode\u003eaws lambda add-permission --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction\u003c/code\u003e \u003c/p\u003e" }, "identityValidationExpression": { "type": "string", "description": "\u003cp\u003eA regular expression for validation of tokens before the Lambda function is called.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LambdaAuthorizerConfigResponse": { "description": "Definition of LambdaAuthorizerConfig", "properties": { "authorizerResultTtlInSeconds": { "type": "integer", "description": "\u003cp\u003eThe number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for \u003ccode\u003eauthorizerResultTtlInSeconds\u003c/code\u003e, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a \u003ccode\u003ettlOverride\u003c/code\u003e key in its response.\u003c/p\u003e" }, "authorizerUri": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (\u003ccode\u003e.../v3\u003c/code\u003e), or an alias ARN. \u003c/p\u003e \u003cp\u003e \u003cb\u003eNote\u003c/b\u003e: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:\u003c/p\u003e \u003cp\u003e \u003ccode\u003eaws lambda add-permission --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction\u003c/code\u003e \u003c/p\u003e" }, "identityValidationExpression": { "type": "string", "description": "\u003cp\u003eA regular expression for validation of tokens before the Lambda function is called.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LambdaConfiguration": { "description": "Definition of LambdaConfiguration", "properties": { "event": { "type": "string", "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." }, "filter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotificationFilter", "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." }, "function": { "type": "string", "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs." } }, "type": "object" }, "azure-native:awsconnector:LambdaConfigurationResponse": { "description": "Definition of LambdaConfiguration", "properties": { "event": { "type": "string", "description": "The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." }, "filter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotificationFilterResponse", "description": "The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." }, "function": { "type": "string", "description": "The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs." } }, "type": "object" }, "azure-native:awsconnector:LambdaFunctionAssociation": { "description": "Definition of LambdaFunctionAssociation", "properties": { "eventType": { "type": "string", "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute." }, "includeBody": { "type": "boolean", "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide." }, "lambdaFunctionARN": { "type": "string", "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST." } }, "type": "object" }, "azure-native:awsconnector:LambdaFunctionAssociationResponse": { "description": "Definition of LambdaFunctionAssociation", "properties": { "eventType": { "type": "string", "description": "Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute." }, "includeBody": { "type": "boolean", "description": "A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide." }, "lambdaFunctionARN": { "type": "string", "description": "The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST." } }, "type": "object" }, "azure-native:awsconnector:LambdaFunctionCodeLocationProperties": { "description": "Definition of LambdaFunctionCodeLocation", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLambdaFunctionCodeLocationProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LambdaFunctionCodeLocationPropertiesResponse": { "description": "Definition of LambdaFunctionCodeLocation", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLambdaFunctionCodeLocationPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LambdaFunctionProperties": { "description": "Definition of LambdaFunction", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLambdaFunctionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LambdaFunctionPropertiesResponse": { "description": "Definition of LambdaFunction", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLambdaFunctionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LastRunErrorStatus": { "description": "Definition of LastRunErrorStatus", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LastRunErrorStatusCodeEnumValue", "description": "\u003cp\u003eSpecifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eNONE - No errors occurred. Macie processed all the data specified for the job.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:LastRunErrorStatusCode": { "description": "Property value", "type": "string", "enum": [ { "name": "ERROR", "description": "LastRunErrorStatusCode enum ERROR", "value": "ERROR" }, { "name": "NONE", "description": "LastRunErrorStatusCode enum NONE", "value": "NONE" } ] }, "azure-native:awsconnector:LastRunErrorStatusCodeEnumValue": { "description": "Definition of LastRunErrorStatusCodeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LastRunErrorStatusCode" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:LastRunErrorStatusCodeEnumValueResponse": { "description": "Definition of LastRunErrorStatusCodeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:LastRunErrorStatusResponse": { "description": "Definition of LastRunErrorStatus", "properties": { "code": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LastRunErrorStatusCodeEnumValueResponse", "description": "\u003cp\u003eSpecifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eNONE - No errors occurred. Macie processed all the data specified for the job.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplate": { "description": "Definition of LaunchTemplate", "properties": { "launchTemplateSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecification", "description": "The launch template. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." }, "overrides": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateOverrides" }, "description": "Any properties that you specify override the same properties in the launch template." } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplateOverrides": { "description": "Definition of LaunchTemplateOverrides", "properties": { "instanceRequirements": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceRequirements", "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type." }, "instanceType": { "type": "string", "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. You can specify up to 40 instance types per Auto Scaling group." }, "launchTemplateSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecification", "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." }, "weightedCapacity": { "type": "string", "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances." } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplateOverridesResponse": { "description": "Definition of LaunchTemplateOverrides", "properties": { "instanceRequirements": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceRequirementsResponse", "description": "The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type." }, "instanceType": { "type": "string", "description": "The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. You can specify up to 40 instance types per Auto Scaling group." }, "launchTemplateSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecificationResponse", "description": "Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." }, "weightedCapacity": { "type": "string", "description": "If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances." } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplateResponse": { "description": "Definition of LaunchTemplate", "properties": { "launchTemplateSpecification": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateSpecificationResponse", "description": "The launch template. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource." }, "overrides": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateOverridesResponse" }, "description": "Any properties that you specify override the same properties in the launch template." } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplateSpecification": { "description": "Definition of LaunchTemplateSpecification", "properties": { "id": { "type": "string", "description": "Property id" }, "launchTemplateId": { "type": "string", "description": "The ID of the launch template. You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both." }, "launchTemplateName": { "type": "string", "description": "The name of the launch template. You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both." }, "name": { "type": "string", "description": "Property name" }, "version": { "type": "string", "description": "Property version" } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplateSpecificationResponse": { "description": "Definition of LaunchTemplateSpecification", "properties": { "launchTemplateId": { "type": "string", "description": "The ID of the launch template. You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both." }, "launchTemplateName": { "type": "string", "description": "The name of the launch template. You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both." }, "version": { "type": "string", "description": "The version number of the launch template. Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource." } }, "type": "object" }, "azure-native:awsconnector:LaunchTemplateSpecificationResponseV1": { "description": "Definition of LaunchTemplateSpecification", "properties": { "id": { "type": "string", "description": "Property id" }, "name": { "type": "string", "description": "Property name" }, "version": { "type": "string", "description": "Property version" } }, "type": "object" }, "azure-native:awsconnector:LaunchType": { "description": "The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string", "enum": [ { "name": "EC2", "description": "LaunchType enum EC2", "value": "EC2" }, { "name": "EXTERNAL", "description": "LaunchType enum EXTERNAL", "value": "EXTERNAL" }, { "name": "FARGATE", "description": "LaunchType enum FARGATE", "value": "FARGATE" } ] }, "azure-native:awsconnector:LegacyCustomOrigin": { "description": "Definition of LegacyCustomOrigin", "properties": { "dnsName": { "type": "string", "description": "Property dnsName" }, "httpPort": { "type": "integer", "description": "Property httpPort", "default": 80 }, "httpsPort": { "type": "integer", "description": "Property httpsPort", "default": 443 }, "originProtocolPolicy": { "type": "string", "description": "Property originProtocolPolicy" }, "originSSLProtocols": { "type": "array", "items": { "type": "string" }, "description": "Property originSSLProtocols" } }, "type": "object" }, "azure-native:awsconnector:LegacyCustomOriginResponse": { "description": "Definition of LegacyCustomOrigin", "properties": { "dnsName": { "type": "string", "description": "Property dnsName" }, "httpPort": { "type": "integer", "description": "Property httpPort", "default": 80 }, "httpsPort": { "type": "integer", "description": "Property httpsPort", "default": 443 }, "originProtocolPolicy": { "type": "string", "description": "Property originProtocolPolicy" }, "originSSLProtocols": { "type": "array", "items": { "type": "string" }, "description": "Property originSSLProtocols" } }, "type": "object" }, "azure-native:awsconnector:LegacyS3Origin": { "description": "Definition of LegacyS3Origin", "properties": { "dnsName": { "type": "string", "description": "Property dnsName" }, "originAccessIdentity": { "type": "string", "description": "Property originAccessIdentity" } }, "type": "object" }, "azure-native:awsconnector:LegacyS3OriginResponse": { "description": "Definition of LegacyS3Origin", "properties": { "dnsName": { "type": "string", "description": "Property dnsName" }, "originAccessIdentity": { "type": "string", "description": "Property originAccessIdentity" } }, "type": "object" }, "azure-native:awsconnector:LicenseConfiguration": { "description": "Definition of LicenseConfiguration", "properties": { "licenseConfigurationArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the license configuration.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LicenseConfigurationResponse": { "description": "Definition of LicenseConfiguration", "properties": { "licenseConfigurationArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the license configuration.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LifecycleConfiguration": { "description": "Definition of LifecycleConfiguration", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Rule" }, "description": "A lifecycle rule for individual objects in an Amazon S3 bucket." } }, "type": "object" }, "azure-native:awsconnector:LifecycleConfigurationResponse": { "description": "Definition of LifecycleConfiguration", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleResponse" }, "description": "A lifecycle rule for individual objects in an Amazon S3 bucket." } }, "type": "object" }, "azure-native:awsconnector:LifecycleHookSpecification": { "description": "Definition of LifecycleHookSpecification", "properties": { "defaultResult": { "type": "string", "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. Valid values: ``CONTINUE`` | ``ABANDON``" }, "heartbeatTimeout": { "type": "integer", "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour)." }, "lifecycleHookName": { "type": "string", "description": "The name of the lifecycle hook." }, "lifecycleTransition": { "type": "string", "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``." }, "notificationMetadata": { "type": "string", "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target." }, "notificationTargetARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue." }, "roleARN": { "type": "string", "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue." } }, "type": "object" }, "azure-native:awsconnector:LifecycleHookSpecificationResponse": { "description": "Definition of LifecycleHookSpecification", "properties": { "defaultResult": { "type": "string", "description": "The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. Valid values: ``CONTINUE`` | ``ABANDON``" }, "heartbeatTimeout": { "type": "integer", "description": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour)." }, "lifecycleHookName": { "type": "string", "description": "The name of the lifecycle hook." }, "lifecycleTransition": { "type": "string", "description": "The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``." }, "notificationMetadata": { "type": "string", "description": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target." }, "notificationTargetARN": { "type": "string", "description": "The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue." }, "roleARN": { "type": "string", "description": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue." } }, "type": "object" }, "azure-native:awsconnector:LifecyclePolicy": { "description": "Definition of LifecyclePolicy", "properties": { "lifecyclePolicyText": { "type": "string", "description": "The JSON repository policy text to apply to the repository. The JSON repository policy text to apply to the repository." }, "registryId": { "type": "string", "description": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed." }, "transitionToArchive": { "type": "string", "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." }, "transitionToIA": { "type": "string", "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events." }, "transitionToPrimaryStorageClass": { "type": "string", "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." } }, "type": "object" }, "azure-native:awsconnector:LifecyclePolicyResponse": { "description": "Definition of LifecyclePolicy", "properties": { "lifecyclePolicyText": { "type": "string", "description": "The JSON repository policy text to apply to the repository. The JSON repository policy text to apply to the repository." }, "registryId": { "type": "string", "description": "The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed." } }, "type": "object" }, "azure-native:awsconnector:LifecyclePolicyResponseV1": { "description": "Definition of LifecyclePolicy", "properties": { "transitionToArchive": { "type": "string", "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." }, "transitionToIA": { "type": "string", "description": "The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events." }, "transitionToPrimaryStorageClass": { "type": "string", "description": "Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events." } }, "type": "object" }, "azure-native:awsconnector:LightsailBucketProperties": { "description": "Definition of LightsailBucket", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLightsailBucketProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LightsailBucketPropertiesResponse": { "description": "Definition of LightsailBucket", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLightsailBucketPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LightsailInstanceProperties": { "description": "Definition of LightsailInstance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLightsailInstanceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LightsailInstancePropertiesResponse": { "description": "Definition of LightsailInstance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLightsailInstancePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LinuxParameters": { "description": "Definition of LinuxParameters", "properties": { "capabilities": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KernelCapabilities", "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page." }, "devices": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Device" }, "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--device`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported." }, "initProcessEnabled": { "type": "boolean", "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" }, "maxSwap": { "type": "integer", "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." }, "sharedMemorySize": { "type": "integer", "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported." }, "swappiness": { "type": "integer", "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." }, "tmpfs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Tmpfs" }, "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported." } }, "type": "object" }, "azure-native:awsconnector:LinuxParametersResponse": { "description": "Definition of LinuxParameters", "properties": { "capabilities": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KernelCapabilitiesResponse", "description": "The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page." }, "devices": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeviceResponse" }, "description": "Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--device`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported." }, "initProcessEnabled": { "type": "boolean", "description": "Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" }, "maxSwap": { "type": "integer", "description": "The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." }, "sharedMemorySize": { "type": "integer", "description": "The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported." }, "swappiness": { "type": "integer", "description": "This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported." }, "tmpfs": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TmpfsResponse" }, "description": "The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported." } }, "type": "object" }, "azure-native:awsconnector:LoadBalancer": { "description": "Definition of LoadBalancer", "properties": { "containerName": { "type": "string", "description": "The name of the container (as it appears in a container definition) to associate with the load balancer. You need to specify the container name when configuring the target group for an Amazon ECS load balancer." }, "containerPort": { "type": "integer", "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping." }, "loadBalancerName": { "type": "string", "description": "The name of the load balancer to associate with the Amazon ECS service or task set. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted." }, "targetGroupArn": { "type": "string", "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*. For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*. If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type." } }, "type": "object" }, "azure-native:awsconnector:LoadBalancerAttribute": { "description": "Definition of LoadBalancerAttribute", "properties": { "key": { "type": "string", "description": "The name of the attribute. The following attributes are supported by all load balancers: + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. The following attributes are supported by only Network Load Balancers: + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity." }, "value": { "type": "string", "description": "The value of the attribute." } }, "type": "object" }, "azure-native:awsconnector:LoadBalancerAttributeResponse": { "description": "Definition of LoadBalancerAttribute", "properties": { "key": { "type": "string", "description": "The name of the attribute. The following attributes are supported by all load balancers: + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. The following attributes are supported by only Network Load Balancers: + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity." }, "value": { "type": "string", "description": "The value of the attribute." } }, "type": "object" }, "azure-native:awsconnector:LoadBalancerResponse": { "description": "Definition of LoadBalancer", "properties": { "containerName": { "type": "string", "description": "The name of the container (as it appears in a container definition) to associate with the load balancer. You need to specify the container name when configuring the target group for an Amazon ECS load balancer." }, "containerPort": { "type": "integer", "description": "The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping." }, "loadBalancerName": { "type": "string", "description": "The name of the load balancer to associate with the Amazon ECS service or task set. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted." }, "targetGroupArn": { "type": "string", "description": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*. For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*. If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type." } }, "type": "object" }, "azure-native:awsconnector:LocalSecondaryIndex": { "description": "Definition of LocalSecondaryIndex", "properties": { "indexName": { "type": "string", "description": "The name of the local secondary index. The name must be unique among all other indexes on this table." }, "keySchema": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeySchema" }, "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." }, "projection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Projection", "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." } }, "type": "object" }, "azure-native:awsconnector:LocalSecondaryIndexResponse": { "description": "Definition of LocalSecondaryIndex", "properties": { "indexName": { "type": "string", "description": "The name of the local secondary index. The name must be unique among all other indexes on this table." }, "keySchema": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeySchemaResponse" }, "description": "The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value." }, "projection": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectionResponse", "description": "Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected." } }, "type": "object" }, "azure-native:awsconnector:Location": { "description": "Definition of Location", "properties": { "availabilityZone": { "type": "string", "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." }, "regionName": { "type": "string", "description": "The Region Name in which to create your instance." } }, "type": "object" }, "azure-native:awsconnector:LocationResponse": { "description": "Definition of Location", "properties": { "availabilityZone": { "type": "string", "description": "The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request." }, "regionName": { "type": "string", "description": "The Region Name in which to create your instance." } }, "type": "object" }, "azure-native:awsconnector:LogConfig": { "description": "Definition of LogConfig", "properties": { "cloudWatchLogsRoleArn": { "type": "string", "description": "\u003cp\u003eThe service role that AppSync assumes to publish to CloudWatch logs in your account.\u003c/p\u003e" }, "excludeVerboseContent": { "type": "boolean", "description": "\u003cp\u003eSet to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.\u003c/p\u003e" }, "fieldLogLevel": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FieldLogLevelEnumValue", "description": "\u003cp\u003eThe field logging level. Values can be NONE, ERROR, or ALL.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eNONE\u003c/b\u003e: No field-level logs are captured.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eERROR\u003c/b\u003e: Logs the following information only for the fields that are in error:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe error section in the server response.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eField-level errors.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe generated request/response functions that got resolved for error fields.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eALL\u003c/b\u003e: The following information is logged for all fields in the query:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eField-level tracing information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe generated request/response functions that got resolved for each field.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogConfigResponse": { "description": "Definition of LogConfig", "properties": { "cloudWatchLogsRoleArn": { "type": "string", "description": "\u003cp\u003eThe service role that AppSync assumes to publish to CloudWatch logs in your account.\u003c/p\u003e" }, "excludeVerboseContent": { "type": "boolean", "description": "\u003cp\u003eSet to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.\u003c/p\u003e" }, "fieldLogLevel": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FieldLogLevelEnumValueResponse", "description": "\u003cp\u003eThe field logging level. Values can be NONE, ERROR, or ALL.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eNONE\u003c/b\u003e: No field-level logs are captured.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eERROR\u003c/b\u003e: Logs the following information only for the fields that are in error:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe error section in the server response.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eField-level errors.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe generated request/response functions that got resolved for error fields.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eALL\u003c/b\u003e: The following information is logged for all fields in the query:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eField-level tracing information.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe generated request/response functions that got resolved for each field.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogConfiguration": { "description": "Definition of LogConfiguration", "properties": { "logDriver": { "type": "string", "description": "The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software." }, "options": { "$ref": "pulumi.json#/Any", "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" }, "secretOptions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Secret" }, "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:LogConfigurationResponse": { "description": "Definition of LogConfiguration", "properties": { "logDriver": { "type": "string", "description": "The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software." }, "options": { "$ref": "pulumi.json#/Any", "description": "The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'``" }, "secretOptions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SecretResponse" }, "description": "The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:LogDestinationType": { "description": "Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3.", "type": "string", "enum": [ { "name": "CloudWatchLogs", "description": "LogDestinationType enum cloud-watch-logs", "value": "cloud-watch-logs" }, { "name": "KinesisDataFirehose", "description": "LogDestinationType enum kinesis-data-firehose", "value": "kinesis-data-firehose" }, { "name": "s3", "description": "LogDestinationType enum s3", "value": "s3" } ] }, "azure-native:awsconnector:LogGroupClass": { "description": "Specifies the log group class for this log group. There are two classes: + The ``Standard`` log class supports all CWL features. + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html)", "type": "string", "enum": [ { "name": "INFREQUENT_ACCESS", "description": "LogGroupClass enum INFREQUENT_ACCESS", "value": "INFREQUENT_ACCESS" }, { "name": "STANDARD", "description": "LogGroupClass enum STANDARD", "value": "STANDARD" } ] }, "azure-native:awsconnector:LogPublishingOption": { "description": "Definition of LogPublishingOption", "properties": { "cloudWatchLogsLogGroupArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.\u003c/p\u003e" }, "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether the log should be published.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogPublishingOptionResponse": { "description": "Definition of LogPublishingOption", "properties": { "cloudWatchLogsLogGroupArn": { "type": "string", "description": "\u003cp\u003eThe Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.\u003c/p\u003e" }, "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether the log should be published.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogSetup": { "description": "Definition of LogSetup", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eIf a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.\u003c/p\u003e" }, "types": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LogType" } ] }, "description": "\u003cp\u003eThe available cluster control plane log types.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogSetupResponse": { "description": "Definition of LogSetup", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eIf a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.\u003c/p\u003e" }, "types": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe available cluster control plane log types.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogType": { "description": "LogType enum", "type": "string", "enum": [ { "name": "Api", "description": "LogType enum api", "value": "api" }, { "name": "Audit", "description": "LogType enum audit", "value": "audit" }, { "name": "Authenticator", "description": "LogType enum authenticator", "value": "authenticator" }, { "name": "ControllerManager", "description": "LogType enum controllerManager", "value": "controllerManager" }, { "name": "Scheduler", "description": "LogType enum scheduler", "value": "scheduler" } ] }, "azure-native:awsconnector:Logging": { "description": "Definition of Logging", "properties": { "bucket": { "type": "string", "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``." }, "clusterLogging": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogSetup" }, "description": "\u003cp\u003eThe cluster control plane logging configuration for your cluster.\u003c/p\u003e" }, "includeCookies": { "type": "boolean", "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``." }, "prefix": { "type": "string", "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element." } }, "type": "object" }, "azure-native:awsconnector:LoggingConfig": { "description": "Definition of LoggingConfig", "properties": { "applicationLogLevel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LoggingConfigApplicationLogLevel" } ], "description": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest." }, "failureFeedbackRoleArn": { "type": "string", "description": "Property failureFeedbackRoleArn" }, "logFormat": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LoggingConfigLogFormat" } ], "description": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON." }, "logGroup": { "type": "string", "description": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/\u003cfunction name\u003e``. To use a different log group, enter an existing log group or enter a new log group name." }, "protocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LoggingConfigProtocol" } ], "description": "Property protocol" }, "successFeedbackRoleArn": { "type": "string", "description": "Property successFeedbackRoleArn" }, "successFeedbackSampleRate": { "type": "string", "description": "Property successFeedbackSampleRate" }, "systemLogLevel": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LoggingConfigSystemLogLevel" } ], "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest." } }, "type": "object" }, "azure-native:awsconnector:LoggingConfigApplicationLogLevel": { "description": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest.", "type": "string", "enum": [ { "name": "DEBUG", "description": "LoggingConfigApplicationLogLevel enum DEBUG", "value": "DEBUG" }, { "name": "ERROR", "description": "LoggingConfigApplicationLogLevel enum ERROR", "value": "ERROR" }, { "name": "FATAL", "description": "LoggingConfigApplicationLogLevel enum FATAL", "value": "FATAL" }, { "name": "INFO", "description": "LoggingConfigApplicationLogLevel enum INFO", "value": "INFO" }, { "name": "TRACE", "description": "LoggingConfigApplicationLogLevel enum TRACE", "value": "TRACE" }, { "name": "WARN", "description": "LoggingConfigApplicationLogLevel enum WARN", "value": "WARN" } ] }, "azure-native:awsconnector:LoggingConfigLogFormat": { "description": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON.", "type": "string", "enum": [ { "name": "JSON", "description": "LoggingConfigLogFormat enum JSON", "value": "JSON" }, { "name": "Text", "description": "LoggingConfigLogFormat enum Text", "value": "Text" } ] }, "azure-native:awsconnector:LoggingConfigProtocol": { "description": "Property protocol", "type": "string", "enum": [ { "name": "application", "description": "LoggingConfigProtocol enum application", "value": "application" }, { "name": "firehose", "description": "LoggingConfigProtocol enum firehose", "value": "firehose" }, { "name": "HttpS", "description": "LoggingConfigProtocol enum http/s", "value": "http/s" }, { "name": "lambda", "description": "LoggingConfigProtocol enum lambda", "value": "lambda" }, { "name": "sqs", "description": "LoggingConfigProtocol enum sqs", "value": "sqs" } ] }, "azure-native:awsconnector:LoggingConfigResponse": { "description": "Definition of LoggingConfig", "properties": { "applicationLogLevel": { "type": "string", "description": "Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest." }, "logFormat": { "type": "string", "description": "The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON." }, "logGroup": { "type": "string", "description": "The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/\u003cfunction name\u003e``. To use a different log group, enter an existing log group or enter a new log group name." }, "systemLogLevel": { "type": "string", "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest." } }, "type": "object" }, "azure-native:awsconnector:LoggingConfigResponseV1": { "description": "Definition of LoggingConfig", "properties": { "failureFeedbackRoleArn": { "type": "string", "description": "Property failureFeedbackRoleArn" }, "protocol": { "type": "string", "description": "Property protocol" }, "successFeedbackRoleArn": { "type": "string", "description": "Property successFeedbackRoleArn" }, "successFeedbackSampleRate": { "type": "string", "description": "Property successFeedbackSampleRate" } }, "type": "object" }, "azure-native:awsconnector:LoggingConfigSystemLogLevel": { "description": "Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest.", "type": "string", "enum": [ { "name": "DEBUG", "description": "LoggingConfigSystemLogLevel enum DEBUG", "value": "DEBUG" }, { "name": "INFO", "description": "LoggingConfigSystemLogLevel enum INFO", "value": "INFO" }, { "name": "WARN", "description": "LoggingConfigSystemLogLevel enum WARN", "value": "WARN" } ] }, "azure-native:awsconnector:LoggingConfiguration": { "description": "Definition of LoggingConfiguration", "properties": { "destinationBucketName": { "type": "string", "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined." }, "logFilePrefix": { "type": "string", "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket." }, "targetObjectKeyFormat": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetObjectKeyFormat", "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed. Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix." } }, "type": "object" }, "azure-native:awsconnector:LoggingConfigurationResponse": { "description": "Definition of LoggingConfiguration", "properties": { "destinationBucketName": { "type": "string", "description": "The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined." }, "logFilePrefix": { "type": "string", "description": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket." }, "targetObjectKeyFormat": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TargetObjectKeyFormatResponse", "description": "Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed. Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix." } }, "type": "object" }, "azure-native:awsconnector:LoggingFilterModelProperties": { "description": "Definition of LoggingFilterModelProperties", "properties": { "defaultBehavior": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:DefaultBehavior" } ], "description": "Default handling for logs that don't match any of the specified filtering conditions." }, "filters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Filter" }, "description": "The filters that you want to apply to the logs." } }, "type": "object" }, "azure-native:awsconnector:LoggingFilterModelPropertiesResponse": { "description": "Definition of LoggingFilterModelProperties", "properties": { "defaultBehavior": { "type": "string", "description": "Default handling for logs that don't match any of the specified filtering conditions." }, "filters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FilterResponseV1" }, "description": "The filters that you want to apply to the logs." } }, "type": "object" }, "azure-native:awsconnector:LoggingProperties": { "description": "Definition of LoggingProperties", "properties": { "bucketName": { "type": "string", "description": "Property bucketName" }, "s3KeyPrefix": { "type": "string", "description": "Property s3KeyPrefix" } }, "type": "object" }, "azure-native:awsconnector:LoggingPropertiesResponse": { "description": "Definition of LoggingProperties", "properties": { "bucketName": { "type": "string", "description": "Property bucketName" }, "s3KeyPrefix": { "type": "string", "description": "Property s3KeyPrefix" } }, "type": "object" }, "azure-native:awsconnector:LoggingResponse": { "description": "Definition of Logging", "properties": { "bucket": { "type": "string", "description": "The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``." }, "includeCookies": { "type": "boolean", "description": "Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``." }, "prefix": { "type": "string", "description": "An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element." } }, "type": "object" }, "azure-native:awsconnector:LoggingResponseV1": { "description": "Definition of Logging", "properties": { "clusterLogging": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogSetupResponse" }, "description": "\u003cp\u003eThe cluster control plane logging configuration for your cluster.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogsConfig": { "description": "Definition of LogsConfig", "properties": { "cloudWatchLogs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CloudWatchLogsConfig", "description": "\u003cp\u003e Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. \u003c/p\u003e" }, "s3Logs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3LogsConfig", "description": "\u003cp\u003e Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogsConfigResponse": { "description": "Definition of LogsConfig", "properties": { "cloudWatchLogs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CloudWatchLogsConfigResponse", "description": "\u003cp\u003e Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default. \u003c/p\u003e" }, "s3Logs": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3LogsConfigResponse", "description": "\u003cp\u003e Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:LogsConfigStatusType": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "LogsConfigStatusType enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "LogsConfigStatusType enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:LogsConfigStatusTypeEnumValue": { "description": "Definition of LogsConfigStatusTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:LogsConfigStatusType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:LogsConfigStatusTypeEnumValueResponse": { "description": "Definition of LogsConfigStatusTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:LogsLogGroupProperties": { "description": "Definition of LogsLogGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsLogGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LogsLogGroupPropertiesResponse": { "description": "Definition of LogsLogGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsLogGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LogsLogStreamProperties": { "description": "Definition of LogsLogStream", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsLogStreamProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LogsLogStreamPropertiesResponse": { "description": "Definition of LogsLogStream", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsLogStreamPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LogsMetricFilterProperties": { "description": "Definition of LogsMetricFilter", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsMetricFilterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LogsMetricFilterPropertiesResponse": { "description": "Definition of LogsMetricFilter", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsMetricFilterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:LogsSubscriptionFilterProperties": { "description": "Definition of LogsSubscriptionFilter", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsSubscriptionFilterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:LogsSubscriptionFilterPropertiesResponse": { "description": "Definition of LogsSubscriptionFilter", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsLogsSubscriptionFilterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Macie2JobSummaryProperties": { "description": "Definition of Macie2JobSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsMacie2JobSummaryProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Macie2JobSummaryPropertiesResponse": { "description": "Definition of Macie2JobSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsMacie2JobSummaryPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:MacieAllowListProperties": { "description": "Definition of MacieAllowList", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsMacieAllowListProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:MacieAllowListPropertiesResponse": { "description": "Definition of MacieAllowList", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsMacieAllowListPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:MasterUserSecret": { "description": "Definition of MasterUserSecret", "properties": { "kmsKeyId": { "type": "string", "description": "The AWS KMS key identifier that is used to encrypt the secret." }, "secretArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the secret." } }, "type": "object" }, "azure-native:awsconnector:MasterUserSecretResponse": { "description": "Definition of MasterUserSecret", "properties": { "kmsKeyId": { "type": "string", "description": "The AWS KMS key identifier that is used to encrypt the secret." }, "secretArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the secret." } }, "type": "object" }, "azure-native:awsconnector:MatchAttributes": { "description": "Definition of MatchAttributes", "properties": { "destinationPorts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortRange" }, "description": "Property destinationPorts" }, "destinations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Address" }, "description": "Property destinations" }, "protocols": { "type": "array", "items": { "type": "integer" }, "description": "Property protocols" }, "sourcePorts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortRange" }, "description": "Property sourcePorts" }, "sources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Address" }, "description": "Property sources" }, "tcpFlags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TCPFlagField" }, "description": "Property tcpFlags" } }, "type": "object" }, "azure-native:awsconnector:MatchAttributesResponse": { "description": "Definition of MatchAttributes", "properties": { "destinationPorts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortRangeResponse" }, "description": "Property destinationPorts" }, "destinations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AddressResponse" }, "description": "Property destinations" }, "protocols": { "type": "array", "items": { "type": "integer" }, "description": "Property protocols" }, "sourcePorts": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortRangeResponse" }, "description": "Property sourcePorts" }, "sources": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AddressResponse" }, "description": "Property sources" }, "tcpFlags": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TCPFlagFieldResponse" }, "description": "Property tcpFlags" } }, "type": "object" }, "azure-native:awsconnector:Matcher": { "description": "Definition of Matcher", "properties": { "grpcCode": { "type": "string", "description": "You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12." }, "httpCode": { "type": "string", "description": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values." } }, "type": "object" }, "azure-native:awsconnector:MatcherResponse": { "description": "Definition of Matcher", "properties": { "grpcCode": { "type": "string", "description": "You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12." }, "httpCode": { "type": "string", "description": "For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values." } }, "type": "object" }, "azure-native:awsconnector:MaxAgeRule": { "description": "Definition of MaxAgeRule", "properties": { "deleteSourceFromS3": { "type": "boolean", "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." }, "enabled": { "type": "boolean", "description": "Specify true to apply the rule, or false to disable it." }, "maxAgeInDays": { "type": "integer", "description": "Specify the number of days to retain an application versions." } }, "type": "object" }, "azure-native:awsconnector:MaxAgeRuleResponse": { "description": "Definition of MaxAgeRule", "properties": { "deleteSourceFromS3": { "type": "boolean", "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." }, "enabled": { "type": "boolean", "description": "Specify true to apply the rule, or false to disable it." }, "maxAgeInDays": { "type": "integer", "description": "Specify the number of days to retain an application versions." } }, "type": "object" }, "azure-native:awsconnector:MaxCountRule": { "description": "Definition of MaxCountRule", "properties": { "deleteSourceFromS3": { "type": "boolean", "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." }, "enabled": { "type": "boolean", "description": "Specify true to apply the rule, or false to disable it." }, "maxCount": { "type": "integer", "description": "Specify the maximum number of application versions to retain." } }, "type": "object" }, "azure-native:awsconnector:MaxCountRuleResponse": { "description": "Definition of MaxCountRule", "properties": { "deleteSourceFromS3": { "type": "boolean", "description": "Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version." }, "enabled": { "type": "boolean", "description": "Specify true to apply the rule, or false to disable it." }, "maxCount": { "type": "integer", "description": "Specify the maximum number of application versions to retain." } }, "type": "object" }, "azure-native:awsconnector:MaximumExecutionFrequency": { "description": "Property value", "type": "string", "enum": [ { "name": "One_Hour", "description": "MaximumExecutionFrequency enum One_Hour", "value": "One_Hour" }, { "name": "Six_Hours", "description": "MaximumExecutionFrequency enum Six_Hours", "value": "Six_Hours" }, { "name": "Three_Hours", "description": "MaximumExecutionFrequency enum Three_Hours", "value": "Three_Hours" }, { "name": "Twelve_Hours", "description": "MaximumExecutionFrequency enum Twelve_Hours", "value": "Twelve_Hours" }, { "name": "TwentyFour_Hours", "description": "MaximumExecutionFrequency enum TwentyFour_Hours", "value": "TwentyFour_Hours" } ] }, "azure-native:awsconnector:MaximumExecutionFrequencyEnumValue": { "description": "Definition of MaximumExecutionFrequencyEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:MaximumExecutionFrequency" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:MaximumExecutionFrequencyEnumValueResponse": { "description": "Definition of MaximumExecutionFrequencyEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:MemoryGiBPerVCpuRequest": { "description": "Definition of MemoryGiBPerVCpuRequest", "properties": { "max": { "type": "integer", "description": "The memory maximum in GiB." }, "min": { "type": "integer", "description": "The memory minimum in GiB." } }, "type": "object" }, "azure-native:awsconnector:MemoryGiBPerVCpuRequestResponse": { "description": "Definition of MemoryGiBPerVCpuRequest", "properties": { "max": { "type": "integer", "description": "The memory maximum in GiB." }, "min": { "type": "integer", "description": "The memory minimum in GiB." } }, "type": "object" }, "azure-native:awsconnector:MemoryMiBRequest": { "description": "Definition of MemoryMiBRequest", "properties": { "max": { "type": "integer", "description": "The memory maximum in MiB." }, "min": { "type": "integer", "description": "The memory minimum in MiB." } }, "type": "object" }, "azure-native:awsconnector:MemoryMiBRequestResponse": { "description": "Definition of MemoryMiBRequest", "properties": { "max": { "type": "integer", "description": "The memory maximum in MiB." }, "min": { "type": "integer", "description": "The memory minimum in MiB." } }, "type": "object" }, "azure-native:awsconnector:MethodSetting": { "description": "Definition of MethodSetting", "properties": { "cacheDataEncrypted": { "type": "boolean", "description": "Specifies whether the cached responses are encrypted." }, "cacheTtlInSeconds": { "type": "integer", "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached." }, "cachingEnabled": { "type": "boolean", "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached." }, "dataTraceEnabled": { "type": "boolean", "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs." }, "httpMethod": { "type": "string", "description": "The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." }, "loggingLevel": { "type": "string", "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events." }, "metricsEnabled": { "type": "boolean", "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method." }, "resourcePath": { "type": "string", "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." }, "throttlingBurstLimit": { "type": "integer", "description": "Specifies the throttling burst limit." }, "throttlingRateLimit": { "type": "integer", "description": "Specifies the throttling rate limit." } }, "type": "object" }, "azure-native:awsconnector:MethodSettingResponse": { "description": "Definition of MethodSetting", "properties": { "cacheDataEncrypted": { "type": "boolean", "description": "Specifies whether the cached responses are encrypted." }, "cacheTtlInSeconds": { "type": "integer", "description": "Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached." }, "cachingEnabled": { "type": "boolean", "description": "Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached." }, "dataTraceEnabled": { "type": "boolean", "description": "Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs." }, "httpMethod": { "type": "string", "description": "The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." }, "loggingLevel": { "type": "string", "description": "Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events." }, "metricsEnabled": { "type": "boolean", "description": "Specifies whether Amazon CloudWatch metrics are enabled for this method." }, "resourcePath": { "type": "string", "description": "The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``." }, "throttlingBurstLimit": { "type": "integer", "description": "Specifies the throttling burst limit." }, "throttlingRateLimit": { "type": "integer", "description": "Specifies the throttling rate limit." } }, "type": "object" }, "azure-native:awsconnector:Metric": { "description": "Definition of Metric", "properties": { "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Dimension" }, "description": "The metric dimensions that you want to be used for the metric that the alarm will watch." }, "metricName": { "type": "string", "description": "The name of the metric that you want the alarm to watch. This is a required field." }, "namespace": { "type": "string", "description": "The namespace of the metric that the alarm will watch." } }, "type": "object" }, "azure-native:awsconnector:MetricDataQuery": { "description": "Definition of MetricDataQuery", "properties": { "accountId": { "type": "string", "description": "The ID of the account where the metrics are located, if this is a cross-account alarm." }, "expression": { "type": "string", "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." }, "id": { "type": "string", "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter." }, "label": { "type": "string", "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default." }, "metricStat": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricStat", "description": "The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. This structure defines the metric to be returned, along with the statistics, period, and units. ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type." }, "period": { "type": "integer", "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``." }, "returnData": { "type": "boolean", "description": "This option indicates whether to return the timestamps and raw data values of this metric. When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. This field is required." } }, "type": "object" }, "azure-native:awsconnector:MetricDataQueryResponse": { "description": "Definition of MetricDataQuery", "properties": { "accountId": { "type": "string", "description": "The ID of the account where the metrics are located, if this is a cross-account alarm." }, "expression": { "type": "string", "description": "The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both." }, "id": { "type": "string", "description": "A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter." }, "label": { "type": "string", "description": "A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default." }, "metricStat": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricStatResponse", "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. Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. This structure defines the metric to be returned, along with the statistics, period, and units. ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type." }, "period": { "type": "integer", "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``." }, "returnData": { "type": "boolean", "description": "This option indicates whether to return the timestamps and raw data values of this metric. When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. This field is required." } }, "type": "object" }, "azure-native:awsconnector:MetricResponse": { "description": "Definition of Metric", "properties": { "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DimensionResponse" }, "description": "The metric dimensions that you want to be used for the metric that the alarm will watch." }, "metricName": { "type": "string", "description": "The name of the metric that you want the alarm to watch. This is a required field." }, "namespace": { "type": "string", "description": "The namespace of the metric that the alarm will watch." } }, "type": "object" }, "azure-native:awsconnector:MetricStat": { "description": "Definition of MetricStat", "properties": { "metric": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Metric", "description": "The metric to return, including the metric name, namespace, and dimensions. The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type." }, "period": { "type": "integer", "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour)." }, "stat": { "type": "string", "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*." }, "unit": { "type": "string", "description": "The unit to use for the returned data points. Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None." } }, "type": "object" }, "azure-native:awsconnector:MetricStatResponse": { "description": "Definition of MetricStat", "properties": { "metric": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricResponse", "description": "The metric to return, including the metric name, namespace, and dimensions. The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type." }, "period": { "type": "integer", "description": "The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour)." }, "stat": { "type": "string", "description": "The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*." }, "unit": { "type": "string", "description": "The unit to use for the returned data points. Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None." } }, "type": "object" }, "azure-native:awsconnector:MetricTransformation": { "description": "Definition of MetricTransformation", "properties": { "defaultValue": { "type": "integer", "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null." }, "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Dimension" }, "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)." }, "metricName": { "type": "string", "description": "The name of the CloudWatch metric." }, "metricNamespace": { "type": "string", "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace)." }, "metricValue": { "type": "string", "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``." }, "unit": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:MetricTransformationUnit" } ], "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``." } }, "type": "object" }, "azure-native:awsconnector:MetricTransformationResponse": { "description": "Definition of MetricTransformation", "properties": { "defaultValue": { "type": "integer", "description": "(Optional) The value to emit when a filter pattern does not match a log event. This value can be null." }, "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DimensionResponseV1" }, "description": "The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html)." }, "metricName": { "type": "string", "description": "The name of the CloudWatch metric." }, "metricNamespace": { "type": "string", "description": "A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace)." }, "metricValue": { "type": "string", "description": "The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``." }, "unit": { "type": "string", "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``." } }, "type": "object" }, "azure-native:awsconnector:MetricTransformationUnit": { "description": "The unit to assign to the metric. If you omit this, the unit is set as ``None``.", "type": "string", "enum": [ { "name": "Bits", "description": "MetricTransformationUnit enum Bits", "value": "Bits" }, { "name": "BitsSecond", "description": "MetricTransformationUnit enum Bits/Second", "value": "Bits/Second" }, { "name": "Bytes", "description": "MetricTransformationUnit enum Bytes", "value": "Bytes" }, { "name": "BytesSecond", "description": "MetricTransformationUnit enum Bytes/Second", "value": "Bytes/Second" }, { "name": "Count", "description": "MetricTransformationUnit enum Count", "value": "Count" }, { "name": "CountSecond", "description": "MetricTransformationUnit enum Count/Second", "value": "Count/Second" }, { "name": "Gigabits", "description": "MetricTransformationUnit enum Gigabits", "value": "Gigabits" }, { "name": "GigabitsSecond", "description": "MetricTransformationUnit enum Gigabits/Second", "value": "Gigabits/Second" }, { "name": "Gigabytes", "description": "MetricTransformationUnit enum Gigabytes", "value": "Gigabytes" }, { "name": "GigabytesSecond", "description": "MetricTransformationUnit enum Gigabytes/Second", "value": "Gigabytes/Second" }, { "name": "Kilobits", "description": "MetricTransformationUnit enum Kilobits", "value": "Kilobits" }, { "name": "KilobitsSecond", "description": "MetricTransformationUnit enum Kilobits/Second", "value": "Kilobits/Second" }, { "name": "Kilobytes", "description": "MetricTransformationUnit enum Kilobytes", "value": "Kilobytes" }, { "name": "KilobytesSecond", "description": "MetricTransformationUnit enum Kilobytes/Second", "value": "Kilobytes/Second" }, { "name": "Megabits", "description": "MetricTransformationUnit enum Megabits", "value": "Megabits" }, { "name": "MegabitsSecond", "description": "MetricTransformationUnit enum Megabits/Second", "value": "Megabits/Second" }, { "name": "Megabytes", "description": "MetricTransformationUnit enum Megabytes", "value": "Megabytes" }, { "name": "MegabytesSecond", "description": "MetricTransformationUnit enum Megabytes/Second", "value": "Megabytes/Second" }, { "name": "Microseconds", "description": "MetricTransformationUnit enum Microseconds", "value": "Microseconds" }, { "name": "Milliseconds", "description": "MetricTransformationUnit enum Milliseconds", "value": "Milliseconds" }, { "name": "None", "description": "MetricTransformationUnit enum None", "value": "None" }, { "name": "Percent", "description": "MetricTransformationUnit enum Percent", "value": "Percent" }, { "name": "Seconds", "description": "MetricTransformationUnit enum Seconds", "value": "Seconds" }, { "name": "Terabits", "description": "MetricTransformationUnit enum Terabits", "value": "Terabits" }, { "name": "TerabitsSecond", "description": "MetricTransformationUnit enum Terabits/Second", "value": "Terabits/Second" }, { "name": "Terabytes", "description": "MetricTransformationUnit enum Terabytes", "value": "Terabytes" }, { "name": "TerabytesSecond", "description": "MetricTransformationUnit enum Terabytes/Second", "value": "Terabytes/Second" } ] }, "azure-native:awsconnector:Metrics": { "description": "Definition of Metrics", "properties": { "eventThreshold": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationTimeValue", "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:MetricsStatus" } ], "description": "Specifies whether the replication metrics are enabled." } }, "type": "object" }, "azure-native:awsconnector:MetricsCollection": { "description": "Definition of MetricsCollection", "properties": { "granularity": { "type": "string", "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``." }, "metrics": { "type": "array", "items": { "type": "string" }, "description": "Identifies the metrics to enable. You can specify one or more of the following metrics: + ``GroupMinSize`` + ``GroupMaxSize`` + ``GroupDesiredCapacity`` + ``GroupInServiceInstances`` + ``GroupPendingInstances`` + ``GroupStandbyInstances`` + ``GroupTerminatingInstances`` + ``GroupTotalInstances`` + ``GroupInServiceCapacity`` + ``GroupPendingCapacity`` + ``GroupStandbyCapacity`` + ``GroupTerminatingCapacity`` + ``GroupTotalCapacity`` + ``WarmPoolDesiredCapacity`` + ``WarmPoolWarmedCapacity`` + ``WarmPoolPendingCapacity`` + ``WarmPoolTerminatingCapacity`` + ``WarmPoolTotalCapacity`` + ``GroupAndWarmPoolDesiredCapacity`` + ``GroupAndWarmPoolTotalCapacity`` If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*." } }, "type": "object" }, "azure-native:awsconnector:MetricsCollectionResponse": { "description": "Definition of MetricsCollection", "properties": { "granularity": { "type": "string", "description": "The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``." }, "metrics": { "type": "array", "items": { "type": "string" }, "description": "Identifies the metrics to enable. You can specify one or more of the following metrics: + ``GroupMinSize`` + ``GroupMaxSize`` + ``GroupDesiredCapacity`` + ``GroupInServiceInstances`` + ``GroupPendingInstances`` + ``GroupStandbyInstances`` + ``GroupTerminatingInstances`` + ``GroupTotalInstances`` + ``GroupInServiceCapacity`` + ``GroupPendingCapacity`` + ``GroupStandbyCapacity`` + ``GroupTerminatingCapacity`` + ``GroupTotalCapacity`` + ``WarmPoolDesiredCapacity`` + ``WarmPoolWarmedCapacity`` + ``WarmPoolPendingCapacity`` + ``WarmPoolTerminatingCapacity`` + ``WarmPoolTotalCapacity`` + ``GroupAndWarmPoolDesiredCapacity`` + ``GroupAndWarmPoolTotalCapacity`` If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*." } }, "type": "object" }, "azure-native:awsconnector:MetricsConfiguration": { "description": "Definition of MetricsConfiguration", "properties": { "accessPointArn": { "type": "string", "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria." }, "id": { "type": "string", "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration." }, "prefix": { "type": "string", "description": "The prefix that an object must have to be included in the metrics results." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilter" }, "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria." } }, "type": "object" }, "azure-native:awsconnector:MetricsConfigurationResponse": { "description": "Definition of MetricsConfiguration", "properties": { "accessPointArn": { "type": "string", "description": "The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria." }, "id": { "type": "string", "description": "The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration." }, "prefix": { "type": "string", "description": "The prefix that an object must have to be included in the metrics results." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilterResponse" }, "description": "Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria." } }, "type": "object" }, "azure-native:awsconnector:MetricsResponse": { "description": "Definition of Metrics", "properties": { "eventThreshold": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationTimeValueResponse", "description": "A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``." }, "status": { "type": "string", "description": "Specifies whether the replication metrics are enabled." } }, "type": "object" }, "azure-native:awsconnector:MetricsStatus": { "description": "Specifies whether the replication metrics are enabled.", "type": "string", "enum": [ { "name": "Disabled", "description": "MetricsStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "MetricsStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:MitigationInEffectEnum": { "description": "Property value", "type": "string", "enum": [ { "name": "No", "description": "MitigationInEffectEnum enum no", "value": "no" }, { "name": "Yes", "description": "MitigationInEffectEnum enum yes", "value": "yes" } ] }, "azure-native:awsconnector:MitigationInEffectEnumEnumValue": { "description": "Definition of MitigationInEffectEnumEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:MitigationInEffectEnum" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:MitigationInEffectEnumEnumValueResponse": { "description": "Definition of MitigationInEffectEnumEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:MixedInstancesPolicy": { "description": "Definition of MixedInstancesPolicy", "properties": { "instancesDistribution": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstancesDistribution", "description": "The instances distribution. Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type." }, "launchTemplate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplate", "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy. ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type." } }, "type": "object" }, "azure-native:awsconnector:MixedInstancesPolicyResponse": { "description": "Definition of MixedInstancesPolicy", "properties": { "instancesDistribution": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstancesDistributionResponse", "description": "The instances distribution. Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type." }, "launchTemplate": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LaunchTemplateResponse", "description": "One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy. ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type." } }, "type": "object" }, "azure-native:awsconnector:ModifyingProperties": { "description": "Definition of ModifyingProperties", "properties": { "activeValue": { "type": "string", "description": "\u003cp\u003eThe current value of the domain property that is being modified.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the property that is currently being modified.\u003c/p\u003e" }, "pendingValue": { "type": "string", "description": "\u003cp\u003eThe value that the property that is currently being modified will eventually have.\u003c/p\u003e" }, "valueType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PropertyValueTypeEnumValue", "description": "\u003cp\u003eThe type of value that is currently being modified. Properties can have two types:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePLAIN_TEXT\u003c/code\u003e: Contain direct values such as '1', 'True', or 'c5.large.search'.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSTRINGIFIED_JSON\u003c/code\u003e: Contain content in JSON format, such as {'Enabled':'True'}'.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ModifyingPropertiesResponse": { "description": "Definition of ModifyingProperties", "properties": { "activeValue": { "type": "string", "description": "\u003cp\u003eThe current value of the domain property that is being modified.\u003c/p\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eThe name of the property that is currently being modified.\u003c/p\u003e" }, "pendingValue": { "type": "string", "description": "\u003cp\u003eThe value that the property that is currently being modified will eventually have.\u003c/p\u003e" }, "valueType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PropertyValueTypeEnumValueResponse", "description": "\u003cp\u003eThe type of value that is currently being modified. Properties can have two types:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003ePLAIN_TEXT\u003c/code\u003e: Contain direct values such as '1', 'True', or 'c5.large.search'.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSTRINGIFIED_JSON\u003c/code\u003e: Contain content in JSON format, such as {'Enabled':'True'}'.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:Monitoring": { "description": "Definition of Monitoring", "properties": { "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MonitoringStateEnumValue", "description": "\u003cp\u003eIndicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:MonitoringResponse": { "description": "Definition of Monitoring", "properties": { "state": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MonitoringStateEnumValueResponse", "description": "\u003cp\u003eIndicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:MonitoringState": { "description": "Property value", "type": "string", "enum": [ { "name": "Disabled", "description": "MonitoringState enum disabled", "value": "disabled" }, { "name": "Disabling", "description": "MonitoringState enum disabling", "value": "disabling" }, { "name": "Enabled", "description": "MonitoringState enum enabled", "value": "enabled" }, { "name": "Pending", "description": "MonitoringState enum pending", "value": "pending" } ] }, "azure-native:awsconnector:MonitoringStateEnumValue": { "description": "Definition of MonitoringStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:MonitoringState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:MonitoringStateEnumValueResponse": { "description": "Definition of MonitoringStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:MonthlyTransfer": { "description": "Definition of MonthlyTransfer", "properties": { "gbPerMonthAllocated": { "type": "string", "description": "GbPerMonthAllocated of the Instance." } }, "type": "object" }, "azure-native:awsconnector:MonthlyTransferResponse": { "description": "Definition of MonthlyTransfer", "properties": { "gbPerMonthAllocated": { "type": "string", "description": "GbPerMonthAllocated of the Instance." } }, "type": "object" }, "azure-native:awsconnector:MountPoint": { "description": "Definition of MountPoint", "properties": { "containerPath": { "type": "string", "description": "The path on the container to mount the host volume at." }, "readOnly": { "type": "boolean", "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``." }, "sourceVolume": { "type": "string", "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``." } }, "type": "object" }, "azure-native:awsconnector:MountPointResponse": { "description": "Definition of MountPoint", "properties": { "containerPath": { "type": "string", "description": "The path on the container to mount the host volume at." }, "readOnly": { "type": "boolean", "description": "If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``." }, "sourceVolume": { "type": "string", "description": "The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``." } }, "type": "object" }, "azure-native:awsconnector:MutualAuthentication": { "description": "Definition of MutualAuthentication", "properties": { "ignoreClientCertificateExpiry": { "type": "boolean", "description": "Indicates whether expired client certificates are ignored." }, "mode": { "type": "string", "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``." }, "trustStoreArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the trust store." } }, "type": "object" }, "azure-native:awsconnector:MutualAuthenticationResponse": { "description": "Definition of MutualAuthentication", "properties": { "ignoreClientCertificateExpiry": { "type": "boolean", "description": "Indicates whether expired client certificates are ignored." }, "mode": { "type": "string", "description": "The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``." }, "trustStoreArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the trust store." } }, "type": "object" }, "azure-native:awsconnector:NetworkBandwidthGbpsRequest": { "description": "Definition of NetworkBandwidthGbpsRequest", "properties": { "max": { "type": "integer", "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps)." }, "min": { "type": "integer", "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps)." } }, "type": "object" }, "azure-native:awsconnector:NetworkBandwidthGbpsRequestResponse": { "description": "Definition of NetworkBandwidthGbpsRequest", "properties": { "max": { "type": "integer", "description": "The maximum amount of network bandwidth, in gigabits per second (Gbps)." }, "min": { "type": "integer", "description": "The minimum amount of network bandwidth, in gigabits per second (Gbps)." } }, "type": "object" }, "azure-native:awsconnector:NetworkConfiguration": { "description": "Definition of NetworkConfiguration", "properties": { "awsvpcConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsVpcConfiguration", "description": "The VPC subnets and security groups that are associated with a task. All specified subnets and security groups must be from the same VPC. An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=['subnet-12344321'],securityGroups=['sg-12344321']}``" } }, "type": "object" }, "azure-native:awsconnector:NetworkConfigurationResponse": { "description": "Definition of NetworkConfiguration", "properties": { "awsvpcConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsVpcConfigurationResponse", "description": "The VPC subnets and security groups that are associated with a task. All specified subnets and security groups must be from the same VPC. An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=['subnet-12344321'],securityGroups=['sg-12344321']}``" } }, "type": "object" }, "azure-native:awsconnector:NetworkFirewallFirewallPolicyProperties": { "description": "Definition of NetworkFirewallFirewallPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsNetworkFirewallFirewallPolicyProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:NetworkFirewallFirewallPolicyPropertiesResponse": { "description": "Definition of NetworkFirewallFirewallPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsNetworkFirewallFirewallPolicyPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:NetworkFirewallFirewallProperties": { "description": "Definition of NetworkFirewallFirewall", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsNetworkFirewallFirewallProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:NetworkFirewallFirewallPropertiesResponse": { "description": "Definition of NetworkFirewallFirewall", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsNetworkFirewallFirewallPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:NetworkFirewallRuleGroupProperties": { "description": "Definition of NetworkFirewallRuleGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsNetworkFirewallRuleGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:NetworkFirewallRuleGroupPropertiesResponse": { "description": "Definition of NetworkFirewallRuleGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsNetworkFirewallRuleGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:NetworkInterfaceCountRequest": { "description": "Definition of NetworkInterfaceCountRequest", "properties": { "max": { "type": "integer", "description": "The maximum number of network interfaces." }, "min": { "type": "integer", "description": "The minimum number of network interfaces." } }, "type": "object" }, "azure-native:awsconnector:NetworkInterfaceCountRequestResponse": { "description": "Definition of NetworkInterfaceCountRequest", "properties": { "max": { "type": "integer", "description": "The maximum number of network interfaces." }, "min": { "type": "integer", "description": "The minimum number of network interfaces." } }, "type": "object" }, "azure-native:awsconnector:NetworkInterfaceStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "Associated", "description": "NetworkInterfaceStatus enum associated", "value": "associated" }, { "name": "Attaching", "description": "NetworkInterfaceStatus enum attaching", "value": "attaching" }, { "name": "Available", "description": "NetworkInterfaceStatus enum available", "value": "available" }, { "name": "Detaching", "description": "NetworkInterfaceStatus enum detaching", "value": "detaching" }, { "name": "InUse", "description": "NetworkInterfaceStatus enum in-use", "value": "in-use" } ] }, "azure-native:awsconnector:NetworkInterfaceStatusEnumValue": { "description": "Definition of NetworkInterfaceStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:NetworkInterfaceStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:NetworkInterfaceStatusEnumValueResponse": { "description": "Definition of NetworkInterfaceStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:NetworkOrigin": { "description": "Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies.", "type": "string", "enum": [ { "name": "Internet", "description": "NetworkOrigin enum Internet", "value": "Internet" }, { "name": "VPC", "description": "NetworkOrigin enum VPC", "value": "VPC" } ] }, "azure-native:awsconnector:Networking": { "description": "Definition of Networking", "properties": { "monthlyTransfer": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MonthlyTransfer", "description": "Monthly Transfer of the Instance." }, "ports": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Port" }, "description": "Ports to the Instance." } }, "type": "object" }, "azure-native:awsconnector:NetworkingResponse": { "description": "Definition of Networking", "properties": { "monthlyTransfer": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MonthlyTransferResponse", "description": "Monthly Transfer of the Instance." }, "ports": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortResponse" }, "description": "Ports to the Instance." } }, "type": "object" }, "azure-native:awsconnector:Node": { "description": "Definition of Node", "properties": { "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone (AZ) in which the node has been deployed.\u003c/p\u003e" }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DaxClusterEndpoint", "description": "\u003cp\u003eThe endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.\u003c/p\u003e" }, "nodeCreateTime": { "type": "string", "description": "\u003cp\u003eThe date and time (in UNIX epoch format) when the node was launched.\u003c/p\u003e" }, "nodeId": { "type": "string", "description": "\u003cp\u003eA system-generated identifier for the node.\u003c/p\u003e" }, "nodeStatus": { "type": "string", "description": "\u003cp\u003eThe current status of the node. For example: \u003ccode\u003eavailable\u003c/code\u003e.\u003c/p\u003e" }, "parameterGroupStatus": { "type": "string", "description": "\u003cp\u003eThe status of the parameter group associated with this node. For example, \u003ccode\u003ein-sync\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:NodeResponse": { "description": "Definition of Node", "properties": { "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone (AZ) in which the node has been deployed.\u003c/p\u003e" }, "endpoint": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DaxClusterEndpointResponse", "description": "\u003cp\u003eThe endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.\u003c/p\u003e" }, "nodeCreateTime": { "type": "string", "description": "\u003cp\u003eThe date and time (in UNIX epoch format) when the node was launched.\u003c/p\u003e" }, "nodeId": { "type": "string", "description": "\u003cp\u003eA system-generated identifier for the node.\u003c/p\u003e" }, "nodeStatus": { "type": "string", "description": "\u003cp\u003eThe current status of the node. For example: \u003ccode\u003eavailable\u003c/code\u003e.\u003c/p\u003e" }, "parameterGroupStatus": { "type": "string", "description": "\u003cp\u003eThe status of the parameter group associated with this node. For example, \u003ccode\u003ein-sync\u003c/code\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:NodeToNodeEncryptionOptions": { "description": "Definition of NodeToNodeEncryptionOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue to enable node-to-node encryption.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:NodeToNodeEncryptionOptionsResponse": { "description": "Definition of NodeToNodeEncryptionOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue to enable node-to-node encryption.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:NonCompliantSummary": { "description": "Definition of NonCompliantSummary", "properties": { "nonCompliantCount": { "type": "integer", "description": "\u003cp\u003eThe total number of compliance items that aren't compliant.\u003c/p\u003e" }, "severitySummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SeveritySummary", "description": "\u003cp\u003eA summary of the non-compliance severity by compliance type\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:NonCompliantSummaryResponse": { "description": "Definition of NonCompliantSummary", "properties": { "nonCompliantCount": { "type": "integer", "description": "\u003cp\u003eThe total number of compliance items that aren't compliant.\u003c/p\u003e" }, "severitySummary": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SeveritySummaryResponse", "description": "\u003cp\u003eA summary of the non-compliance severity by compliance type\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:NoncurrentVersionExpiration": { "description": "Definition of NoncurrentVersionExpiration", "properties": { "newerNoncurrentVersions": { "type": "integer", "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." }, "noncurrentDays": { "type": "integer", "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*." } }, "type": "object" }, "azure-native:awsconnector:NoncurrentVersionExpirationResponse": { "description": "Definition of NoncurrentVersionExpiration", "properties": { "newerNoncurrentVersions": { "type": "integer", "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." }, "noncurrentDays": { "type": "integer", "description": "Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*." } }, "type": "object" }, "azure-native:awsconnector:NoncurrentVersionTransition": { "description": "Definition of NoncurrentVersionTransition", "properties": { "newerNoncurrentVersions": { "type": "integer", "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." }, "storageClass": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionTransitionStorageClass" } ], "description": "The class of storage used to store the object." }, "transitionInDays": { "type": "integer", "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*." } }, "type": "object" }, "azure-native:awsconnector:NoncurrentVersionTransitionResponse": { "description": "Definition of NoncurrentVersionTransition", "properties": { "newerNoncurrentVersions": { "type": "integer", "description": "Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*." }, "storageClass": { "type": "string", "description": "The class of storage used to store the object." }, "transitionInDays": { "type": "integer", "description": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*." } }, "type": "object" }, "azure-native:awsconnector:NoncurrentVersionTransitionStorageClass": { "description": "The class of storage used to store the object.", "type": "string", "enum": [ { "name": "DEEP_ARCHIVE", "description": "NoncurrentVersionTransitionStorageClass enum DEEP_ARCHIVE", "value": "DEEP_ARCHIVE" }, { "name": "GLACIER", "description": "NoncurrentVersionTransitionStorageClass enum GLACIER", "value": "GLACIER" }, { "name": "GLACIER_IR", "description": "NoncurrentVersionTransitionStorageClass enum GLACIER_IR", "value": "GLACIER_IR" }, { "name": "INTELLIGENT_TIERING", "description": "NoncurrentVersionTransitionStorageClass enum INTELLIGENT_TIERING", "value": "INTELLIGENT_TIERING" }, { "name": "ONEZONE_IA", "description": "NoncurrentVersionTransitionStorageClass enum ONEZONE_IA", "value": "ONEZONE_IA" }, { "name": "STANDARD_IA", "description": "NoncurrentVersionTransitionStorageClass enum STANDARD_IA", "value": "STANDARD_IA" } ] }, "azure-native:awsconnector:NotebookInstanceStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "Deleting", "description": "NotebookInstanceStatus enum Deleting", "value": "Deleting" }, { "name": "Failed", "description": "NotebookInstanceStatus enum Failed", "value": "Failed" }, { "name": "InService", "description": "NotebookInstanceStatus enum InService", "value": "InService" }, { "name": "Pending", "description": "NotebookInstanceStatus enum Pending", "value": "Pending" }, { "name": "Stopped", "description": "NotebookInstanceStatus enum Stopped", "value": "Stopped" }, { "name": "Stopping", "description": "NotebookInstanceStatus enum Stopping", "value": "Stopping" }, { "name": "Updating", "description": "NotebookInstanceStatus enum Updating", "value": "Updating" } ] }, "azure-native:awsconnector:NotebookInstanceStatusEnumValue": { "description": "Definition of NotebookInstanceStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:NotebookInstanceStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:NotebookInstanceStatusEnumValueResponse": { "description": "Definition of NotebookInstanceStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:NotificationConfiguration": { "description": "Definition of NotificationConfiguration", "properties": { "eventBridgeConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EventBridgeConfiguration", "description": "Enables delivery of events to Amazon EventBridge. Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*. Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*" }, "lambdaConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaConfiguration" }, "description": "Describes the LAMlong functions to invoke and the events for which to invoke them." }, "queueConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:QueueConfiguration" }, "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages." }, "topicConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TopicConfiguration" }, "description": "The topic to which notifications are sent and the events for which notifications are generated." } }, "type": "object" }, "azure-native:awsconnector:NotificationConfigurationResponse": { "description": "Definition of NotificationConfiguration", "properties": { "eventBridgeConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EventBridgeConfigurationResponse", "description": "Enables delivery of events to Amazon EventBridge. Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*. Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide*" }, "lambdaConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LambdaConfigurationResponse" }, "description": "Describes the LAMlong functions to invoke and the events for which to invoke them." }, "queueConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:QueueConfigurationResponse" }, "description": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages." }, "topicConfigurations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TopicConfigurationResponse" }, "description": "The topic to which notifications are sent and the events for which notifications are generated." } }, "type": "object" }, "azure-native:awsconnector:NotificationFilter": { "description": "Definition of NotificationFilter", "properties": { "s3Key": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3KeyFilter", "description": "A container for object key name prefix and suffix filtering rules. A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules." } }, "type": "object" }, "azure-native:awsconnector:NotificationFilterResponse": { "description": "Definition of NotificationFilter", "properties": { "s3Key": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3KeyFilterResponse", "description": "A container for object key name prefix and suffix filtering rules. A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules." } }, "type": "object" }, "azure-native:awsconnector:OIDC": { "description": "Definition of OIDC", "properties": { "issuer": { "type": "string", "description": "\u003cp\u003eThe issuer URL for the OIDC identity provider.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OIDCResponse": { "description": "Definition of OIDC", "properties": { "issuer": { "type": "string", "description": "\u003cp\u003eThe issuer URL for the OIDC identity provider.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ObjectLockConfiguration": { "description": "Definition of ObjectLockConfiguration", "properties": { "objectLockEnabled": { "type": "string", "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." }, "rule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ObjectLockRule", "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket." } }, "type": "object" }, "azure-native:awsconnector:ObjectLockConfigurationResponse": { "description": "Definition of ObjectLockConfiguration", "properties": { "objectLockEnabled": { "type": "string", "description": "Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket." }, "rule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ObjectLockRuleResponse", "description": "Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket." } }, "type": "object" }, "azure-native:awsconnector:ObjectLockRule": { "description": "Definition of ObjectLockRule", "properties": { "defaultRetention": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DefaultRetention", "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time." } }, "type": "object" }, "azure-native:awsconnector:ObjectLockRuleResponse": { "description": "Definition of ObjectLockRule", "properties": { "defaultRetention": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DefaultRetentionResponse", "description": "The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time." } }, "type": "object" }, "azure-native:awsconnector:OffPeakWindow": { "description": "Definition of OffPeakWindow", "properties": { "windowStartTime": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WindowStartTime", "description": "\u003cp\u003eA custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OffPeakWindowOptions": { "description": "Definition of OffPeakWindowOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable an off-peak window.\u003c/p\u003e \u003cp\u003eThis option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.\u003c/p\u003e" }, "offPeakWindow": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OffPeakWindow", "description": "\u003cp\u003eOff-peak window settings for the domain.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OffPeakWindowOptionsResponse": { "description": "Definition of OffPeakWindowOptions", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eWhether to enable an off-peak window.\u003c/p\u003e \u003cp\u003eThis option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.\u003c/p\u003e" }, "offPeakWindow": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OffPeakWindowResponse", "description": "\u003cp\u003eOff-peak window settings for the domain.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OffPeakWindowResponse": { "description": "Definition of OffPeakWindow", "properties": { "windowStartTime": { "type": "object", "$ref": "#/types/azure-native:awsconnector:WindowStartTimeResponse", "description": "\u003cp\u003eA custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OpenIDConnectConfig": { "description": "Definition of OpenIDConnectConfig", "properties": { "authTTL": { "type": "number", "description": "\u003cp\u003eThe number of milliseconds that a token is valid after being authenticated.\u003c/p\u003e" }, "clientId": { "type": "string", "description": "\u003cp\u003eThe 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 that AppSync can validate against multiple client identifiers at a time.\u003c/p\u003e" }, "iatTTL": { "type": "number", "description": "\u003cp\u003eThe number of milliseconds that a token is valid after it's issued to a user.\u003c/p\u003e" }, "issuer": { "type": "string", "description": "\u003cp\u003eThe issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of \u003ccode\u003eiss\u003c/code\u003e in the ID token.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OpenIDConnectConfigResponse": { "description": "Definition of OpenIDConnectConfig", "properties": { "authTTL": { "type": "number", "description": "\u003cp\u003eThe number of milliseconds that a token is valid after being authenticated.\u003c/p\u003e" }, "clientId": { "type": "string", "description": "\u003cp\u003eThe 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 that AppSync can validate against multiple client identifiers at a time.\u003c/p\u003e" }, "iatTTL": { "type": "number", "description": "\u003cp\u003eThe number of milliseconds that a token is valid after it's issued to a user.\u003c/p\u003e" }, "issuer": { "type": "string", "description": "\u003cp\u003eThe issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of \u003ccode\u003eiss\u003c/code\u003e in the ID token.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OpenSearchDomainStatusProperties": { "description": "Definition of OpenSearchDomainStatus", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsOpenSearchDomainStatusProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:OpenSearchDomainStatusPropertiesResponse": { "description": "Definition of OpenSearchDomainStatus", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsOpenSearchDomainStatusPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:OpenSearchPartitionInstanceType": { "description": "Property value", "type": "string", "enum": [ { "name": "C42xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c4.2xlarge.search", "value": "c4.2xlarge.search" }, { "name": "C44xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c4.4xlarge.search", "value": "c4.4xlarge.search" }, { "name": "C48xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c4.8xlarge.search", "value": "c4.8xlarge.search" }, { "name": "C4LargeSearch", "description": "OpenSearchPartitionInstanceType enum c4.large.search", "value": "c4.large.search" }, { "name": "C4XlargeSearch", "description": "OpenSearchPartitionInstanceType enum c4.xlarge.search", "value": "c4.xlarge.search" }, { "name": "C518xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c5.18xlarge.search", "value": "c5.18xlarge.search" }, { "name": "C52xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c5.2xlarge.search", "value": "c5.2xlarge.search" }, { "name": "C54xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c5.4xlarge.search", "value": "c5.4xlarge.search" }, { "name": "C59xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c5.9xlarge.search", "value": "c5.9xlarge.search" }, { "name": "C5LargeSearch", "description": "OpenSearchPartitionInstanceType enum c5.large.search", "value": "c5.large.search" }, { "name": "C5XlargeSearch", "description": "OpenSearchPartitionInstanceType enum c5.xlarge.search", "value": "c5.xlarge.search" }, { "name": "C6g12xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c6g.12xlarge.search", "value": "c6g.12xlarge.search" }, { "name": "C6g2xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c6g.2xlarge.search", "value": "c6g.2xlarge.search" }, { "name": "C6g4xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c6g.4xlarge.search", "value": "c6g.4xlarge.search" }, { "name": "C6g8xlargeSearch", "description": "OpenSearchPartitionInstanceType enum c6g.8xlarge.search", "value": "c6g.8xlarge.search" }, { "name": "C6gLargeSearch", "description": "OpenSearchPartitionInstanceType enum c6g.large.search", "value": "c6g.large.search" }, { "name": "C6gXlargeSearch", "description": "OpenSearchPartitionInstanceType enum c6g.xlarge.search", "value": "c6g.xlarge.search" }, { "name": "D22xlargeSearch", "description": "OpenSearchPartitionInstanceType enum d2.2xlarge.search", "value": "d2.2xlarge.search" }, { "name": "D24xlargeSearch", "description": "OpenSearchPartitionInstanceType enum d2.4xlarge.search", "value": "d2.4xlarge.search" }, { "name": "D28xlargeSearch", "description": "OpenSearchPartitionInstanceType enum d2.8xlarge.search", "value": "d2.8xlarge.search" }, { "name": "D2XlargeSearch", "description": "OpenSearchPartitionInstanceType enum d2.xlarge.search", "value": "d2.xlarge.search" }, { "name": "I22xlargeSearch", "description": "OpenSearchPartitionInstanceType enum i2.2xlarge.search", "value": "i2.2xlarge.search" }, { "name": "I2XlargeSearch", "description": "OpenSearchPartitionInstanceType enum i2.xlarge.search", "value": "i2.xlarge.search" }, { "name": "I316xlargeSearch", "description": "OpenSearchPartitionInstanceType enum i3.16xlarge.search", "value": "i3.16xlarge.search" }, { "name": "I32xlargeSearch", "description": "OpenSearchPartitionInstanceType enum i3.2xlarge.search", "value": "i3.2xlarge.search" }, { "name": "I34xlargeSearch", "description": "OpenSearchPartitionInstanceType enum i3.4xlarge.search", "value": "i3.4xlarge.search" }, { "name": "I38xlargeSearch", "description": "OpenSearchPartitionInstanceType enum i3.8xlarge.search", "value": "i3.8xlarge.search" }, { "name": "I3LargeSearch", "description": "OpenSearchPartitionInstanceType enum i3.large.search", "value": "i3.large.search" }, { "name": "I3XlargeSearch", "description": "OpenSearchPartitionInstanceType enum i3.xlarge.search", "value": "i3.xlarge.search" }, { "name": "M32xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m3.2xlarge.search", "value": "m3.2xlarge.search" }, { "name": "M3LargeSearch", "description": "OpenSearchPartitionInstanceType enum m3.large.search", "value": "m3.large.search" }, { "name": "M3MediumSearch", "description": "OpenSearchPartitionInstanceType enum m3.medium.search", "value": "m3.medium.search" }, { "name": "M3XlargeSearch", "description": "OpenSearchPartitionInstanceType enum m3.xlarge.search", "value": "m3.xlarge.search" }, { "name": "M410xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m4.10xlarge.search", "value": "m4.10xlarge.search" }, { "name": "M42xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m4.2xlarge.search", "value": "m4.2xlarge.search" }, { "name": "M44xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m4.4xlarge.search", "value": "m4.4xlarge.search" }, { "name": "M4LargeSearch", "description": "OpenSearchPartitionInstanceType enum m4.large.search", "value": "m4.large.search" }, { "name": "M4XlargeSearch", "description": "OpenSearchPartitionInstanceType enum m4.xlarge.search", "value": "m4.xlarge.search" }, { "name": "M512xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m5.12xlarge.search", "value": "m5.12xlarge.search" }, { "name": "M524xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m5.24xlarge.search", "value": "m5.24xlarge.search" }, { "name": "M52xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m5.2xlarge.search", "value": "m5.2xlarge.search" }, { "name": "M54xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m5.4xlarge.search", "value": "m5.4xlarge.search" }, { "name": "M5LargeSearch", "description": "OpenSearchPartitionInstanceType enum m5.large.search", "value": "m5.large.search" }, { "name": "M5XlargeSearch", "description": "OpenSearchPartitionInstanceType enum m5.xlarge.search", "value": "m5.xlarge.search" }, { "name": "M6g12xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m6g.12xlarge.search", "value": "m6g.12xlarge.search" }, { "name": "M6g2xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m6g.2xlarge.search", "value": "m6g.2xlarge.search" }, { "name": "M6g4xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m6g.4xlarge.search", "value": "m6g.4xlarge.search" }, { "name": "M6g8xlargeSearch", "description": "OpenSearchPartitionInstanceType enum m6g.8xlarge.search", "value": "m6g.8xlarge.search" }, { "name": "M6gLargeSearch", "description": "OpenSearchPartitionInstanceType enum m6g.large.search", "value": "m6g.large.search" }, { "name": "M6gXlargeSearch", "description": "OpenSearchPartitionInstanceType enum m6g.xlarge.search", "value": "m6g.xlarge.search" }, { "name": "Or112xlargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.12xlarge.search", "value": "or1.12xlarge.search" }, { "name": "Or116xlargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.16xlarge.search", "value": "or1.16xlarge.search" }, { "name": "Or12xlargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.2xlarge.search", "value": "or1.2xlarge.search" }, { "name": "Or14xlargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.4xlarge.search", "value": "or1.4xlarge.search" }, { "name": "Or18xlargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.8xlarge.search", "value": "or1.8xlarge.search" }, { "name": "Or1LargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.large.search", "value": "or1.large.search" }, { "name": "Or1MediumSearch", "description": "OpenSearchPartitionInstanceType enum or1.medium.search", "value": "or1.medium.search" }, { "name": "Or1XlargeSearch", "description": "OpenSearchPartitionInstanceType enum or1.xlarge.search", "value": "or1.xlarge.search" }, { "name": "R32xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r3.2xlarge.search", "value": "r3.2xlarge.search" }, { "name": "R34xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r3.4xlarge.search", "value": "r3.4xlarge.search" }, { "name": "R38xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r3.8xlarge.search", "value": "r3.8xlarge.search" }, { "name": "R3LargeSearch", "description": "OpenSearchPartitionInstanceType enum r3.large.search", "value": "r3.large.search" }, { "name": "R3XlargeSearch", "description": "OpenSearchPartitionInstanceType enum r3.xlarge.search", "value": "r3.xlarge.search" }, { "name": "R416xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r4.16xlarge.search", "value": "r4.16xlarge.search" }, { "name": "R42xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r4.2xlarge.search", "value": "r4.2xlarge.search" }, { "name": "R44xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r4.4xlarge.search", "value": "r4.4xlarge.search" }, { "name": "R48xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r4.8xlarge.search", "value": "r4.8xlarge.search" }, { "name": "R4LargeSearch", "description": "OpenSearchPartitionInstanceType enum r4.large.search", "value": "r4.large.search" }, { "name": "R4XlargeSearch", "description": "OpenSearchPartitionInstanceType enum r4.xlarge.search", "value": "r4.xlarge.search" }, { "name": "R512xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r5.12xlarge.search", "value": "r5.12xlarge.search" }, { "name": "R524xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r5.24xlarge.search", "value": "r5.24xlarge.search" }, { "name": "R52xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r5.2xlarge.search", "value": "r5.2xlarge.search" }, { "name": "R54xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r5.4xlarge.search", "value": "r5.4xlarge.search" }, { "name": "R5LargeSearch", "description": "OpenSearchPartitionInstanceType enum r5.large.search", "value": "r5.large.search" }, { "name": "R5XlargeSearch", "description": "OpenSearchPartitionInstanceType enum r5.xlarge.search", "value": "r5.xlarge.search" }, { "name": "R6g12xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6g.12xlarge.search", "value": "r6g.12xlarge.search" }, { "name": "R6g2xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6g.2xlarge.search", "value": "r6g.2xlarge.search" }, { "name": "R6g4xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6g.4xlarge.search", "value": "r6g.4xlarge.search" }, { "name": "R6g8xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6g.8xlarge.search", "value": "r6g.8xlarge.search" }, { "name": "R6gLargeSearch", "description": "OpenSearchPartitionInstanceType enum r6g.large.search", "value": "r6g.large.search" }, { "name": "R6gXlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6g.xlarge.search", "value": "r6g.xlarge.search" }, { "name": "R6gd12xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.12xlarge.search", "value": "r6gd.12xlarge.search" }, { "name": "R6gd16xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.16xlarge.search", "value": "r6gd.16xlarge.search" }, { "name": "R6gd2xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.2xlarge.search", "value": "r6gd.2xlarge.search" }, { "name": "R6gd4xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.4xlarge.search", "value": "r6gd.4xlarge.search" }, { "name": "R6gd8xlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.8xlarge.search", "value": "r6gd.8xlarge.search" }, { "name": "R6gdLargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.large.search", "value": "r6gd.large.search" }, { "name": "R6gdXlargeSearch", "description": "OpenSearchPartitionInstanceType enum r6gd.xlarge.search", "value": "r6gd.xlarge.search" }, { "name": "T2MediumSearch", "description": "OpenSearchPartitionInstanceType enum t2.medium.search", "value": "t2.medium.search" }, { "name": "T2MicroSearch", "description": "OpenSearchPartitionInstanceType enum t2.micro.search", "value": "t2.micro.search" }, { "name": "T2SmallSearch", "description": "OpenSearchPartitionInstanceType enum t2.small.search", "value": "t2.small.search" }, { "name": "T32xlargeSearch", "description": "OpenSearchPartitionInstanceType enum t3.2xlarge.search", "value": "t3.2xlarge.search" }, { "name": "T3LargeSearch", "description": "OpenSearchPartitionInstanceType enum t3.large.search", "value": "t3.large.search" }, { "name": "T3MediumSearch", "description": "OpenSearchPartitionInstanceType enum t3.medium.search", "value": "t3.medium.search" }, { "name": "T3MicroSearch", "description": "OpenSearchPartitionInstanceType enum t3.micro.search", "value": "t3.micro.search" }, { "name": "T3NanoSearch", "description": "OpenSearchPartitionInstanceType enum t3.nano.search", "value": "t3.nano.search" }, { "name": "T3SmallSearch", "description": "OpenSearchPartitionInstanceType enum t3.small.search", "value": "t3.small.search" }, { "name": "T3XlargeSearch", "description": "OpenSearchPartitionInstanceType enum t3.xlarge.search", "value": "t3.xlarge.search" }, { "name": "T4gMediumSearch", "description": "OpenSearchPartitionInstanceType enum t4g.medium.search", "value": "t4g.medium.search" }, { "name": "T4gSmallSearch", "description": "OpenSearchPartitionInstanceType enum t4g.small.search", "value": "t4g.small.search" }, { "name": "Ultrawarm1LargeSearch", "description": "OpenSearchPartitionInstanceType enum ultrawarm1.large.search", "value": "ultrawarm1.large.search" }, { "name": "Ultrawarm1MediumSearch", "description": "OpenSearchPartitionInstanceType enum ultrawarm1.medium.search", "value": "ultrawarm1.medium.search" }, { "name": "Ultrawarm1XlargeSearch", "description": "OpenSearchPartitionInstanceType enum ultrawarm1.xlarge.search", "value": "ultrawarm1.xlarge.search" } ] }, "azure-native:awsconnector:OpenSearchPartitionInstanceTypeEnumValue": { "description": "Definition of OpenSearchPartitionInstanceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:OpenSearchPartitionInstanceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:OpenSearchPartitionInstanceTypeEnumValueResponse": { "description": "Definition of OpenSearchPartitionInstanceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:OpenSearchWarmPartitionInstanceType": { "description": "Property value", "type": "string", "enum": [ { "name": "Ultrawarm1LargeSearch", "description": "OpenSearchWarmPartitionInstanceType enum ultrawarm1.large.search", "value": "ultrawarm1.large.search" }, { "name": "Ultrawarm1MediumSearch", "description": "OpenSearchWarmPartitionInstanceType enum ultrawarm1.medium.search", "value": "ultrawarm1.medium.search" }, { "name": "Ultrawarm1XlargeSearch", "description": "OpenSearchWarmPartitionInstanceType enum ultrawarm1.xlarge.search", "value": "ultrawarm1.xlarge.search" } ] }, "azure-native:awsconnector:OpenSearchWarmPartitionInstanceTypeEnumValue": { "description": "Definition of OpenSearchWarmPartitionInstanceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:OpenSearchWarmPartitionInstanceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:OpenSearchWarmPartitionInstanceTypeEnumValueResponse": { "description": "Definition of OpenSearchWarmPartitionInstanceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:OperationLevelMetricsConfig": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "OperationLevelMetricsConfig enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "OperationLevelMetricsConfig enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:OperationLevelMetricsConfigEnumValue": { "description": "Definition of OperationLevelMetricsConfigEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:OperationLevelMetricsConfig" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:OperationLevelMetricsConfigEnumValueResponse": { "description": "Definition of OperationLevelMetricsConfigEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:OperationPreferences": { "description": "Definition of OperationPreferences", "properties": { "failureToleranceCount": { "type": "integer", "description": "Property failureToleranceCount" }, "failureTolerancePercentage": { "type": "integer", "description": "Property failureTolerancePercentage" }, "maxConcurrentCount": { "type": "integer", "description": "Property maxConcurrentCount" }, "maxConcurrentPercentage": { "type": "integer", "description": "Property maxConcurrentPercentage" }, "regionConcurrencyType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:OperationPreferencesRegionConcurrencyType" } ], "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time" }, "regionOrder": { "type": "array", "items": { "type": "string" }, "description": "Property regionOrder" } }, "type": "object" }, "azure-native:awsconnector:OperationPreferencesRegionConcurrencyType": { "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time", "type": "string", "enum": [ { "name": "PARALLEL", "description": "OperationPreferencesRegionConcurrencyType enum PARALLEL", "value": "PARALLEL" }, { "name": "SEQUENTIAL", "description": "OperationPreferencesRegionConcurrencyType enum SEQUENTIAL", "value": "SEQUENTIAL" } ] }, "azure-native:awsconnector:OperationPreferencesResponse": { "description": "Definition of OperationPreferences", "properties": { "failureToleranceCount": { "type": "integer", "description": "Property failureToleranceCount" }, "failureTolerancePercentage": { "type": "integer", "description": "Property failureTolerancePercentage" }, "maxConcurrentCount": { "type": "integer", "description": "Property maxConcurrentCount" }, "maxConcurrentPercentage": { "type": "integer", "description": "Property maxConcurrentPercentage" }, "regionConcurrencyType": { "type": "string", "description": "The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time" }, "regionOrder": { "type": "array", "items": { "type": "string" }, "description": "Property regionOrder" } }, "type": "object" }, "azure-native:awsconnector:OptionSetting": { "description": "Definition of OptionSetting", "properties": { "namespace": { "type": "string", "description": "A unique namespace that identifies the option's associated AWS resource." }, "optionName": { "type": "string", "description": "The name of the configuration option." }, "resourceName": { "type": "string", "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." }, "value": { "type": "string", "description": "The current value for the configuration option." } }, "type": "object" }, "azure-native:awsconnector:OptionSettingResponse": { "description": "Definition of OptionSetting", "properties": { "namespace": { "type": "string", "description": "A unique namespace that identifies the option's associated AWS resource." }, "optionName": { "type": "string", "description": "The name of the configuration option." }, "resourceName": { "type": "string", "description": "A unique resource name for the option setting. Use it for a time–based scaling configuration option." }, "value": { "type": "string", "description": "The current value for the configuration option." } }, "type": "object" }, "azure-native:awsconnector:OrganizationsAccountProperties": { "description": "Definition of OrganizationsAccount", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsOrganizationsAccountProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:OrganizationsAccountPropertiesResponse": { "description": "Definition of OrganizationsAccount", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsOrganizationsAccountPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:OrganizationsOrganizationProperties": { "description": "Definition of OrganizationsOrganization", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsOrganizationsOrganizationProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:OrganizationsOrganizationPropertiesResponse": { "description": "Definition of OrganizationsOrganization", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsOrganizationsOrganizationPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Origin": { "description": "The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values.", "type": "string", "enum": [ { "name": "AWS_KMS", "description": "Origin enum AWS_KMS", "value": "AWS_KMS" }, { "name": "EXTERNAL", "description": "Origin enum EXTERNAL", "value": "EXTERNAL" } ] }, "azure-native:awsconnector:OriginCustomHeaderResponse": { "description": "Definition of OriginCustomHeader", "properties": { "headerName": { "type": "string", "description": "The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*." }, "headerValue": { "type": "string", "description": "The value for the header that you specified in the ``HeaderName`` field." } }, "type": "object" }, "azure-native:awsconnector:OriginGroup": { "description": "Definition of OriginGroup", "properties": { "failoverCriteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupFailoverCriteria", "description": "A complex type that contains information about the failover criteria for an origin group. A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin." }, "id": { "type": "string", "description": "The origin group's ID." }, "members": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupMembers", "description": "A complex type that contains information about the origins in an origin group. A complex data type for the origins included in an origin group." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupFailoverCriteria": { "description": "Definition of OriginGroupFailoverCriteria", "properties": { "statusCodes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusCodes", "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupFailoverCriteriaResponse": { "description": "Definition of OriginGroupFailoverCriteria", "properties": { "statusCodes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatusCodesResponse", "description": "The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupMember": { "description": "Definition of OriginGroupMember", "properties": { "originId": { "type": "string", "description": "The ID for an origin in an origin group." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupMemberResponse": { "description": "Definition of OriginGroupMember", "properties": { "originId": { "type": "string", "description": "The ID for an origin in an origin group." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupMembers": { "description": "Definition of OriginGroupMembers", "properties": { "items": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupMember" }, "description": "Items (origins) in an origin group." }, "quantity": { "type": "integer", "description": "The number of origins in an origin group." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupMembersResponse": { "description": "Definition of OriginGroupMembers", "properties": { "items": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupMemberResponse" }, "description": "Items (origins) in an origin group." }, "quantity": { "type": "integer", "description": "The number of origins in an origin group." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupResponse": { "description": "Definition of OriginGroup", "properties": { "failoverCriteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupFailoverCriteriaResponse", "description": "A complex type that contains information about the failover criteria for an origin group. A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin." }, "id": { "type": "string", "description": "The origin group's ID." }, "members": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupMembersResponse", "description": "A complex type that contains information about the origins in an origin group. A complex data type for the origins included in an origin group." } }, "type": "object" }, "azure-native:awsconnector:OriginGroups": { "description": "Definition of OriginGroups", "properties": { "items": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroup" }, "description": "The items (origin groups) in a distribution." }, "quantity": { "type": "integer", "description": "The number of origin groups." } }, "type": "object" }, "azure-native:awsconnector:OriginGroupsResponse": { "description": "Definition of OriginGroups", "properties": { "items": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginGroupResponse" }, "description": "The items (origin groups) in a distribution." }, "quantity": { "type": "integer", "description": "The number of origin groups." } }, "type": "object" }, "azure-native:awsconnector:OriginResponse": { "description": "Definition of Origin", "properties": { "connectionAttempts": { "type": "integer", "description": "The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout). For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*." }, "connectionTimeout": { "type": "integer", "description": "The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*." }, "customOriginConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CustomOriginConfigResponse", "description": "Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead. A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin." }, "domainName": { "type": "string", "description": "The domain name for the origin. For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*." }, "id": { "type": "string", "description": "A unique identifier for the origin. This value must be unique within the distribution. Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``." }, "originAccessControlId": { "type": "string", "description": "The unique identifier of an origin access control for this origin. For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*." }, "originCustomHeaders": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginCustomHeaderResponse" }, "description": "A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*." }, "originPath": { "type": "string", "description": "An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*." }, "originShield": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OriginShieldResponse", "description": "CloudFront Origin Shield. 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*. CloudFront Origin Shield. 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*." }, "s3OriginConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:S3OriginConfigResponse", "description": "Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead. A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead." } }, "type": "object" }, "azure-native:awsconnector:OriginShieldResponse": { "description": "Definition of OriginShield", "properties": { "enabled": { "type": "boolean", "description": "A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches." }, "originShieldRegion": { "type": "string", "description": "The AWS-Region for Origin Shield. Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:OutpostConfigResponse": { "description": "Definition of OutpostConfigResponse", "properties": { "controlPlaneInstanceType": { "type": "string", "description": "\u003cp\u003eThe Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.\u003c/p\u003e" }, "controlPlanePlacement": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ControlPlanePlacementResponse", "description": "\u003cp\u003eAn object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html'\u003eCapacity considerations\u003c/a\u003e in the \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e.\u003c/p\u003e" }, "outpostArns": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OutpostConfigResponseResponse": { "description": "Definition of OutpostConfigResponse", "properties": { "controlPlaneInstanceType": { "type": "string", "description": "\u003cp\u003eThe Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.\u003c/p\u003e" }, "controlPlanePlacement": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ControlPlanePlacementResponseResponse", "description": "\u003cp\u003eAn object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see \u003ca href='https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-capacity-considerations.html'\u003eCapacity considerations\u003c/a\u003e in the \u003ci\u003eAmazon EKS User Guide\u003c/i\u003e.\u003c/p\u003e" }, "outpostArns": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Output": { "description": "Definition of Output", "properties": { "description": { "type": "string", "description": "Property description" }, "exportName": { "type": "string", "description": "Property exportName" }, "outputKey": { "type": "string", "description": "Property outputKey" }, "outputValue": { "type": "string", "description": "Property outputValue" } }, "type": "object" }, "azure-native:awsconnector:OutputResponse": { "description": "Definition of Output", "properties": { "description": { "type": "string", "description": "Property description" }, "exportName": { "type": "string", "description": "Property exportName" }, "outputKey": { "type": "string", "description": "Property outputKey" }, "outputValue": { "type": "string", "description": "Property outputValue" } }, "type": "object" }, "azure-native:awsconnector:Owner": { "description": "Definition of Owner", "properties": { "displayName": { "type": "string", "description": "\u003cp\u003eContainer for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eUS East (N. Virginia)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eUS West (N. California)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eUS West (Oregon)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Singapore)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Sydney)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Tokyo)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Ireland)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eSouth America (São Paulo)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eThis functionality is not supported for directory buckets.\u003c/p\u003e \u003c/note\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eContainer for the ID of the owner.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OwnerResponse": { "description": "Definition of Owner", "properties": { "displayName": { "type": "string", "description": "\u003cp\u003eContainer for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eUS East (N. Virginia)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eUS West (N. California)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eUS West (Oregon)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Singapore)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Sydney)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Tokyo)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Ireland)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eSouth America (São Paulo)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eThis functionality is not supported for directory buckets.\u003c/p\u003e \u003c/note\u003e" }, "id": { "type": "string", "description": "\u003cp\u003eContainer for the ID of the owner.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:OwnershipControls": { "description": "Definition of OwnershipControls", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OwnershipControlsRule" }, "description": "Specifies the container element for Object Ownership rules." } }, "type": "object" }, "azure-native:awsconnector:OwnershipControlsResponse": { "description": "Definition of OwnershipControls", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:OwnershipControlsRuleResponse" }, "description": "Specifies the container element for Object Ownership rules." } }, "type": "object" }, "azure-native:awsconnector:OwnershipControlsRule": { "description": "Definition of OwnershipControlsRule", "properties": { "objectOwnership": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:OwnershipControlsRuleObjectOwnership" } ], "description": "Specifies an object ownership rule." } }, "type": "object" }, "azure-native:awsconnector:OwnershipControlsRuleObjectOwnership": { "description": "Specifies an object ownership rule.", "type": "string", "enum": [ { "name": "BucketOwnerEnforced", "description": "OwnershipControlsRuleObjectOwnership enum BucketOwnerEnforced", "value": "BucketOwnerEnforced" }, { "name": "BucketOwnerPreferred", "description": "OwnershipControlsRuleObjectOwnership enum BucketOwnerPreferred", "value": "BucketOwnerPreferred" }, { "name": "ObjectWriter", "description": "OwnershipControlsRuleObjectOwnership enum ObjectWriter", "value": "ObjectWriter" } ] }, "azure-native:awsconnector:OwnershipControlsRuleResponse": { "description": "Definition of OwnershipControlsRule", "properties": { "objectOwnership": { "type": "string", "description": "Specifies an object ownership rule." } }, "type": "object" }, "azure-native:awsconnector:PackageType": { "description": "The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive.", "type": "string", "enum": [ { "name": "Image", "description": "PackageType enum Image", "value": "Image" }, { "name": "Zip", "description": "PackageType enum Zip", "value": "Zip" } ] }, "azure-native:awsconnector:Parameter": { "description": "Definition of Parameter", "properties": { "parameterKey": { "type": "string", "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template." }, "parameterName": { "type": "string", "description": "The name of the parameter." }, "parameterValue": { "type": "string", "description": "The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters." } }, "type": "object" }, "azure-native:awsconnector:ParameterGroupStatus": { "description": "Definition of ParameterGroupStatus", "properties": { "nodeIdsToReboot": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe node IDs of one or more nodes to be rebooted.\u003c/p\u003e" }, "parameterApplyStatus": { "type": "string", "description": "\u003cp\u003eThe status of parameter updates. \u003c/p\u003e" }, "parameterGroupName": { "type": "string", "description": "\u003cp\u003eThe name of the parameter group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ParameterGroupStatusResponse": { "description": "Definition of ParameterGroupStatus", "properties": { "nodeIdsToReboot": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe node IDs of one or more nodes to be rebooted.\u003c/p\u003e" }, "parameterApplyStatus": { "type": "string", "description": "\u003cp\u003eThe status of parameter updates. \u003c/p\u003e" }, "parameterGroupName": { "type": "string", "description": "\u003cp\u003eThe name of the parameter group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ParameterResponse": { "description": "Definition of Parameter", "properties": { "parameterKey": { "type": "string", "description": "The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template." }, "parameterValue": { "type": "string", "description": "The input value associated with the parameter." } }, "type": "object" }, "azure-native:awsconnector:ParameterResponseV1": { "description": "Definition of Parameter", "properties": { "parameterName": { "type": "string", "description": "The name of the parameter." }, "parameterValue": { "type": "string", "description": "The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters." } }, "type": "object" }, "azure-native:awsconnector:PartitionedPrefix": { "description": "Definition of PartitionedPrefix", "properties": { "partitionDateSource": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PartitionedPrefixPartitionDateSource" } ], "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime." } }, "type": "object" }, "azure-native:awsconnector:PartitionedPrefixPartitionDateSource": { "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.", "type": "string", "enum": [ { "name": "DeliveryTime", "description": "PartitionedPrefixPartitionDateSource enum DeliveryTime", "value": "DeliveryTime" }, { "name": "EventTime", "description": "PartitionedPrefixPartitionDateSource enum EventTime", "value": "EventTime" } ] }, "azure-native:awsconnector:PartitionedPrefixResponse": { "description": "Definition of PartitionedPrefix", "properties": { "partitionDateSource": { "type": "string", "description": "Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime." } }, "type": "object" }, "azure-native:awsconnector:Permission": { "description": "Property value", "type": "string", "enum": [ { "name": "FULL_CONTROL", "description": "Permission enum FULL_CONTROL", "value": "FULL_CONTROL" }, { "name": "READ", "description": "Permission enum READ", "value": "READ" }, { "name": "READ_ACP", "description": "Permission enum READ_ACP", "value": "READ_ACP" }, { "name": "WRITE", "description": "Permission enum WRITE", "value": "WRITE" }, { "name": "WRITE_ACP", "description": "Permission enum WRITE_ACP", "value": "WRITE_ACP" } ] }, "azure-native:awsconnector:PermissionEnumValue": { "description": "Definition of PermissionEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:Permission" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PermissionEnumValueResponse": { "description": "Definition of PermissionEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PermissionModel": { "description": "Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified.", "type": "string", "enum": [ { "name": "SELF_MANAGED", "description": "PermissionModel enum SELF_MANAGED", "value": "SELF_MANAGED" }, { "name": "SERVICE_MANAGED", "description": "PermissionModel enum SERVICE_MANAGED", "value": "SERVICE_MANAGED" } ] }, "azure-native:awsconnector:PingStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "ConnectionLost", "description": "PingStatus enum ConnectionLost", "value": "ConnectionLost" }, { "name": "Inactive", "description": "PingStatus enum Inactive", "value": "Inactive" }, { "name": "Online", "description": "PingStatus enum Online", "value": "Online" } ] }, "azure-native:awsconnector:PingStatusEnumValue": { "description": "Definition of PingStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PingStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PingStatusEnumValueResponse": { "description": "Definition of PingStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Placement": { "description": "Definition of Placement", "properties": { "affinity": { "type": "string", "description": "\u003cp\u003eThe affinity setting for the instance on the Dedicated Host.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e or \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'\u003eImportInstance\u003c/a\u003e.\u003c/p\u003e" }, "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone of the instance.\u003c/p\u003e \u003cp\u003eIf not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e.\u003c/p\u003e" }, "groupId": { "type": "string", "description": "\u003cp\u003eThe ID of the placement group that the instance is in. If you specify \u003ccode\u003eGroupId\u003c/code\u003e, you can't specify \u003ccode\u003eGroupName\u003c/code\u003e.\u003c/p\u003e" }, "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the placement group that the instance is in. If you specify \u003ccode\u003eGroupName\u003c/code\u003e, you can't specify \u003ccode\u003eGroupId\u003c/code\u003e.\u003c/p\u003e" }, "hostId": { "type": "string", "description": "\u003cp\u003eThe ID of the Dedicated Host on which the instance resides.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e or \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'\u003eImportInstance\u003c/a\u003e.\u003c/p\u003e" }, "hostResourceGroupArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the host resource group in which to launch the instances.\u003c/p\u003e \u003cp\u003eIf you specify this parameter, either omit the \u003cb\u003eTenancy\u003c/b\u003e parameter or set it to \u003ccode\u003ehost\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e.\u003c/p\u003e" }, "partitionNumber": { "type": "integer", "description": "\u003cp\u003eThe number of the partition that the instance is in. Valid only if the placement group strategy is set to \u003ccode\u003epartition\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e.\u003c/p\u003e" }, "spreadDomain": { "type": "string", "description": "\u003cp\u003eReserved for future use.\u003c/p\u003e" }, "tenancy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TenancyEnumValue", "description": "\u003cp\u003eThe tenancy of the instance. An instance with a tenancy of \u003ccode\u003ededicated\u003c/code\u003e runs on single-tenant hardware.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e. The \u003ccode\u003ehost\u003c/code\u003e tenancy is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'\u003eImportInstance\u003c/a\u003e or for T3 instances that are configured for the \u003ccode\u003eunlimited\u003c/code\u003e CPU credit option.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PlacementConstraint": { "description": "Definition of PlacementConstraint", "properties": { "expression": { "type": "string", "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PlacementConstraintType" } ], "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates." } }, "type": "object" }, "azure-native:awsconnector:PlacementConstraintResponse": { "description": "Definition of PlacementConstraint", "properties": { "expression": { "type": "string", "description": "A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*." }, "type": { "type": "string", "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates." } }, "type": "object" }, "azure-native:awsconnector:PlacementConstraintType": { "description": "The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates.", "type": "string", "enum": [ { "name": "distinctInstance", "description": "PlacementConstraintType enum distinctInstance", "value": "distinctInstance" }, { "name": "memberOf", "description": "PlacementConstraintType enum memberOf", "value": "memberOf" } ] }, "azure-native:awsconnector:PlacementGroupConfig": { "description": "Definition of PlacementGroupConfig", "properties": { "instanceRole": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceRoleTypeEnumValue", "description": "\u003cp\u003eRole of the instance in the cluster.\u003c/p\u003e \u003cp\u003eStarting with Amazon EMR release 5.23.0, the only supported instance role is \u003ccode\u003eMASTER\u003c/code\u003e.\u003c/p\u003e" }, "placementStrategy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementGroupStrategyEnumValue", "description": "\u003cp\u003eAmazon EC2 Placement Group strategy associated with instance role.\u003c/p\u003e \u003cp\u003eStarting with Amazon EMR release 5.23.0, the only supported placement strategy is \u003ccode\u003eSPREAD\u003c/code\u003e for the \u003ccode\u003eMASTER\u003c/code\u003e instance role.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PlacementGroupConfigResponse": { "description": "Definition of PlacementGroupConfig", "properties": { "instanceRole": { "type": "object", "$ref": "#/types/azure-native:awsconnector:InstanceRoleTypeEnumValueResponse", "description": "\u003cp\u003eRole of the instance in the cluster.\u003c/p\u003e \u003cp\u003eStarting with Amazon EMR release 5.23.0, the only supported instance role is \u003ccode\u003eMASTER\u003c/code\u003e.\u003c/p\u003e" }, "placementStrategy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PlacementGroupStrategyEnumValueResponse", "description": "\u003cp\u003eAmazon EC2 Placement Group strategy associated with instance role.\u003c/p\u003e \u003cp\u003eStarting with Amazon EMR release 5.23.0, the only supported placement strategy is \u003ccode\u003eSPREAD\u003c/code\u003e for the \u003ccode\u003eMASTER\u003c/code\u003e instance role.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PlacementGroupStrategy": { "description": "Property value", "type": "string", "enum": [ { "name": "CLUSTER", "description": "PlacementGroupStrategy enum CLUSTER", "value": "CLUSTER" }, { "name": "NONE", "description": "PlacementGroupStrategy enum NONE", "value": "NONE" }, { "name": "PARTITION", "description": "PlacementGroupStrategy enum PARTITION", "value": "PARTITION" }, { "name": "SPREAD", "description": "PlacementGroupStrategy enum SPREAD", "value": "SPREAD" } ] }, "azure-native:awsconnector:PlacementGroupStrategyEnumValue": { "description": "Definition of PlacementGroupStrategyEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PlacementGroupStrategy" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PlacementGroupStrategyEnumValueResponse": { "description": "Definition of PlacementGroupStrategyEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PlacementResponse": { "description": "Definition of Placement", "properties": { "affinity": { "type": "string", "description": "\u003cp\u003eThe affinity setting for the instance on the Dedicated Host.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e or \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'\u003eImportInstance\u003c/a\u003e.\u003c/p\u003e" }, "availabilityZone": { "type": "string", "description": "\u003cp\u003eThe Availability Zone of the instance.\u003c/p\u003e \u003cp\u003eIf not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e.\u003c/p\u003e" }, "groupId": { "type": "string", "description": "\u003cp\u003eThe ID of the placement group that the instance is in. If you specify \u003ccode\u003eGroupId\u003c/code\u003e, you can't specify \u003ccode\u003eGroupName\u003c/code\u003e.\u003c/p\u003e" }, "groupName": { "type": "string", "description": "\u003cp\u003eThe name of the placement group that the instance is in. If you specify \u003ccode\u003eGroupName\u003c/code\u003e, you can't specify \u003ccode\u003eGroupId\u003c/code\u003e.\u003c/p\u003e" }, "hostId": { "type": "string", "description": "\u003cp\u003eThe ID of the Dedicated Host on which the instance resides.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e or \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'\u003eImportInstance\u003c/a\u003e.\u003c/p\u003e" }, "hostResourceGroupArn": { "type": "string", "description": "\u003cp\u003eThe ARN of the host resource group in which to launch the instances.\u003c/p\u003e \u003cp\u003eIf you specify this parameter, either omit the \u003cb\u003eTenancy\u003c/b\u003e parameter or set it to \u003ccode\u003ehost\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e.\u003c/p\u003e" }, "partitionNumber": { "type": "integer", "description": "\u003cp\u003eThe number of the partition that the instance is in. Valid only if the placement group strategy is set to \u003ccode\u003epartition\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e.\u003c/p\u003e" }, "spreadDomain": { "type": "string", "description": "\u003cp\u003eReserved for future use.\u003c/p\u003e" }, "tenancy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TenancyEnumValueResponse", "description": "\u003cp\u003eThe tenancy of the instance. An instance with a tenancy of \u003ccode\u003ededicated\u003c/code\u003e runs on single-tenant hardware.\u003c/p\u003e \u003cp\u003eThis parameter is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet'\u003eCreateFleet\u003c/a\u003e. The \u003ccode\u003ehost\u003c/code\u003e tenancy is not supported for \u003ca href='https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html'\u003eImportInstance\u003c/a\u003e or for T3 instances that are configured for the \u003ccode\u003eunlimited\u003c/code\u003e CPU credit option.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PlacementStrategy": { "description": "Definition of PlacementStrategy", "properties": { "field": { "type": "string", "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used." }, "type": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PlacementStrategyType" } ], "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task." } }, "type": "object" }, "azure-native:awsconnector:PlacementStrategyResponse": { "description": "Definition of PlacementStrategy", "properties": { "field": { "type": "string", "description": "The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used." }, "type": { "type": "string", "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task." } }, "type": "object" }, "azure-native:awsconnector:PlacementStrategyType": { "description": "The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task.", "type": "string", "enum": [ { "name": "binpack", "description": "PlacementStrategyType enum binpack", "value": "binpack" }, { "name": "random", "description": "PlacementStrategyType enum random", "value": "random" }, { "name": "spread", "description": "PlacementStrategyType enum spread", "value": "spread" } ] }, "azure-native:awsconnector:PlatformType": { "description": "Property value", "type": "string", "enum": [ { "name": "Linux", "description": "PlatformType enum Linux", "value": "Linux" }, { "name": "MacOS", "description": "PlatformType enum MacOS", "value": "MacOS" }, { "name": "Windows", "description": "PlatformType enum Windows", "value": "Windows" } ] }, "azure-native:awsconnector:PlatformTypeEnumValue": { "description": "Definition of PlatformTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PlatformType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PlatformTypeEnumValueResponse": { "description": "Definition of PlatformTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PlatformValues": { "description": "Property value", "type": "string", "enum": [ { "name": "Windows", "description": "PlatformValues enum Windows", "value": "Windows" } ] }, "azure-native:awsconnector:PlatformValuesEnumValue": { "description": "Definition of PlatformValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PlatformValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PlatformValuesEnumValueResponse": { "description": "Definition of PlatformValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PointInTimeRecoveryDescription": { "description": "Definition of PointInTimeRecoveryDescription", "properties": { "earliestRestorableDateTime": { "type": "string", "description": "\u003cp\u003eSpecifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days. \u003c/p\u003e" }, "latestRestorableDateTime": { "type": "string", "description": "\u003cp\u003e \u003ccode\u003eLatestRestorableDateTime\u003c/code\u003e is typically 5 minutes before the current time. \u003c/p\u003e" }, "pointInTimeRecoveryStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoveryStatusEnumValue", "description": "\u003cp\u003eThe current state of point in time recovery:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e - Point in time recovery is enabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e - Point in time recovery is disabled.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:PointInTimeRecoveryDescriptionResponse": { "description": "Definition of PointInTimeRecoveryDescription", "properties": { "earliestRestorableDateTime": { "type": "string", "description": "\u003cp\u003eSpecifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days. \u003c/p\u003e" }, "latestRestorableDateTime": { "type": "string", "description": "\u003cp\u003e \u003ccode\u003eLatestRestorableDateTime\u003c/code\u003e is typically 5 minutes before the current time. \u003c/p\u003e" }, "pointInTimeRecoveryStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoveryStatusEnumValueResponse", "description": "\u003cp\u003eThe current state of point in time recovery:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e - Point in time recovery is enabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e - Point in time recovery is disabled.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:PointInTimeRecoverySpecification": { "description": "Definition of PointInTimeRecoverySpecification", "properties": { "pointInTimeRecoveryEnabled": { "type": "boolean", "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table." } }, "type": "object" }, "azure-native:awsconnector:PointInTimeRecoverySpecificationResponse": { "description": "Definition of PointInTimeRecoverySpecification", "properties": { "pointInTimeRecoveryEnabled": { "type": "boolean", "description": "Indicates whether point in time recovery is enabled (true) or disabled (false) on the table." } }, "type": "object" }, "azure-native:awsconnector:PointInTimeRecoveryStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "PointInTimeRecoveryStatus enum DISABLED", "value": "DISABLED" }, { "name": "ENABLED", "description": "PointInTimeRecoveryStatus enum ENABLED", "value": "ENABLED" } ] }, "azure-native:awsconnector:PointInTimeRecoveryStatusEnumValue": { "description": "Definition of PointInTimeRecoveryStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PointInTimeRecoveryStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PointInTimeRecoveryStatusEnumValueResponse": { "description": "Definition of PointInTimeRecoveryStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Policy": { "description": "Definition of Policy", "properties": { "policyDocument": { "$ref": "pulumi.json#/Any", "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)." }, "policyName": { "type": "string", "description": "The friendly name (not ARN) identifying the policy." } }, "type": "object" }, "azure-native:awsconnector:PolicyResponse": { "description": "Definition of Policy", "properties": { "policyDocument": { "$ref": "pulumi.json#/Any", "description": "The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json)." }, "policyName": { "type": "string", "description": "The friendly name (not ARN) identifying the policy." } }, "type": "object" }, "azure-native:awsconnector:Port": { "description": "Definition of Port", "properties": { "accessDirection": { "type": "string", "description": "Access Direction for Protocol of the Instance(inbound/outbound)." }, "accessFrom": { "type": "string", "description": "Access From Protocol of the Instance." }, "accessType": { "type": "string", "description": "Access Type Protocol of the Instance." }, "cidrListAliases": { "type": "array", "items": { "type": "string" }, "description": "cidr List Aliases" }, "cidrs": { "type": "array", "items": { "type": "string" }, "description": "Property cidrs" }, "commonName": { "type": "string", "description": "CommonName for Protocol of the Instance." }, "fromPort": { "type": "integer", "description": "From Port of the Instance." }, "ipv6Cidrs": { "type": "array", "items": { "type": "string" }, "description": "IPv6 Cidrs" }, "protocol": { "type": "string", "description": "Port Protocol of the Instance." }, "toPort": { "type": "integer", "description": "To Port of the Instance." } }, "type": "object" }, "azure-native:awsconnector:PortMapping": { "description": "Definition of PortMapping", "properties": { "appProtocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PortMappingAppProtocol" } ], "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "containerPort": { "type": "integer", "description": "The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance." }, "containerPortRange": { "type": "string", "description": "The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a ``containerPortRange``: + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package + You can specify a maximum of 100 port ranges per container. + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + The ``containerPortRange`` valid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see [Issue #11185](https://github.com/moby/moby/issues/11185) on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*. You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports." }, "hostPort": { "type": "integer", "description": "The port number on the container instance to reserve for your container. If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota." }, "name": { "type": "string", "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "protocol": { "type": "string", "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment." } }, "type": "object" }, "azure-native:awsconnector:PortMappingAppProtocol": { "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*.", "type": "string", "enum": [ { "name": "grpc", "description": "PortMappingAppProtocol enum grpc", "value": "grpc" }, { "name": "http", "description": "PortMappingAppProtocol enum http", "value": "http" }, { "name": "http2", "description": "PortMappingAppProtocol enum http2", "value": "http2" } ] }, "azure-native:awsconnector:PortMappingResponse": { "description": "Definition of PortMapping", "properties": { "appProtocol": { "type": "string", "description": "The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "containerPort": { "type": "integer", "description": "The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance." }, "containerPortRange": { "type": "string", "description": "The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a ``containerPortRange``: + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package + You can specify a maximum of 100 port ranges per container. + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + The ``containerPortRange`` valid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see [Issue #11185](https://github.com/moby/moby/issues/11185) on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*. You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports." }, "hostPort": { "type": "integer", "description": "The port number on the container instance to reserve for your container. If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota." }, "name": { "type": "string", "description": "The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "protocol": { "type": "string", "description": "The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment." } }, "type": "object" }, "azure-native:awsconnector:PortRange": { "description": "Definition of PortRange", "properties": { "fromPort": { "type": "integer", "description": "Property fromPort" }, "toPort": { "type": "integer", "description": "Property toPort" } }, "type": "object" }, "azure-native:awsconnector:PortRangeResponse": { "description": "Definition of PortRange", "properties": { "fromPort": { "type": "integer", "description": "Property fromPort" }, "toPort": { "type": "integer", "description": "Property toPort" } }, "type": "object" }, "azure-native:awsconnector:PortResponse": { "description": "Definition of Port", "properties": { "accessDirection": { "type": "string", "description": "Access Direction for Protocol of the Instance(inbound/outbound)." }, "accessFrom": { "type": "string", "description": "Access From Protocol of the Instance." }, "accessType": { "type": "string", "description": "Access Type Protocol of the Instance." }, "cidrListAliases": { "type": "array", "items": { "type": "string" }, "description": "cidr List Aliases" }, "cidrs": { "type": "array", "items": { "type": "string" }, "description": "Property cidrs" }, "commonName": { "type": "string", "description": "CommonName for Protocol of the Instance." }, "fromPort": { "type": "integer", "description": "From Port of the Instance." }, "ipv6Cidrs": { "type": "array", "items": { "type": "string" }, "description": "IPv6 Cidrs" }, "protocol": { "type": "string", "description": "Port Protocol of the Instance." }, "toPort": { "type": "integer", "description": "To Port of the Instance." } }, "type": "object" }, "azure-native:awsconnector:PortSet": { "description": "Definition of PortSet", "properties": { "definition": { "type": "array", "items": { "type": "string" }, "description": "Property definition" } }, "type": "object" }, "azure-native:awsconnector:PortSetResponse": { "description": "Definition of PortSet", "properties": { "definition": { "type": "array", "items": { "type": "string" }, "description": "Property definition" } }, "type": "object" }, "azure-native:awsconnector:PrefixListId": { "description": "Definition of PrefixListId", "properties": { "description": { "type": "string", "description": "\u003cp\u003eA description for the security group rule that references this prefix list ID.\u003c/p\u003e \u003cp\u003eConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*\u003c/p\u003e" }, "prefixListId": { "type": "string", "description": "\u003cp\u003eThe ID of the prefix.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PrefixListIdResponse": { "description": "Definition of PrefixListId", "properties": { "description": { "type": "string", "description": "\u003cp\u003eA description for the security group rule that references this prefix list ID.\u003c/p\u003e \u003cp\u003eConstraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*\u003c/p\u003e" }, "prefixListId": { "type": "string", "description": "\u003cp\u003eThe ID of the prefix.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PrivateDnsNameOptionsOnLaunchModelProperties": { "description": "Definition of PrivateDnsNameOptionsOnLaunchModelProperties", "properties": { "enableResourceNameDnsAAAARecord": { "type": "boolean", "description": "Property enableResourceNameDnsAAAARecord" }, "enableResourceNameDnsARecord": { "type": "boolean", "description": "Property enableResourceNameDnsARecord" }, "hostnameType": { "type": "string", "description": "Property hostnameType" } }, "type": "object" }, "azure-native:awsconnector:PrivateDnsNameOptionsOnLaunchModelPropertiesResponse": { "description": "Definition of PrivateDnsNameOptionsOnLaunchModelProperties", "properties": { "enableResourceNameDnsAAAARecord": { "type": "boolean", "description": "Property enableResourceNameDnsAAAARecord" }, "enableResourceNameDnsARecord": { "type": "boolean", "description": "Property enableResourceNameDnsARecord" }, "hostnameType": { "type": "string", "description": "Property hostnameType" } }, "type": "object" }, "azure-native:awsconnector:PrivateDnsNameOptionsResponse": { "description": "Definition of PrivateDnsNameOptionsResponse", "properties": { "enableResourceNameDnsAAAARecord": { "type": "boolean", "description": "\u003cp\u003eIndicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\u003c/p\u003e" }, "enableResourceNameDnsARecord": { "type": "boolean", "description": "\u003cp\u003eIndicates whether to respond to DNS queries for instance hostnames with DNS A records.\u003c/p\u003e" }, "hostnameType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostnameTypeEnumValue", "description": "\u003cp\u003eThe type of hostname to assign to an instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PrivateDnsNameOptionsResponseResponse": { "description": "Definition of PrivateDnsNameOptionsResponse", "properties": { "enableResourceNameDnsAAAARecord": { "type": "boolean", "description": "\u003cp\u003eIndicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.\u003c/p\u003e" }, "enableResourceNameDnsARecord": { "type": "boolean", "description": "\u003cp\u003eIndicates whether to respond to DNS queries for instance hostnames with DNS A records.\u003c/p\u003e" }, "hostnameType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:HostnameTypeEnumValueResponse", "description": "\u003cp\u003eThe type of hostname to assign to an instance.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:PrivateIpAddressSpecification": { "description": "Definition of PrivateIpAddressSpecification", "properties": { "primary": { "type": "boolean", "description": "Property primary" }, "privateIpAddress": { "type": "string", "description": "Property privateIpAddress" } }, "type": "object" }, "azure-native:awsconnector:PrivateIpAddressSpecificationResponse": { "description": "Definition of PrivateIpAddressSpecification", "properties": { "primary": { "type": "boolean", "description": "Property primary" }, "privateIpAddress": { "type": "string", "description": "Property privateIpAddress" } }, "type": "object" }, "azure-native:awsconnector:ProcessorFeature": { "description": "Definition of ProcessorFeature", "properties": { "name": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ProcessorFeatureName" } ], "description": "\u003cp\u003eThe name of the processor feature. Valid names are \u003ccode\u003ecoreCount\u003c/code\u003e and \u003ccode\u003ethreadsPerCore\u003c/code\u003e.\u003c/p\u003e" }, "value": { "type": "string", "description": "\u003cp\u003eThe value of a processor feature name.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProcessorFeatureName": { "description": "The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.", "type": "string", "enum": [ { "name": "coreCount", "description": "ProcessorFeatureName enum coreCount", "value": "coreCount" }, { "name": "threadsPerCore", "description": "ProcessorFeatureName enum threadsPerCore", "value": "threadsPerCore" } ] }, "azure-native:awsconnector:ProcessorFeatureResponse": { "description": "Definition of ProcessorFeature", "properties": { "name": { "type": "string", "description": "\u003cp\u003eThe name of the processor feature. Valid names are \u003ccode\u003ecoreCount\u003c/code\u003e and \u003ccode\u003ethreadsPerCore\u003c/code\u003e.\u003c/p\u003e" }, "value": { "type": "string", "description": "\u003cp\u003eThe value of a processor feature name.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProductCode": { "description": "Definition of ProductCode", "properties": { "productCodeId": { "type": "string", "description": "\u003cp\u003eThe product code.\u003c/p\u003e" }, "productCodeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProductCodeValuesEnumValue", "description": "\u003cp\u003eThe type of product code.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProductCodeResponse": { "description": "Definition of ProductCode", "properties": { "productCodeId": { "type": "string", "description": "\u003cp\u003eThe product code.\u003c/p\u003e" }, "productCodeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProductCodeValuesEnumValueResponse", "description": "\u003cp\u003eThe type of product code.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProductCodeValues": { "description": "Property value", "type": "string", "enum": [ { "name": "Devpay", "description": "ProductCodeValues enum devpay", "value": "devpay" }, { "name": "Marketplace", "description": "ProductCodeValues enum marketplace", "value": "marketplace" } ] }, "azure-native:awsconnector:ProductCodeValuesEnumValue": { "description": "Definition of ProductCodeValuesEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ProductCodeValues" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ProductCodeValuesEnumValueResponse": { "description": "Definition of ProductCodeValuesEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ProjectArtifacts": { "description": "Definition of ProjectArtifacts", "properties": { "artifactIdentifier": { "type": "string", "description": "\u003cp\u003e An identifier for this artifact definition. \u003c/p\u003e" }, "bucketOwnerAccess": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BucketOwnerAccessEnumValue", "description": "Property bucketOwnerAccess" }, "encryptionDisabled": { "type": "boolean", "description": "\u003cp\u003e Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. \u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eInformation about the build output artifact location:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, this is the name of the output bucket.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eAlong with \u003ccode\u003epath\u003c/code\u003e and \u003ccode\u003enamespaceType\u003c/code\u003e, the pattern that CodeBuild uses to name and store the output artifact:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, this is the name of the output artifact object. If you set the name to be a forward slash ('/'), the artifact is stored in the root of the output bucket.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor example:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e If \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eBUILD_ID\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to \u003ccode\u003eMyArtifact.zip\u003c/code\u003e, then the output artifact is stored in \u003ccode\u003eMyArtifacts/\u0026lt;build-ID\u0026gt;/MyArtifact.zip\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e If \u003ccode\u003epath\u003c/code\u003e is empty, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eNONE\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to '\u003ccode\u003e/\u003c/code\u003e', the output artifact is stored in the root of the output bucket. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e If \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eBUILD_ID\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to '\u003ccode\u003e/\u003c/code\u003e', the output artifact is stored in \u003ccode\u003eMyArtifacts/\u0026lt;build-ID\u0026gt;\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "namespaceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArtifactNamespaceEnumValue", "description": "\u003cp\u003eAlong with \u003ccode\u003epath\u003c/code\u003e and \u003ccode\u003ename\u003c/code\u003e, the pattern that CodeBuild uses to determine the name and location to store the output artifact:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_ID\u003c/code\u003e: Include the build ID in the location of the build output artifact.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNONE\u003c/code\u003e: Do not include the build ID. This is the default if \u003ccode\u003enamespaceType\u003c/code\u003e is not specified.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor example, if \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eBUILD_ID\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to \u003ccode\u003eMyArtifact.zip\u003c/code\u003e, the output artifact is stored in \u003ccode\u003eMyArtifacts/\u0026lt;build-ID\u0026gt;/MyArtifact.zip\u003c/code\u003e.\u003c/p\u003e" }, "overrideArtifactName": { "type": "boolean", "description": "\u003cp\u003e If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. \u003c/p\u003e" }, "packaging": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArtifactPackagingEnumValue", "description": "\u003cp\u003eThe type of build output artifact to create:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNONE\u003c/code\u003e: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if \u003ccode\u003epackaging\u003c/code\u003e is not specified.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eZIP\u003c/code\u003e: CodeBuild creates in the output bucket a ZIP file that contains the build output.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e" }, "path": { "type": "string", "description": "\u003cp\u003eAlong with \u003ccode\u003enamespaceType\u003c/code\u003e and \u003ccode\u003ename\u003c/code\u003e, the pattern that CodeBuild uses to name and store the output artifact:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, this is the path to the output artifact. If \u003ccode\u003epath\u003c/code\u003e is not specified, \u003ccode\u003epath\u003c/code\u003e is not used.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor example, if \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eNONE\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to \u003ccode\u003eMyArtifact.zip\u003c/code\u003e, the output artifact is stored in the output bucket at \u003ccode\u003eMyArtifacts/MyArtifact.zip\u003c/code\u003e.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArtifactsTypeEnumValue", "description": "\u003cp\u003eThe type of build output artifact. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODEPIPELINE\u003c/code\u003e: The build project has build output generated through CodePipeline. \u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe \u003ccode\u003eCODEPIPELINE\u003c/code\u003e type is not supported for \u003ccode\u003esecondaryArtifacts\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e: The build project does not produce any build output.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: The build project stores build output in Amazon S3.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectArtifactsResponse": { "description": "Definition of ProjectArtifacts", "properties": { "artifactIdentifier": { "type": "string", "description": "\u003cp\u003e An identifier for this artifact definition. \u003c/p\u003e" }, "bucketOwnerAccess": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BucketOwnerAccessEnumValueResponse", "description": "Property bucketOwnerAccess" }, "encryptionDisabled": { "type": "boolean", "description": "\u003cp\u003e Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. \u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eInformation about the build output artifact location:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, this is the name of the output bucket.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "name": { "type": "string", "description": "\u003cp\u003eAlong with \u003ccode\u003epath\u003c/code\u003e and \u003ccode\u003enamespaceType\u003c/code\u003e, the pattern that CodeBuild uses to name and store the output artifact:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, this is the name of the output artifact object. If you set the name to be a forward slash ('/'), the artifact is stored in the root of the output bucket.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor example:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e If \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eBUILD_ID\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to \u003ccode\u003eMyArtifact.zip\u003c/code\u003e, then the output artifact is stored in \u003ccode\u003eMyArtifacts/\u0026lt;build-ID\u0026gt;/MyArtifact.zip\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e If \u003ccode\u003epath\u003c/code\u003e is empty, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eNONE\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to '\u003ccode\u003e/\u003c/code\u003e', the output artifact is stored in the root of the output bucket. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e If \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eBUILD_ID\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to '\u003ccode\u003e/\u003c/code\u003e', the output artifact is stored in \u003ccode\u003eMyArtifacts/\u0026lt;build-ID\u0026gt;\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "namespaceType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArtifactNamespaceEnumValueResponse", "description": "\u003cp\u003eAlong with \u003ccode\u003epath\u003c/code\u003e and \u003ccode\u003ename\u003c/code\u003e, the pattern that CodeBuild uses to determine the name and location to store the output artifact:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_ID\u003c/code\u003e: Include the build ID in the location of the build output artifact.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNONE\u003c/code\u003e: Do not include the build ID. This is the default if \u003ccode\u003enamespaceType\u003c/code\u003e is not specified.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor example, if \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eBUILD_ID\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to \u003ccode\u003eMyArtifact.zip\u003c/code\u003e, the output artifact is stored in \u003ccode\u003eMyArtifacts/\u0026lt;build-ID\u0026gt;/MyArtifact.zip\u003c/code\u003e.\u003c/p\u003e" }, "overrideArtifactName": { "type": "boolean", "description": "\u003cp\u003e If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. \u003c/p\u003e" }, "packaging": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArtifactPackagingEnumValueResponse", "description": "\u003cp\u003eThe type of build output artifact to create:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNONE\u003c/code\u003e: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if \u003ccode\u003epackaging\u003c/code\u003e is not specified.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eZIP\u003c/code\u003e: CodeBuild creates in the output bucket a ZIP file that contains the build output.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003c/ul\u003e" }, "path": { "type": "string", "description": "\u003cp\u003eAlong with \u003ccode\u003enamespaceType\u003c/code\u003e and \u003ccode\u003ename\u003c/code\u003e, the pattern that CodeBuild uses to name and store the output artifact:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eCODEPIPELINE\u003c/code\u003e, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e, this value is ignored if specified, because no build output is produced.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf \u003ccode\u003etype\u003c/code\u003e is set to \u003ccode\u003eS3\u003c/code\u003e, this is the path to the output artifact. If \u003ccode\u003epath\u003c/code\u003e is not specified, \u003ccode\u003epath\u003c/code\u003e is not used.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor example, if \u003ccode\u003epath\u003c/code\u003e is set to \u003ccode\u003eMyArtifacts\u003c/code\u003e, \u003ccode\u003enamespaceType\u003c/code\u003e is set to \u003ccode\u003eNONE\u003c/code\u003e, and \u003ccode\u003ename\u003c/code\u003e is set to \u003ccode\u003eMyArtifact.zip\u003c/code\u003e, the output artifact is stored in the output bucket at \u003ccode\u003eMyArtifacts/MyArtifact.zip\u003c/code\u003e.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ArtifactsTypeEnumValueResponse", "description": "\u003cp\u003eThe type of build output artifact. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODEPIPELINE\u003c/code\u003e: The build project has build output generated through CodePipeline. \u003c/p\u003e \u003cnote\u003e \u003cp\u003eThe \u003ccode\u003eCODEPIPELINE\u003c/code\u003e type is not supported for \u003ccode\u003esecondaryArtifacts\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_ARTIFACTS\u003c/code\u003e: The build project does not produce any build output.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: The build project stores build output in Amazon S3.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectBadge": { "description": "Definition of ProjectBadge", "properties": { "badgeEnabled": { "type": "boolean", "description": "\u003cp\u003eSet this to true to generate a publicly accessible URL for your project's build badge.\u003c/p\u003e" }, "badgeRequestUrl": { "type": "string", "description": "\u003cp\u003eThe publicly-accessible URL through which you can access the build badge for your project. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectBadgeResponse": { "description": "Definition of ProjectBadge", "properties": { "badgeEnabled": { "type": "boolean", "description": "\u003cp\u003eSet this to true to generate a publicly accessible URL for your project's build badge.\u003c/p\u003e" }, "badgeRequestUrl": { "type": "string", "description": "\u003cp\u003eThe publicly-accessible URL through which you can access the build badge for your project. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectBuildBatchConfig": { "description": "Definition of ProjectBuildBatchConfig", "properties": { "batchReportMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BatchReportModeTypeEnumValue", "description": "\u003cp\u003eSpecifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eREPORT_AGGREGATED_BATCH\u003c/dt\u003e \u003cdd\u003e \u003cp\u003e(Default) Aggregate all of the build statuses into a single status report.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eREPORT_INDIVIDUAL_BUILDS\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSend a separate status report for each individual build.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "combineArtifacts": { "type": "boolean", "description": "\u003cp\u003eSpecifies if the build artifacts for the batch build should be combined into a single artifact location.\u003c/p\u003e" }, "restrictions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BatchRestrictions", "description": "\u003cp\u003eA \u003ccode\u003eBatchRestrictions\u003c/code\u003e object that specifies the restrictions for the batch build.\u003c/p\u003e" }, "serviceRole": { "type": "string", "description": "\u003cp\u003eSpecifies the service role ARN for the batch build project.\u003c/p\u003e" }, "timeoutInMins": { "type": "integer", "description": "\u003cp\u003eSpecifies the maximum amount of time, in minutes, that the batch build must be completed in.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectBuildBatchConfigResponse": { "description": "Definition of ProjectBuildBatchConfig", "properties": { "batchReportMode": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BatchReportModeTypeEnumValueResponse", "description": "\u003cp\u003eSpecifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eREPORT_AGGREGATED_BATCH\u003c/dt\u003e \u003cdd\u003e \u003cp\u003e(Default) Aggregate all of the build statuses into a single status report.\u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eREPORT_INDIVIDUAL_BUILDS\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eSend a separate status report for each individual build.\u003c/p\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "combineArtifacts": { "type": "boolean", "description": "\u003cp\u003eSpecifies if the build artifacts for the batch build should be combined into a single artifact location.\u003c/p\u003e" }, "restrictions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BatchRestrictionsResponse", "description": "\u003cp\u003eA \u003ccode\u003eBatchRestrictions\u003c/code\u003e object that specifies the restrictions for the batch build.\u003c/p\u003e" }, "serviceRole": { "type": "string", "description": "\u003cp\u003eSpecifies the service role ARN for the batch build project.\u003c/p\u003e" }, "timeoutInMins": { "type": "integer", "description": "\u003cp\u003eSpecifies the maximum amount of time, in minutes, that the batch build must be completed in.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectCache": { "description": "Definition of ProjectCache", "properties": { "location": { "type": "string", "description": "\u003cp\u003eInformation about the cache location: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_CACHE\u003c/code\u003e or \u003ccode\u003eLOCAL\u003c/code\u003e: This value is ignored.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: This is the S3 bucket name/prefix.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "modes": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:CacheMode" } ] }, "description": "\u003cp\u003eAn array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for \u003ccode\u003eLOCAL\u003c/code\u003e cache types.\u003c/p\u003e \u003cp\u003ePossible values are:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eLOCAL_SOURCE_CACHE\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eCaches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. \u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eLOCAL_DOCKER_LAYER_CACHE\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eCaches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. \u003c/p\u003e \u003cnote\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou can use a Docker layer cache in the Linux environment only. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe \u003ccode\u003eprivileged\u003c/code\u003e flag must be set so that your project has the required Docker permissions. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou should consider the security implications before you use a Docker layer cache. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eLOCAL_CUSTOM_CACHE\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eCaches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eOnly directories can be specified for caching. You cannot specify individual files. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eSymlinks are used to reference cached directories. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CacheTypeEnumValue", "description": "\u003cp\u003eThe type of cache used by the build project. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_CACHE\u003c/code\u003e: The build project does not use any cache.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: The build project reads and writes from and to S3.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eLOCAL\u003c/code\u003e: The build project stores a cache locally on a build host that is only available to that build host.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectCacheResponse": { "description": "Definition of ProjectCache", "properties": { "location": { "type": "string", "description": "\u003cp\u003eInformation about the cache location: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_CACHE\u003c/code\u003e or \u003ccode\u003eLOCAL\u003c/code\u003e: This value is ignored.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: This is the S3 bucket name/prefix.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" }, "modes": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for \u003ccode\u003eLOCAL\u003c/code\u003e cache types.\u003c/p\u003e \u003cp\u003ePossible values are:\u003c/p\u003e \u003cdl\u003e \u003cdt\u003eLOCAL_SOURCE_CACHE\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eCaches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. \u003c/p\u003e \u003c/dd\u003e \u003cdt\u003eLOCAL_DOCKER_LAYER_CACHE\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eCaches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. \u003c/p\u003e \u003cnote\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eYou can use a Docker layer cache in the Linux environment only. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe \u003ccode\u003eprivileged\u003c/code\u003e flag must be set so that your project has the required Docker permissions. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eYou should consider the security implications before you use a Docker layer cache. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/note\u003e \u003c/dd\u003e \u003cdt\u003eLOCAL_CUSTOM_CACHE\u003c/dt\u003e \u003cdd\u003e \u003cp\u003eCaches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eOnly directories can be specified for caching. You cannot specify individual files. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eSymlinks are used to reference cached directories. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/dd\u003e \u003c/dl\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CacheTypeEnumValueResponse", "description": "\u003cp\u003eThe type of cache used by the build project. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_CACHE\u003c/code\u003e: The build project does not use any cache.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: The build project reads and writes from and to S3.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eLOCAL\u003c/code\u003e: The build project stores a cache locally on a build host that is only available to that build host.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectEnvironment": { "description": "Definition of ProjectEnvironment", "properties": { "certificate": { "type": "string", "description": "\u003cp\u003eThe ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate'\u003ecertificate\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e" }, "computeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComputeTypeEnumValue", "description": "\u003cp\u003eInformation about the compute resources the build project uses. Available values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_SMALL\u003c/code\u003e: Use up to 3 GB memory and 2 vCPUs for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_MEDIUM\u003c/code\u003e: Use up to 7 GB memory and 4 vCPUs for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_LARGE\u003c/code\u003e: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_XLARGE\u003c/code\u003e: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_2XLARGE\u003c/code\u003e: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_1GB\u003c/code\u003e: Use up to 1 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_2GB\u003c/code\u003e: Use up to 2 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_4GB\u003c/code\u003e: Use up to 4 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_8GB\u003c/code\u003e: Use up to 8 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_10GB\u003c/code\u003e: Use up to 10 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e If you use \u003ccode\u003eBUILD_GENERAL1_SMALL\u003c/code\u003e: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_CONTAINER\u003c/code\u003e, you can use up to 3 GB memory and 2 vCPUs for builds. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_GPU_CONTAINER\u003c/code\u003e, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eARM_CONTAINER\u003c/code\u003e, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e If you use \u003ccode\u003eBUILD_GENERAL1_LARGE\u003c/code\u003e: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_CONTAINER\u003c/code\u003e, you can use up to 15 GB memory and 8 vCPUs for builds. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_GPU_CONTAINER\u003c/code\u003e, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eARM_CONTAINER\u003c/code\u003e, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eIf you're using compute fleets during project creation, \u003ccode\u003ecomputeType\u003c/code\u003e will be ignored.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'\u003eBuild Environment Compute Types\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide.\u003c/i\u003e \u003c/p\u003e" }, "environmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentVariable" }, "description": "\u003cp\u003eA set of environment variables to make available to builds for this build project.\u003c/p\u003e" }, "fleet": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectFleet", "description": "\u003cp\u003eA ProjectFleet object to use for this build project.\u003c/p\u003e" }, "image": { "type": "string", "description": "\u003cp\u003eThe image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor an image tag: \u003ccode\u003e\u0026lt;registry\u0026gt;/\u0026lt;repository\u0026gt;:\u0026lt;tag\u0026gt;\u003c/code\u003e. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be \u003ccode\u003eaws/codebuild/standard:4.0\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor an image digest: \u003ccode\u003e\u0026lt;registry\u0026gt;/\u0026lt;repository\u0026gt;@\u0026lt;digest\u0026gt;\u003c/code\u003e. For example, to specify an image with the digest 'sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,' use \u003ccode\u003e\u0026lt;registry\u0026gt;/\u0026lt;repository\u0026gt;@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html'\u003eDocker images provided by CodeBuild\u003c/a\u003e in the \u003ci\u003eCodeBuild user guide\u003c/i\u003e.\u003c/p\u003e" }, "imagePullCredentialsType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImagePullCredentialsTypeEnumValue", "description": "\u003cp\u003e The type of credentials CodeBuild uses to pull images in your build. There are two valid values: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODEBUILD\u003c/code\u003e specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSERVICE_ROLE\u003c/code\u003e specifies that CodeBuild uses your build project's service role. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. \u003c/p\u003e" }, "privilegedMode": { "type": "boolean", "description": "\u003cp\u003eEnables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is \u003ccode\u003efalse\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eYou can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:\u003c/p\u003e \u003cp\u003eIf the operating system's base image is Ubuntu Linux:\u003c/p\u003e \u003cp\u003e \u003ccode\u003e- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay\u0026amp;\u003c/code\u003e \u003c/p\u003e \u003cp\u003e \u003ccode\u003e- timeout 15 sh -c 'until docker info; do echo .; sleep 1; done'\u003c/code\u003e \u003c/p\u003e \u003cp\u003eIf the operating system's base image is Alpine Linux and the previous command does not work, add the \u003ccode\u003e-t\u003c/code\u003e argument to \u003ccode\u003etimeout\u003c/code\u003e:\u003c/p\u003e \u003cp\u003e \u003ccode\u003e- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay\u0026amp;\u003c/code\u003e \u003c/p\u003e \u003cp\u003e \u003ccode\u003e- timeout -t 15 sh -c 'until docker info; do echo .; sleep 1; done'\u003c/code\u003e \u003c/p\u003e" }, "registryCredential": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RegistryCredential", "description": "\u003cp\u003e The credentials for access to a private registry.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentTypeEnumValue", "description": "\u003cp\u003eThe type of build environment to use for related builds.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe environment type \u003ccode\u003eARM_CONTAINER\u003c/code\u003e is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe environment type \u003ccode\u003eLINUX_CONTAINER\u003c/code\u003e is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe environment type \u003ccode\u003eLINUX_GPU_CONTAINER\u003c/code\u003e is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe environment types \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe environment types \u003ccode\u003eWINDOWS_CONTAINER\u003c/code\u003e and \u003ccode\u003eWINDOWS_SERVER_2019_CONTAINER\u003c/code\u003e are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eIf you're using compute fleets during project creation, \u003ccode\u003etype\u003c/code\u003e will be ignored.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'\u003eBuild environment compute types\u003c/a\u003e in the \u003ci\u003eCodeBuild user guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectEnvironmentResponse": { "description": "Definition of ProjectEnvironment", "properties": { "certificate": { "type": "string", "description": "\u003cp\u003eThe ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate'\u003ecertificate\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e" }, "computeType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ComputeTypeEnumValueResponse", "description": "\u003cp\u003eInformation about the compute resources the build project uses. Available values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_SMALL\u003c/code\u003e: Use up to 3 GB memory and 2 vCPUs for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_MEDIUM\u003c/code\u003e: Use up to 7 GB memory and 4 vCPUs for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_LARGE\u003c/code\u003e: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_XLARGE\u003c/code\u003e: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_GENERAL1_2XLARGE\u003c/code\u003e: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_1GB\u003c/code\u003e: Use up to 1 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_2GB\u003c/code\u003e: Use up to 2 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_4GB\u003c/code\u003e: Use up to 4 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_8GB\u003c/code\u003e: Use up to 8 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBUILD_LAMBDA_10GB\u003c/code\u003e: Use up to 10 GB memory for builds. Only available for environment type \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e If you use \u003ccode\u003eBUILD_GENERAL1_SMALL\u003c/code\u003e: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_CONTAINER\u003c/code\u003e, you can use up to 3 GB memory and 2 vCPUs for builds. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_GPU_CONTAINER\u003c/code\u003e, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eARM_CONTAINER\u003c/code\u003e, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e If you use \u003ccode\u003eBUILD_GENERAL1_LARGE\u003c/code\u003e: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_CONTAINER\u003c/code\u003e, you can use up to 15 GB memory and 8 vCPUs for builds. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eLINUX_GPU_CONTAINER\u003c/code\u003e, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e For environment type \u003ccode\u003eARM_CONTAINER\u003c/code\u003e, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eIf you're using compute fleets during project creation, \u003ccode\u003ecomputeType\u003c/code\u003e will be ignored.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'\u003eBuild Environment Compute Types\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide.\u003c/i\u003e \u003c/p\u003e" }, "environmentVariables": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentVariableResponse" }, "description": "\u003cp\u003eA set of environment variables to make available to builds for this build project.\u003c/p\u003e" }, "fleet": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ProjectFleetResponse", "description": "\u003cp\u003eA ProjectFleet object to use for this build project.\u003c/p\u003e" }, "image": { "type": "string", "description": "\u003cp\u003eThe image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor an image tag: \u003ccode\u003e\u0026lt;registry\u0026gt;/\u0026lt;repository\u0026gt;:\u0026lt;tag\u0026gt;\u003c/code\u003e. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be \u003ccode\u003eaws/codebuild/standard:4.0\u003c/code\u003e. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor an image digest: \u003ccode\u003e\u0026lt;registry\u0026gt;/\u0026lt;repository\u0026gt;@\u0026lt;digest\u0026gt;\u003c/code\u003e. For example, to specify an image with the digest 'sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,' use \u003ccode\u003e\u0026lt;registry\u0026gt;/\u0026lt;repository\u0026gt;@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html'\u003eDocker images provided by CodeBuild\u003c/a\u003e in the \u003ci\u003eCodeBuild user guide\u003c/i\u003e.\u003c/p\u003e" }, "imagePullCredentialsType": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ImagePullCredentialsTypeEnumValueResponse", "description": "\u003cp\u003e The type of credentials CodeBuild uses to pull images in your build. There are two valid values: \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODEBUILD\u003c/code\u003e specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eSERVICE_ROLE\u003c/code\u003e specifies that CodeBuild uses your build project's service role. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. \u003c/p\u003e" }, "privilegedMode": { "type": "boolean", "description": "\u003cp\u003eEnables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is \u003ccode\u003efalse\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eYou can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:\u003c/p\u003e \u003cp\u003eIf the operating system's base image is Ubuntu Linux:\u003c/p\u003e \u003cp\u003e \u003ccode\u003e- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay\u0026amp;\u003c/code\u003e \u003c/p\u003e \u003cp\u003e \u003ccode\u003e- timeout 15 sh -c 'until docker info; do echo .; sleep 1; done'\u003c/code\u003e \u003c/p\u003e \u003cp\u003eIf the operating system's base image is Alpine Linux and the previous command does not work, add the \u003ccode\u003e-t\u003c/code\u003e argument to \u003ccode\u003etimeout\u003c/code\u003e:\u003c/p\u003e \u003cp\u003e \u003ccode\u003e- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay\u0026amp;\u003c/code\u003e \u003c/p\u003e \u003cp\u003e \u003ccode\u003e- timeout -t 15 sh -c 'until docker info; do echo .; sleep 1; done'\u003c/code\u003e \u003c/p\u003e" }, "registryCredential": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RegistryCredentialResponse", "description": "\u003cp\u003e The credentials for access to a private registry.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EnvironmentTypeEnumValueResponse", "description": "\u003cp\u003eThe type of build environment to use for related builds.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe environment type \u003ccode\u003eARM_CONTAINER\u003c/code\u003e is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe environment type \u003ccode\u003eLINUX_CONTAINER\u003c/code\u003e is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe environment type \u003ccode\u003eLINUX_GPU_CONTAINER\u003c/code\u003e is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe environment types \u003ccode\u003eARM_LAMBDA_CONTAINER\u003c/code\u003e and \u003ccode\u003eLINUX_LAMBDA_CONTAINER\u003c/code\u003e are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe environment types \u003ccode\u003eWINDOWS_CONTAINER\u003c/code\u003e and \u003ccode\u003eWINDOWS_SERVER_2019_CONTAINER\u003c/code\u003e are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eIf you're using compute fleets during project creation, \u003ccode\u003etype\u003c/code\u003e will be ignored.\u003c/p\u003e \u003c/note\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html'\u003eBuild environment compute types\u003c/a\u003e in the \u003ci\u003eCodeBuild user guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectFileSystemLocation": { "description": "Definition of ProjectFileSystemLocation", "properties": { "identifier": { "type": "string", "description": "\u003cp\u003eThe name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the \u003ccode\u003eidentifier\u003c/code\u003e in all capital letters to \u003ccode\u003eCODEBUILD_\u003c/code\u003e. For example, if you specify \u003ccode\u003emy_efs\u003c/code\u003e for \u003ccode\u003eidentifier\u003c/code\u003e, a new environment variable is create named \u003ccode\u003eCODEBUILD_MY_EFS\u003c/code\u003e. \u003c/p\u003e \u003cp\u003e The \u003ccode\u003eidentifier\u003c/code\u003e is used to mount your file system. \u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eA string that specifies the location of the file system created by Amazon EFS. Its format is \u003ccode\u003eefs-dns-name:/directory-path\u003c/code\u003e. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is \u003ccode\u003efs-abcd1234.efs.us-west-2.amazonaws.com\u003c/code\u003e, and its mount directory is \u003ccode\u003emy-efs-mount-directory\u003c/code\u003e, then the \u003ccode\u003elocation\u003c/code\u003e is \u003ccode\u003efs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory\u003c/code\u003e. \u003c/p\u003e \u003cp\u003eThe directory path in the format \u003ccode\u003eefs-dns-name:/directory-path\u003c/code\u003e is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. \u003c/p\u003e" }, "mountOptions": { "type": "string", "description": "\u003cp\u003e The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are \u003ccode\u003enfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html'\u003eRecommended NFS Mount Options\u003c/a\u003e. \u003c/p\u003e" }, "mountPoint": { "type": "string", "description": "\u003cp\u003eThe location in the container where you mount the file system. \u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FileSystemTypeEnumValue", "description": "\u003cp\u003e The type of the file system. The one supported type is \u003ccode\u003eEFS\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectFileSystemLocationResponse": { "description": "Definition of ProjectFileSystemLocation", "properties": { "identifier": { "type": "string", "description": "\u003cp\u003eThe name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the \u003ccode\u003eidentifier\u003c/code\u003e in all capital letters to \u003ccode\u003eCODEBUILD_\u003c/code\u003e. For example, if you specify \u003ccode\u003emy_efs\u003c/code\u003e for \u003ccode\u003eidentifier\u003c/code\u003e, a new environment variable is create named \u003ccode\u003eCODEBUILD_MY_EFS\u003c/code\u003e. \u003c/p\u003e \u003cp\u003e The \u003ccode\u003eidentifier\u003c/code\u003e is used to mount your file system. \u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eA string that specifies the location of the file system created by Amazon EFS. Its format is \u003ccode\u003eefs-dns-name:/directory-path\u003c/code\u003e. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is \u003ccode\u003efs-abcd1234.efs.us-west-2.amazonaws.com\u003c/code\u003e, and its mount directory is \u003ccode\u003emy-efs-mount-directory\u003c/code\u003e, then the \u003ccode\u003elocation\u003c/code\u003e is \u003ccode\u003efs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory\u003c/code\u003e. \u003c/p\u003e \u003cp\u003eThe directory path in the format \u003ccode\u003eefs-dns-name:/directory-path\u003c/code\u003e is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system. \u003c/p\u003e" }, "mountOptions": { "type": "string", "description": "\u003cp\u003e The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are \u003ccode\u003enfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2\u003c/code\u003e. For more information, see \u003ca href='https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html'\u003eRecommended NFS Mount Options\u003c/a\u003e. \u003c/p\u003e" }, "mountPoint": { "type": "string", "description": "\u003cp\u003eThe location in the container where you mount the file system. \u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FileSystemTypeEnumValueResponse", "description": "\u003cp\u003e The type of the file system. The one supported type is \u003ccode\u003eEFS\u003c/code\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectFleet": { "description": "Definition of ProjectFleet", "properties": { "fleetArn": { "type": "string", "description": "\u003cp\u003eSpecifies the compute fleet ARN for the build project.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectFleetResponse": { "description": "Definition of ProjectFleet", "properties": { "fleetArn": { "type": "string", "description": "\u003cp\u003eSpecifies the compute fleet ARN for the build project.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectSource": { "description": "Definition of ProjectSource", "properties": { "auth": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceAuth", "description": "\u003cp\u003eInformation about the authorization settings for CodeBuild to access the source code to be built.\u003c/p\u003e \u003cp\u003eThis information is for the CodeBuild console's use only. Your code should not get or set this information directly.\u003c/p\u003e" }, "buildStatusConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BuildStatusConfig", "description": "\u003cp\u003eContains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is \u003ccode\u003eGITHUB\u003c/code\u003e, \u003ccode\u003eGITHUB_ENTERPRISE\u003c/code\u003e, or \u003ccode\u003eBITBUCKET\u003c/code\u003e.\u003c/p\u003e" }, "buildspec": { "type": "string", "description": "\u003cp\u003eThe buildspec file declaration to use for the builds in this build project.\u003c/p\u003e \u003cp\u003e If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in \u003ccode\u003eCODEBUILD_SRC_DIR\u003c/code\u003e environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, \u003ccode\u003earn:aws:s3:::my-codebuild-sample2/buildspec.yml\u003c/code\u003e). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage'\u003eBuildspec File Name and Storage Location\u003c/a\u003e. \u003c/p\u003e" }, "gitCloneDepth": { "type": "integer", "description": "\u003cp\u003eInformation about the Git clone depth for the build project.\u003c/p\u003e" }, "gitSubmodulesConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GitSubmodulesConfig", "description": "\u003cp\u003e Information about the Git submodules configuration for the build project. \u003c/p\u003e" }, "insecureSsl": { "type": "boolean", "description": "\u003cp\u003eEnable this flag to ignore SSL warnings while connecting to the project source code.\u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eInformation about the location of the source code to be built. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor source code settings that are specified in the source action of a pipeline in CodePipeline, \u003ccode\u003elocation\u003c/code\u003e should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, \u003ccode\u003ehttps://git-codecommit.\u0026lt;region-ID\u0026gt;.amazonaws.com/v1/repos/\u0026lt;repo-name\u0026gt;\u003c/code\u003e).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in an Amazon S3 input bucket, one of the following. \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe path to the ZIP file that contains the source code (for example, \u003ccode\u003e\u0026lt;bucket-name\u0026gt;/\u0026lt;path\u0026gt;/\u0026lt;object-name\u0026gt;.zip\u003c/code\u003e). \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe path to the folder that contains the source code (for example, \u003ccode\u003e\u0026lt;bucket-name\u0026gt;/\u0026lt;path-to-source-code\u0026gt;/\u0026lt;folder\u0026gt;/\u003c/code\u003e). \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub \u003cb\u003eAuthorize application\u003c/b\u003e page, for \u003cb\u003eOrganization access\u003c/b\u003e, choose \u003cb\u003eRequest access\u003c/b\u003e next to each repository you want to allow CodeBuild to have access to, and then choose \u003cb\u003eAuthorize application\u003c/b\u003e. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the \u003ccode\u003esource\u003c/code\u003e object, set the \u003ccode\u003eauth\u003c/code\u003e object's \u003ccode\u003etype\u003c/code\u003e value to \u003ccode\u003eOAUTH\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections \u003cb\u003eAuthorize application\u003c/b\u003e page, choose \u003cb\u003eAuthorize\u003c/b\u003e. Then on the CodeConnections \u003cb\u003eCreate GitLab connection\u003c/b\u003e page, choose \u003cb\u003eConnect to GitLab\u003c/b\u003e. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the \u003ccode\u003eauth\u003c/code\u003e object's \u003ccode\u003etype\u003c/code\u003e value to \u003ccode\u003eCODECONNECTIONS\u003c/code\u003e in the \u003ccode\u003esource\u003c/code\u003e object.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket \u003cb\u003eConfirm access to your account\u003c/b\u003e page, choose \u003cb\u003eGrant access\u003c/b\u003e. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the \u003ccode\u003esource\u003c/code\u003e object, set the \u003ccode\u003eauth\u003c/code\u003e object's \u003ccode\u003etype\u003c/code\u003e value to \u003ccode\u003eOAUTH\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e If you specify \u003ccode\u003eCODEPIPELINE\u003c/code\u003e for the \u003ccode\u003eType\u003c/code\u003e property, don't specify this property. For all of the other types, you must specify \u003ccode\u003eLocation\u003c/code\u003e. \u003c/p\u003e" }, "reportBuildStatus": { "type": "boolean", "description": "\u003cp\u003e Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an \u003ccode\u003einvalidInputException\u003c/code\u003e is thrown. \u003c/p\u003e \u003cp\u003eTo be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html'\u003eSource provider access\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eThe status of a build triggered by a webhook is always reported to your source provider. \u003c/p\u003e \u003cp\u003eIf your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.\u003c/p\u003e" }, "sourceIdentifier": { "type": "string", "description": "\u003cp\u003eAn identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. \u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceTypeEnumValue", "description": "\u003cp\u003eThe type of repository that contains the source code to be built. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBITBUCKET\u003c/code\u003e: The source code is in a Bitbucket repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODECOMMIT\u003c/code\u003e: The source code is in an CodeCommit repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODEPIPELINE\u003c/code\u003e: The source code settings are specified in the source action of a pipeline in CodePipeline.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITHUB\u003c/code\u003e: The source code is in a GitHub repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITHUB_ENTERPRISE\u003c/code\u003e: The source code is in a GitHub Enterprise Server repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITLAB\u003c/code\u003e: The source code is in a GitLab repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITLAB_SELF_MANAGED\u003c/code\u003e: The source code is in a self-managed GitLab repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_SOURCE\u003c/code\u003e: The project does not have input source code.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: The source code is in an Amazon S3 bucket.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectSourceResponse": { "description": "Definition of ProjectSource", "properties": { "auth": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceAuthResponse", "description": "\u003cp\u003eInformation about the authorization settings for CodeBuild to access the source code to be built.\u003c/p\u003e \u003cp\u003eThis information is for the CodeBuild console's use only. Your code should not get or set this information directly.\u003c/p\u003e" }, "buildStatusConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BuildStatusConfigResponse", "description": "\u003cp\u003eContains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is \u003ccode\u003eGITHUB\u003c/code\u003e, \u003ccode\u003eGITHUB_ENTERPRISE\u003c/code\u003e, or \u003ccode\u003eBITBUCKET\u003c/code\u003e.\u003c/p\u003e" }, "buildspec": { "type": "string", "description": "\u003cp\u003eThe buildspec file declaration to use for the builds in this build project.\u003c/p\u003e \u003cp\u003e If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in \u003ccode\u003eCODEBUILD_SRC_DIR\u003c/code\u003e environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, \u003ccode\u003earn:aws:s3:::my-codebuild-sample2/buildspec.yml\u003c/code\u003e). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage'\u003eBuildspec File Name and Storage Location\u003c/a\u003e. \u003c/p\u003e" }, "gitCloneDepth": { "type": "integer", "description": "\u003cp\u003eInformation about the Git clone depth for the build project.\u003c/p\u003e" }, "gitSubmodulesConfig": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GitSubmodulesConfigResponse", "description": "\u003cp\u003e Information about the Git submodules configuration for the build project. \u003c/p\u003e" }, "insecureSsl": { "type": "boolean", "description": "\u003cp\u003eEnable this flag to ignore SSL warnings while connecting to the project source code.\u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003eInformation about the location of the source code to be built. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor source code settings that are specified in the source action of a pipeline in CodePipeline, \u003ccode\u003elocation\u003c/code\u003e should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, \u003ccode\u003ehttps://git-codecommit.\u0026lt;region-ID\u0026gt;.amazonaws.com/v1/repos/\u0026lt;repo-name\u0026gt;\u003c/code\u003e).\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in an Amazon S3 input bucket, one of the following. \u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eThe path to the ZIP file that contains the source code (for example, \u003ccode\u003e\u0026lt;bucket-name\u0026gt;/\u0026lt;path\u0026gt;/\u0026lt;object-name\u0026gt;.zip\u003c/code\u003e). \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eThe path to the folder that contains the source code (for example, \u003ccode\u003e\u0026lt;bucket-name\u0026gt;/\u0026lt;path-to-source-code\u0026gt;/\u0026lt;folder\u0026gt;/\u003c/code\u003e). \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub \u003cb\u003eAuthorize application\u003c/b\u003e page, for \u003cb\u003eOrganization access\u003c/b\u003e, choose \u003cb\u003eRequest access\u003c/b\u003e next to each repository you want to allow CodeBuild to have access to, and then choose \u003cb\u003eAuthorize application\u003c/b\u003e. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the \u003ccode\u003esource\u003c/code\u003e object, set the \u003ccode\u003eauth\u003c/code\u003e object's \u003ccode\u003etype\u003c/code\u003e value to \u003ccode\u003eOAUTH\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections \u003cb\u003eAuthorize application\u003c/b\u003e page, choose \u003cb\u003eAuthorize\u003c/b\u003e. Then on the CodeConnections \u003cb\u003eCreate GitLab connection\u003c/b\u003e page, choose \u003cb\u003eConnect to GitLab\u003c/b\u003e. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the \u003ccode\u003eauth\u003c/code\u003e object's \u003ccode\u003etype\u003c/code\u003e value to \u003ccode\u003eCODECONNECTIONS\u003c/code\u003e in the \u003ccode\u003esource\u003c/code\u003e object.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket \u003cb\u003eConfirm access to your account\u003c/b\u003e page, choose \u003cb\u003eGrant access\u003c/b\u003e. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the \u003ccode\u003esource\u003c/code\u003e object, set the \u003ccode\u003eauth\u003c/code\u003e object's \u003ccode\u003etype\u003c/code\u003e value to \u003ccode\u003eOAUTH\u003c/code\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e If you specify \u003ccode\u003eCODEPIPELINE\u003c/code\u003e for the \u003ccode\u003eType\u003c/code\u003e property, don't specify this property. For all of the other types, you must specify \u003ccode\u003eLocation\u003c/code\u003e. \u003c/p\u003e" }, "reportBuildStatus": { "type": "boolean", "description": "\u003cp\u003e Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an \u003ccode\u003einvalidInputException\u003c/code\u003e is thrown. \u003c/p\u003e \u003cp\u003eTo be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html'\u003eSource provider access\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eThe status of a build triggered by a webhook is always reported to your source provider. \u003c/p\u003e \u003cp\u003eIf your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.\u003c/p\u003e" }, "sourceIdentifier": { "type": "string", "description": "\u003cp\u003eAn identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. \u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceTypeEnumValueResponse", "description": "\u003cp\u003eThe type of repository that contains the source code to be built. Valid values include:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eBITBUCKET\u003c/code\u003e: The source code is in a Bitbucket repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODECOMMIT\u003c/code\u003e: The source code is in an CodeCommit repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eCODEPIPELINE\u003c/code\u003e: The source code settings are specified in the source action of a pipeline in CodePipeline.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITHUB\u003c/code\u003e: The source code is in a GitHub repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITHUB_ENTERPRISE\u003c/code\u003e: The source code is in a GitHub Enterprise Server repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITLAB\u003c/code\u003e: The source code is in a GitLab repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eGITLAB_SELF_MANAGED\u003c/code\u003e: The source code is in a self-managed GitLab repository.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eNO_SOURCE\u003c/code\u003e: The project does not have input source code.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eS3\u003c/code\u003e: The source code is in an Amazon S3 bucket.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectSourceVersion": { "description": "Definition of ProjectSourceVersion", "properties": { "sourceIdentifier": { "type": "string", "description": "\u003cp\u003eAn identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. \u003c/p\u003e" }, "sourceVersion": { "type": "string", "description": "\u003cp\u003eThe source version for the corresponding source identifier. If specified, must be one of:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor CodeCommit: the commit ID, branch, or Git tag to use.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor GitHub or GitLab: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format \u003ccode\u003epr/pull-request-ID\u003c/code\u003e (for example, \u003ccode\u003epr/25\u003c/code\u003e). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Amazon S3: the version ID of the object that represents the build input ZIP file to use.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'\u003eSource Version Sample with CodeBuild\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectSourceVersionResponse": { "description": "Definition of ProjectSourceVersion", "properties": { "sourceIdentifier": { "type": "string", "description": "\u003cp\u003eAn identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. \u003c/p\u003e" }, "sourceVersion": { "type": "string", "description": "\u003cp\u003eThe source version for the corresponding source identifier. If specified, must be one of:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eFor CodeCommit: the commit ID, branch, or Git tag to use.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor GitHub or GitLab: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format \u003ccode\u003epr/pull-request-ID\u003c/code\u003e (for example, \u003ccode\u003epr/25\u003c/code\u003e). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eFor Amazon S3: the version ID of the object that represents the build input ZIP file to use.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003e For more information, see \u003ca href='https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html'\u003eSource Version Sample with CodeBuild\u003c/a\u003e in the \u003ci\u003eCodeBuild User Guide\u003c/i\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProjectVisibilityType": { "description": "Property value", "type": "string", "enum": [ { "name": "PRIVATE", "description": "ProjectVisibilityType enum PRIVATE", "value": "PRIVATE" }, { "name": "PUBLIC_READ", "description": "ProjectVisibilityType enum PUBLIC_READ", "value": "PUBLIC_READ" } ] }, "azure-native:awsconnector:ProjectVisibilityTypeEnumValue": { "description": "Definition of ProjectVisibilityTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ProjectVisibilityType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ProjectVisibilityTypeEnumValueResponse": { "description": "Definition of ProjectVisibilityTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Projection": { "description": "Definition of Projection", "properties": { "nonKeyAttributes": { "type": "array", "items": { "type": "string" }, "description": "Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total." }, "projectionType": { "type": "string", "description": "The set of attributes that are projected into the index: + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + ``ALL`` - All of the table attributes are projected into the index. When using the DynamoDB console, ``ALL`` is selected by default." } }, "type": "object" }, "azure-native:awsconnector:ProjectionResponse": { "description": "Definition of Projection", "properties": { "nonKeyAttributes": { "type": "array", "items": { "type": "string" }, "description": "Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total." }, "projectionType": { "type": "string", "description": "The set of attributes that are projected into the index: + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + ``ALL`` - All of the table attributes are projected into the index. When using the DynamoDB console, ``ALL`` is selected by default." } }, "type": "object" }, "azure-native:awsconnector:PropagateTags": { "description": "Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. The default is ``NONE``.", "type": "string", "enum": [ { "name": "SERVICE", "description": "PropagateTags enum SERVICE", "value": "SERVICE" }, { "name": "TASK_DEFINITION", "description": "PropagateTags enum TASK_DEFINITION", "value": "TASK_DEFINITION" } ] }, "azure-native:awsconnector:PropertyValueType": { "description": "Property value", "type": "string", "enum": [ { "name": "PLAIN_TEXT", "description": "PropertyValueType enum PLAIN_TEXT", "value": "PLAIN_TEXT" }, { "name": "STRINGIFIED_JSON", "description": "PropertyValueType enum STRINGIFIED_JSON", "value": "STRINGIFIED_JSON" } ] }, "azure-native:awsconnector:PropertyValueTypeEnumValue": { "description": "Definition of PropertyValueTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:PropertyValueType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:PropertyValueTypeEnumValueResponse": { "description": "Definition of PropertyValueTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ProposedMultiRegionAccessPointPolicy": { "description": "Definition of ProposedMultiRegionAccessPointPolicy", "properties": { "policy": { "type": "string", "description": "\u003cp\u003eThe details of the proposed policy.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProposedMultiRegionAccessPointPolicyResponse": { "description": "Definition of ProposedMultiRegionAccessPointPolicy", "properties": { "policy": { "type": "string", "description": "\u003cp\u003eThe details of the proposed policy.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:Provider": { "description": "Definition of Provider", "properties": { "keyArn": { "type": "string", "description": "\u003cp\u003eAmazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the \u003ca href='https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html'\u003eIAM principal\u003c/a\u003e must have access to the KMS key. For more information, see \u003ca href='https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html'\u003eAllowing users in other accounts to use a KMS key\u003c/a\u003e in the \u003ci\u003eKey Management Service Developer Guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProviderResponse": { "description": "Definition of Provider", "properties": { "keyArn": { "type": "string", "description": "\u003cp\u003eAmazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the \u003ca href='https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_terms-and-concepts.html'\u003eIAM principal\u003c/a\u003e must have access to the KMS key. For more information, see \u003ca href='https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-modifying-external-accounts.html'\u003eAllowing users in other accounts to use a KMS key\u003c/a\u003e in the \u003ci\u003eKey Management Service Developer Guide\u003c/i\u003e.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ProvisionedThroughput": { "description": "Definition of ProvisionedThroughput", "properties": { "readCapacityUnits": { "type": "integer", "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." }, "writeCapacityUnits": { "type": "integer", "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." } }, "type": "object" }, "azure-native:awsconnector:ProvisionedThroughputResponse": { "description": "Definition of ProvisionedThroughput", "properties": { "readCapacityUnits": { "type": "integer", "description": "The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." }, "writeCapacityUnits": { "type": "integer", "description": "The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0." } }, "type": "object" }, "azure-native:awsconnector:ProxyConfiguration": { "description": "Definition of ProxyConfiguration", "properties": { "containerName": { "type": "string", "description": "The name of the container that will serve as the App Mesh proxy." }, "proxyConfigurationProperties": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeyValuePair" }, "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list." }, "type": { "type": "string", "description": "The proxy type. The only supported value is ``APPMESH``." } }, "type": "object" }, "azure-native:awsconnector:ProxyConfigurationResponse": { "description": "Definition of ProxyConfiguration", "properties": { "containerName": { "type": "string", "description": "The name of the container that will serve as the App Mesh proxy." }, "proxyConfigurationProperties": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:KeyValuePairResponse" }, "description": "The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list." }, "type": { "type": "string", "description": "The proxy type. The only supported value is ``APPMESH``." } }, "type": "object" }, "azure-native:awsconnector:PublicAccessBlockConfiguration": { "description": "Definition of PublicAccessBlockConfiguration", "properties": { "blockPublicAcls": { "type": "boolean", "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior: + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs." }, "blockPublicPolicy": { "type": "boolean", "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies." }, "ignorePublicAcls": { "type": "boolean", "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." }, "restrictPublicBuckets": { "type": "boolean", "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." } }, "type": "object" }, "azure-native:awsconnector:PublicAccessBlockConfigurationResponse": { "description": "Definition of PublicAccessBlockConfiguration", "properties": { "blockPublicAcls": { "type": "boolean", "description": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior: + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs." }, "blockPublicPolicy": { "type": "boolean", "description": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies." }, "ignorePublicAcls": { "type": "boolean", "description": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set." }, "restrictPublicBuckets": { "type": "boolean", "description": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked." } }, "type": "object" }, "azure-native:awsconnector:PublishMetricAction": { "description": "Definition of PublishMetricAction", "properties": { "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Dimension" }, "description": "Property dimensions" } }, "type": "object" }, "azure-native:awsconnector:PublishMetricActionResponse": { "description": "Definition of PublishMetricAction", "properties": { "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DimensionResponseV2" }, "description": "Property dimensions" } }, "type": "object" }, "azure-native:awsconnector:PublishMetricActionResponseV1": { "description": "Definition of PublishMetricAction", "properties": { "dimensions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DimensionResponseV3" }, "description": "Property dimensions" } }, "type": "object" }, "azure-native:awsconnector:QueryLoggingConfig": { "description": "Definition of QueryLoggingConfig", "properties": { "cloudWatchLogsLogGroupArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to." } }, "type": "object" }, "azure-native:awsconnector:QueryLoggingConfigResponse": { "description": "Definition of QueryLoggingConfig", "properties": { "cloudWatchLogsLogGroupArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to." } }, "type": "object" }, "azure-native:awsconnector:QueueConfiguration": { "description": "Definition of QueueConfiguration", "properties": { "event": { "type": "string", "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." }, "filter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotificationFilter", "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." }, "queue": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination." } }, "type": "object" }, "azure-native:awsconnector:QueueConfigurationResponse": { "description": "Definition of QueueConfiguration", "properties": { "event": { "type": "string", "description": "The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*." }, "filter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NotificationFilterResponse", "description": "The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*." }, "queue": { "type": "string", "description": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination." } }, "type": "object" }, "azure-native:awsconnector:RRType": { "description": "Property value", "type": "string", "enum": [ { "name": "A", "description": "RRType enum A", "value": "A" }, { "name": "AAAA", "description": "RRType enum AAAA", "value": "AAAA" }, { "name": "CAA", "description": "RRType enum CAA", "value": "CAA" }, { "name": "CNAME", "description": "RRType enum CNAME", "value": "CNAME" }, { "name": "DS", "description": "RRType enum DS", "value": "DS" }, { "name": "MX", "description": "RRType enum MX", "value": "MX" }, { "name": "NAPTR", "description": "RRType enum NAPTR", "value": "NAPTR" }, { "name": "NS", "description": "RRType enum NS", "value": "NS" }, { "name": "PTR", "description": "RRType enum PTR", "value": "PTR" }, { "name": "SOA", "description": "RRType enum SOA", "value": "SOA" }, { "name": "SPF", "description": "RRType enum SPF", "value": "SPF" }, { "name": "SRV", "description": "RRType enum SRV", "value": "SRV" }, { "name": "TXT", "description": "RRType enum TXT", "value": "TXT" } ] }, "azure-native:awsconnector:RRTypeEnumValue": { "description": "Definition of RRTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RRType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RRTypeEnumValueResponse": { "description": "Definition of RRTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RdsDBClusterProperties": { "description": "Definition of RdsDBCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBClusterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RdsDBClusterPropertiesResponse": { "description": "Definition of RdsDBCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBClusterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RdsDBInstanceProperties": { "description": "Definition of RdsDBInstance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBInstanceProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RdsDBInstancePropertiesResponse": { "description": "Definition of RdsDBInstance", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBInstancePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RdsDBSnapshotAttributesResultProperties": { "description": "Definition of RdsDBSnapshotAttributesResult", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBSnapshotAttributesResultProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RdsDBSnapshotAttributesResultPropertiesResponse": { "description": "Definition of RdsDBSnapshotAttributesResult", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBSnapshotAttributesResultPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RdsDBSnapshotProperties": { "description": "Definition of RdsDBSnapshot", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBSnapshotProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RdsDBSnapshotPropertiesResponse": { "description": "Definition of RdsDBSnapshot", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsDBSnapshotPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RdsDbClusterEndpoint": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "The connection endpoint for the DB cluster." }, "port": { "type": "string", "description": "The port number that will accept connections on this DB cluster." } }, "type": "object" }, "azure-native:awsconnector:RdsDbClusterEndpointResponse": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "The connection endpoint for the DB cluster." }, "port": { "type": "string", "description": "The port number that will accept connections on this DB cluster." } }, "type": "object" }, "azure-native:awsconnector:RdsDbInstanceEndpoint": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "Specifies the DNS address of the DB instance." }, "hostedZoneId": { "type": "string", "description": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone." }, "port": { "type": "string", "description": "Specifies the port that the database engine is listening on." } }, "type": "object" }, "azure-native:awsconnector:RdsDbInstanceEndpointResponse": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "Specifies the DNS address of the DB instance." }, "hostedZoneId": { "type": "string", "description": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone." }, "port": { "type": "string", "description": "Specifies the port that the database engine is listening on." } }, "type": "object" }, "azure-native:awsconnector:RdsEventSubscriptionProperties": { "description": "Definition of RdsEventSubscription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsEventSubscriptionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RdsEventSubscriptionPropertiesResponse": { "description": "Definition of RdsEventSubscription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsEventSubscriptionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RdsExportTaskProperties": { "description": "Definition of RdsExportTask", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsExportTaskProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RdsExportTaskPropertiesResponse": { "description": "Definition of RdsExportTask", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRdsExportTaskPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ReadEndpoint": { "description": "Definition of ReadEndpoint", "properties": { "address": { "type": "string", "description": "The reader endpoint for the DB cluster." } }, "type": "object" }, "azure-native:awsconnector:ReadEndpointResponse": { "description": "Definition of ReadEndpoint", "properties": { "address": { "type": "string", "description": "The reader endpoint for the DB cluster." } }, "type": "object" }, "azure-native:awsconnector:RecorderStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "Failure", "description": "RecorderStatus enum Failure", "value": "Failure" }, { "name": "Pending", "description": "RecorderStatus enum Pending", "value": "Pending" }, { "name": "Success", "description": "RecorderStatus enum Success", "value": "Success" } ] }, "azure-native:awsconnector:RecorderStatusEnumValue": { "description": "Definition of RecorderStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RecorderStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RecorderStatusEnumValueResponse": { "description": "Definition of RecorderStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RecordingFrequency": { "description": "Property value", "type": "string", "enum": [ { "name": "CONTINUOUS", "description": "RecordingFrequency enum CONTINUOUS", "value": "CONTINUOUS" }, { "name": "DAILY", "description": "RecordingFrequency enum DAILY", "value": "DAILY" } ] }, "azure-native:awsconnector:RecordingFrequencyEnumValue": { "description": "Definition of RecordingFrequencyEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RecordingFrequency" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RecordingFrequencyEnumValueResponse": { "description": "Definition of RecordingFrequencyEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RecordingGroup": { "description": "Definition of RecordingGroup", "properties": { "allSupported": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.\u003c/p\u003e \u003cp\u003eIf you set this field to \u003ccode\u003etrue\u003c/code\u003e, when Config adds support for a new resource type, Config starts recording resources of that type automatically.\u003c/p\u003e \u003cp\u003eIf you set this field to \u003ccode\u003etrue\u003c/code\u003e, you cannot enumerate specific resource types to record in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e, or to exclude in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRegion availability\u003c/b\u003e \u003c/p\u003e \u003cp\u003eCheck \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'\u003eResource Coverage by Region Availability\u003c/a\u003e to see if a resource type is supported in the Amazon Web Services Region where you set up Config.\u003c/p\u003e \u003c/note\u003e" }, "exclusionByResourceTypes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExclusionByResourceTypes", "description": "\u003cp\u003eAn object that specifies how Config excludes resource types from being recorded by the configuration recorder.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eTo use this option, you must set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e" }, "includeGlobalResourceTypes": { "type": "boolean", "description": "\u003cp\u003eThis option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Hyderabad)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Melbourne)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCanada West (Calgary)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Spain)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Zurich)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIsrael (Tel Aviv)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eMiddle East (UAE)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cimportant\u003e \u003cp\u003e \u003cb\u003eAurora global clusters are recorded in all enabled Regions\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e is set\u003ccode\u003efalse\u003c/code\u003e. The \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e option is a bundle which only applies to IAM users, groups, roles, and customer managed policies. \u003c/p\u003e \u003cp\u003eIf you do not want to record \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e in all enabled Regions, use one of the following recording strategies:\u003c/p\u003e \u003col\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eRecord all current and future resource types with exclusions\u003c/b\u003e (\u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e), or\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eRecord specific resource types\u003c/b\u003e (\u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e).\u003c/p\u003e \u003c/li\u003e \u003c/ol\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all'\u003eSelecting Which Resources are Recorded\u003c/a\u003e in the \u003ci\u003eConfig developer guide\u003c/i\u003e.\u003c/p\u003e \u003c/important\u003e \u003cimportant\u003e \u003cp\u003e \u003cb\u003eincludeGlobalResourceTypes and the exclusion recording strategy\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field has no impact on the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy. This means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e when \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e is set to \u003ccode\u003efalse\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field should only be used to modify the \u003ccode\u003eAllSupported\u003c/code\u003e field, as the default for the \u003ccode\u003eAllSupported\u003c/code\u003e field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when \u003ccode\u003eAllSupported\u003c/code\u003e is set to \u003ccode\u003etrue\u003c/code\u003e, make sure to set \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eTo exclude the global IAM resource types for the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy, you need to manually add them to the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e.\u003c/p\u003e \u003c/important\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBefore you set this field to \u003ccode\u003etrue\u003c/code\u003e, set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e. Optionally, you can set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eOverriding fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you set this field to \u003ccode\u003efalse\u003c/code\u003e but list global IAM resource types in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e, Config will still record configuration changes for those specified resource types \u003ci\u003eregardless\u003c/i\u003e of if you set the \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field to false.\u003c/p\u003e \u003cp\u003eIf you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the \u003ccode\u003eresourceTypes\u003c/code\u003e field in addition to setting the \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field to false.\u003c/p\u003e \u003c/note\u003e" }, "recordingStrategy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingStrategy", "description": "\u003cp\u003eAn object that specifies the recording strategy for the configuration recorder.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e. When Config adds support for a new resource type, Config automatically starts recording resources of that type.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for only the resource types you specify in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you list resource types in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is required if you list resource types to exclude from recording in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eOverriding fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you choose \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e for the recording strategy, the \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e field will override other properties in the request.\u003c/p\u003e \u003cp\u003eFor example, even if you set \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eGlobal resources types and the resource exclusion recording strategy\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBy default, if you choose the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.\u003c/p\u003e \u003cp\u003eUnless specifically listed as exclusions, \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\u003c/p\u003e \u003cp\u003eIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Hyderabad)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Melbourne)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCanada West (Calgary)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Spain)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Zurich)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIsrael (Tel Aviv)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eMiddle East (UAE)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/note\u003e" }, "resourceTypes": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceType" } ] }, "description": "\u003cp\u003eA comma-separated list that specifies which resource types Config records.\u003c/p\u003e \u003cp\u003eFor a list of valid \u003ccode\u003eresourceTypes\u003c/code\u003e values, see the \u003cb\u003eResource Type Value\u003c/b\u003e column in \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'\u003eSupported Amazon Web Services resource Types\u003c/a\u003e in the \u003ci\u003eConfig developer guide\u003c/i\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eOptionally, you can set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eTo record all configuration changes, set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e, and either omit this field or don't specify any resource types in this field. If you set the \u003ccode\u003eallSupported\u003c/code\u003e field to \u003ccode\u003efalse\u003c/code\u003e and specify values for \u003ccode\u003eresourceTypes\u003c/code\u003e, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRegion availability\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBefore specifying a resource type for Config to track, check \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'\u003eResource Coverage by Region Availability\u003c/a\u003e to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.\u003c/p\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingGroupResponse": { "description": "Definition of RecordingGroup", "properties": { "allSupported": { "type": "boolean", "description": "\u003cp\u003eSpecifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.\u003c/p\u003e \u003cp\u003eIf you set this field to \u003ccode\u003etrue\u003c/code\u003e, when Config adds support for a new resource type, Config starts recording resources of that type automatically.\u003c/p\u003e \u003cp\u003eIf you set this field to \u003ccode\u003etrue\u003c/code\u003e, you cannot enumerate specific resource types to record in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e, or to exclude in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRegion availability\u003c/b\u003e \u003c/p\u003e \u003cp\u003eCheck \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'\u003eResource Coverage by Region Availability\u003c/a\u003e to see if a resource type is supported in the Amazon Web Services Region where you set up Config.\u003c/p\u003e \u003c/note\u003e" }, "exclusionByResourceTypes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ExclusionByResourceTypesResponse", "description": "\u003cp\u003eAn object that specifies how Config excludes resource types from being recorded by the configuration recorder.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eTo use this option, you must set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e" }, "includeGlobalResourceTypes": { "type": "boolean", "description": "\u003cp\u003eThis option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Hyderabad)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Melbourne)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCanada West (Calgary)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Spain)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Zurich)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIsrael (Tel Aviv)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eMiddle East (UAE)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cimportant\u003e \u003cp\u003e \u003cb\u003eAurora global clusters are recorded in all enabled Regions\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e is set\u003ccode\u003efalse\u003c/code\u003e. The \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e option is a bundle which only applies to IAM users, groups, roles, and customer managed policies. \u003c/p\u003e \u003cp\u003eIf you do not want to record \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e in all enabled Regions, use one of the following recording strategies:\u003c/p\u003e \u003col\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eRecord all current and future resource types with exclusions\u003c/b\u003e (\u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e), or\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003cb\u003eRecord specific resource types\u003c/b\u003e (\u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e).\u003c/p\u003e \u003c/li\u003e \u003c/ol\u003e \u003cp\u003eFor more information, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-all'\u003eSelecting Which Resources are Recorded\u003c/a\u003e in the \u003ci\u003eConfig developer guide\u003c/i\u003e.\u003c/p\u003e \u003c/important\u003e \u003cimportant\u003e \u003cp\u003e \u003cb\u003eincludeGlobalResourceTypes and the exclusion recording strategy\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field has no impact on the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy. This means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e when \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e is set to \u003ccode\u003efalse\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field should only be used to modify the \u003ccode\u003eAllSupported\u003c/code\u003e field, as the default for the \u003ccode\u003eAllSupported\u003c/code\u003e field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when \u003ccode\u003eAllSupported\u003c/code\u003e is set to \u003ccode\u003etrue\u003c/code\u003e, make sure to set \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eTo exclude the global IAM resource types for the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy, you need to manually add them to the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e.\u003c/p\u003e \u003c/important\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBefore you set this field to \u003ccode\u003etrue\u003c/code\u003e, set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e. Optionally, you can set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eOverriding fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you set this field to \u003ccode\u003efalse\u003c/code\u003e but list global IAM resource types in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e, Config will still record configuration changes for those specified resource types \u003ci\u003eregardless\u003c/i\u003e of if you set the \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field to false.\u003c/p\u003e \u003cp\u003eIf you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the \u003ccode\u003eresourceTypes\u003c/code\u003e field in addition to setting the \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e field to false.\u003c/p\u003e \u003c/note\u003e" }, "recordingStrategy": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingStrategyResponse", "description": "\u003cp\u003eAn object that specifies the recording strategy for the configuration recorder.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e. When Config adds support for a new resource type, Config automatically starts recording resources of that type.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for only the resource types you specify in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you list resource types in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is required if you list resource types to exclude from recording in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eOverriding fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you choose \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e for the recording strategy, the \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e field will override other properties in the request.\u003c/p\u003e \u003cp\u003eFor example, even if you set \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eGlobal resources types and the resource exclusion recording strategy\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBy default, if you choose the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.\u003c/p\u003e \u003cp\u003eUnless specifically listed as exclusions, \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\u003c/p\u003e \u003cp\u003eIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Hyderabad)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Melbourne)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCanada West (Calgary)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Spain)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Zurich)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIsrael (Tel Aviv)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eMiddle East (UAE)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/note\u003e" }, "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA comma-separated list that specifies which resource types Config records.\u003c/p\u003e \u003cp\u003eFor a list of valid \u003ccode\u003eresourceTypes\u003c/code\u003e values, see the \u003cb\u003eResource Type Value\u003c/b\u003e column in \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'\u003eSupported Amazon Web Services resource Types\u003c/a\u003e in the \u003ci\u003eConfig developer guide\u003c/i\u003e.\u003c/p\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eOptionally, you can set the \u003ccode\u003euseOnly\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingStrategy.html'\u003eRecordingStrategy\u003c/a\u003e to \u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eTo record all configuration changes, set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e, and either omit this field or don't specify any resource types in this field. If you set the \u003ccode\u003eallSupported\u003c/code\u003e field to \u003ccode\u003efalse\u003c/code\u003e and specify values for \u003ccode\u003eresourceTypes\u003c/code\u003e, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRegion availability\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBefore specifying a resource type for Config to track, check \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/what-is-resource-config-coverage.html'\u003eResource Coverage by Region Availability\u003c/a\u003e to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.\u003c/p\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingMode": { "description": "Definition of RecordingMode", "properties": { "recordingFrequency": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingFrequencyEnumValue", "description": "\u003cp\u003eThe default recording frequency that Config uses to record configuration changes.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eDaily recording is not supported for the following resource types:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ResourceCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConformancePackCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConfigurationRecorder\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor the \u003cb\u003eallSupported\u003c/b\u003e (\u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e) recording strategy, these resource types will be set to Continuous recording.\u003c/p\u003e \u003c/important\u003e" }, "recordingModeOverrides": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingModeOverride" }, "description": "\u003cp\u003eAn array of \u003ccode\u003erecordingModeOverride\u003c/code\u003e objects for you to specify your overrides for the recording mode. The \u003ccode\u003erecordingModeOverride\u003c/code\u003e object in the \u003ccode\u003erecordingModeOverrides\u003c/code\u003e array consists of three fields: a \u003ccode\u003edescription\u003c/code\u003e, the new \u003ccode\u003erecordingFrequency\u003c/code\u003e, and an array of \u003ccode\u003eresourceTypes\u003c/code\u003e to override.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingModeOverride": { "description": "Definition of RecordingModeOverride", "properties": { "description": { "type": "string", "description": "\u003cp\u003eA description that you provide for the override.\u003c/p\u003e" }, "recordingFrequency": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingFrequencyEnumValue", "description": "\u003cp\u003eThe recording frequency that will be applied to all the resource types specified in the override.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eContinuous recording allows you to record configuration changes continuously whenever a change occurs.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eDaily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eFirewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.\u003c/p\u003e \u003c/note\u003e" }, "resourceTypes": { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceType" } ] }, "description": "\u003cp\u003eA comma-separated list that specifies which resource types Config includes in the override.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eDaily recording is not supported for the following resource types:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ResourceCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConformancePackCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConfigurationRecorder\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/important\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingModeOverrideResponse": { "description": "Definition of RecordingModeOverride", "properties": { "description": { "type": "string", "description": "\u003cp\u003eA description that you provide for the override.\u003c/p\u003e" }, "recordingFrequency": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingFrequencyEnumValueResponse", "description": "\u003cp\u003eThe recording frequency that will be applied to all the resource types specified in the override.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eContinuous recording allows you to record configuration changes continuously whenever a change occurs.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eDaily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded. \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003eFirewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.\u003c/p\u003e \u003c/note\u003e" }, "resourceTypes": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eA comma-separated list that specifies which resource types Config includes in the override.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eDaily recording is not supported for the following resource types:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ResourceCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConformancePackCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConfigurationRecorder\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/important\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingModeResponse": { "description": "Definition of RecordingMode", "properties": { "recordingFrequency": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingFrequencyEnumValueResponse", "description": "\u003cp\u003eThe default recording frequency that Config uses to record configuration changes.\u003c/p\u003e \u003cimportant\u003e \u003cp\u003eDaily recording is not supported for the following resource types:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ResourceCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConformancePackCompliance\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eAWS::Config::ConfigurationRecorder\u003c/code\u003e \u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cp\u003eFor the \u003cb\u003eallSupported\u003c/b\u003e (\u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e) recording strategy, these resource types will be set to Continuous recording.\u003c/p\u003e \u003c/important\u003e" }, "recordingModeOverrides": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingModeOverrideResponse" }, "description": "\u003cp\u003eAn array of \u003ccode\u003erecordingModeOverride\u003c/code\u003e objects for you to specify your overrides for the recording mode. The \u003ccode\u003erecordingModeOverride\u003c/code\u003e object in the \u003ccode\u003erecordingModeOverrides\u003c/code\u003e array consists of three fields: a \u003ccode\u003edescription\u003c/code\u003e, the new \u003ccode\u003erecordingFrequency\u003c/code\u003e, and an array of \u003ccode\u003eresourceTypes\u003c/code\u003e to override.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingStrategy": { "description": "Definition of RecordingStrategy", "properties": { "useOnly": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingStrategyTypeEnumValue", "description": "\u003cp\u003eThe recording strategy for the configuration recorder.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you set this option to \u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e. When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'\u003eSupported Resource Types\u003c/a\u003e in the \u003ci\u003eConfig developer guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set this option to \u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for only the resource types that you specify in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set this option to \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you list resource types in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is required if you list resource types to exclude from recording in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eOverriding fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you choose \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e for the recording strategy, the \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e field will override other properties in the request.\u003c/p\u003e \u003cp\u003eFor example, even if you set \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eGlobal resource types and the exclusion recording strategy\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBy default, if you choose the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.\u003c/p\u003e \u003cp\u003eUnless specifically listed as exclusions, \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\u003c/p\u003e \u003cp\u003eIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Hyderabad)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Melbourne)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCanada West (Calgary)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Spain)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Zurich)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIsrael (Tel Aviv)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eMiddle East (UAE)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingStrategyResponse": { "description": "Definition of RecordingStrategy", "properties": { "useOnly": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RecordingStrategyTypeEnumValueResponse", "description": "\u003cp\u003eThe recording strategy for the configuration recorder.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eIf you set this option to \u003ccode\u003eALL_SUPPORTED_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e. When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see \u003ca href='https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources'\u003eSupported Resource Types\u003c/a\u003e in the \u003ci\u003eConfig developer guide\u003c/i\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set this option to \u003ccode\u003eINCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for only the resource types that you specify in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIf you set this option to \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eRequired and optional fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you set the \u003ccode\u003eallSupported\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e to \u003ccode\u003etrue\u003c/code\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is optional when you list resource types in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_RecordingGroup.html'\u003eRecordingGroup\u003c/a\u003e.\u003c/p\u003e \u003cp\u003eThe \u003ccode\u003erecordingStrategy\u003c/code\u003e field is required if you list resource types to exclude from recording in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ca href='https://docs.aws.amazon.com/config/latest/APIReference/API_ExclusionByResourceTypes.html'\u003eExclusionByResourceTypes\u003c/a\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eOverriding fields\u003c/b\u003e \u003c/p\u003e \u003cp\u003eIf you choose \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e for the recording strategy, the \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e field will override other properties in the request.\u003c/p\u003e \u003cp\u003eFor example, even if you set \u003ccode\u003eincludeGlobalResourceTypes\u003c/code\u003e to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the \u003ccode\u003eresourceTypes\u003c/code\u003e field of \u003ccode\u003eexclusionByResourceTypes\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e \u003cnote\u003e \u003cp\u003e \u003cb\u003eGlobal resource types and the exclusion recording strategy\u003c/b\u003e \u003c/p\u003e \u003cp\u003eBy default, if you choose the \u003ccode\u003eEXCLUSION_BY_RESOURCE_TYPES\u003c/code\u003e recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.\u003c/p\u003e \u003cp\u003eUnless specifically listed as exclusions, \u003ccode\u003eAWS::RDS::GlobalCluster\u003c/code\u003e will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.\u003c/p\u003e \u003cp\u003eIAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Hyderabad)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eAsia Pacific (Melbourne)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eCanada West (Calgary)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Spain)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eEurope (Zurich)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eIsrael (Tel Aviv)\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003eMiddle East (UAE)\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:RecordingStrategyType": { "description": "Property value", "type": "string", "enum": [ { "name": "ALL_SUPPORTED_RESOURCE_TYPES", "description": "RecordingStrategyType enum ALL_SUPPORTED_RESOURCE_TYPES", "value": "ALL_SUPPORTED_RESOURCE_TYPES" }, { "name": "EXCLUSION_BY_RESOURCE_TYPES", "description": "RecordingStrategyType enum EXCLUSION_BY_RESOURCE_TYPES", "value": "EXCLUSION_BY_RESOURCE_TYPES" }, { "name": "INCLUSION_BY_RESOURCE_TYPES", "description": "RecordingStrategyType enum INCLUSION_BY_RESOURCE_TYPES", "value": "INCLUSION_BY_RESOURCE_TYPES" } ] }, "azure-native:awsconnector:RecordingStrategyTypeEnumValue": { "description": "Definition of RecordingStrategyTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RecordingStrategyType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RecordingStrategyTypeEnumValueResponse": { "description": "Definition of RecordingStrategyTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RedirectAllRequestsTo": { "description": "Definition of RedirectAllRequestsTo", "properties": { "hostName": { "type": "string", "description": "Name of the host where requests are redirected." }, "protocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RedirectAllRequestsToProtocol" } ], "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." } }, "type": "object" }, "azure-native:awsconnector:RedirectAllRequestsToProtocol": { "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.", "type": "string", "enum": [ { "name": "http", "description": "RedirectAllRequestsToProtocol enum http", "value": "http" }, { "name": "https", "description": "RedirectAllRequestsToProtocol enum https", "value": "https" } ] }, "azure-native:awsconnector:RedirectAllRequestsToResponse": { "description": "Definition of RedirectAllRequestsTo", "properties": { "hostName": { "type": "string", "description": "Name of the host where requests are redirected." }, "protocol": { "type": "string", "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." } }, "type": "object" }, "azure-native:awsconnector:RedirectConfigResponse": { "description": "Definition of RedirectConfig", "properties": { "host": { "type": "string", "description": "The hostname. This component is not percent-encoded. The hostname can contain #{host}." }, "path": { "type": "string", "description": "The absolute path, starting with the leading '/'. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}." }, "port": { "type": "string", "description": "The port. You can specify a value from 1 to 65535 or #{port}." }, "protocol": { "type": "string", "description": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP." }, "query": { "type": "string", "description": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading '?', as it is automatically added. You can specify any of the reserved keywords." }, "statusCode": { "type": "string", "description": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302)." } }, "type": "object" }, "azure-native:awsconnector:RedirectRule": { "description": "Definition of RedirectRule", "properties": { "hostName": { "type": "string", "description": "The host name to use in the redirect request." }, "httpRedirectCode": { "type": "string", "description": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." }, "protocol": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RedirectRuleProtocol" } ], "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." }, "replaceKeyPrefixWith": { "type": "string", "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "replaceKeyWith": { "type": "string", "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." } }, "type": "object" }, "azure-native:awsconnector:RedirectRuleProtocol": { "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.", "type": "string", "enum": [ { "name": "http", "description": "RedirectRuleProtocol enum http", "value": "http" }, { "name": "https", "description": "RedirectRuleProtocol enum https", "value": "https" } ] }, "azure-native:awsconnector:RedirectRuleResponse": { "description": "Definition of RedirectRule", "properties": { "hostName": { "type": "string", "description": "The host name to use in the redirect request." }, "httpRedirectCode": { "type": "string", "description": "The HTTP redirect code to use on the response. Not required if one of the siblings is present." }, "protocol": { "type": "string", "description": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request." }, "replaceKeyPrefixWith": { "type": "string", "description": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "replaceKeyWith": { "type": "string", "description": "The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." } }, "type": "object" }, "azure-native:awsconnector:RedshiftClusterEndpoint": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "Property address" }, "port": { "type": "string", "description": "Property port" } }, "type": "object" }, "azure-native:awsconnector:RedshiftClusterEndpointResponse": { "description": "Definition of Endpoint", "properties": { "address": { "type": "string", "description": "Property address" }, "port": { "type": "string", "description": "Property port" } }, "type": "object" }, "azure-native:awsconnector:RedshiftClusterParameterGroupProperties": { "description": "Definition of RedshiftClusterParameterGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRedshiftClusterParameterGroupProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RedshiftClusterParameterGroupPropertiesResponse": { "description": "Definition of RedshiftClusterParameterGroup", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRedshiftClusterParameterGroupPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RedshiftClusterProperties": { "description": "Definition of RedshiftCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRedshiftClusterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:RedshiftClusterPropertiesResponse": { "description": "Definition of RedshiftCluster", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRedshiftClusterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ReferenceSets": { "description": "Definition of ReferenceSets", "properties": { "ipSetReferences": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPSetReference" }, "description": "Property ipSetReferences" } }, "type": "object" }, "azure-native:awsconnector:ReferenceSetsResponse": { "description": "Definition of ReferenceSets", "properties": { "ipSetReferences": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPSetReferenceResponse" }, "description": "Property ipSetReferences" } }, "type": "object" }, "azure-native:awsconnector:RegistryCredential": { "description": "Definition of RegistryCredential", "properties": { "credential": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. \u003c/p\u003e \u003cnote\u003e \u003cp\u003e The \u003ccode\u003ecredential\u003c/code\u003e can use the name of the credentials only if they exist in your current Amazon Web Services Region. \u003c/p\u003e \u003c/note\u003e" }, "credentialProvider": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CredentialProviderTypeEnumValue", "description": "\u003cp\u003e The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:RegistryCredentialResponse": { "description": "Definition of RegistryCredential", "properties": { "credential": { "type": "string", "description": "\u003cp\u003e The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. \u003c/p\u003e \u003cnote\u003e \u003cp\u003e The \u003ccode\u003ecredential\u003c/code\u003e can use the name of the credentials only if they exist in your current Amazon Web Services Region. \u003c/p\u003e \u003c/note\u003e" }, "credentialProvider": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CredentialProviderTypeEnumValueResponse", "description": "\u003cp\u003e The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:RemoteAccess": { "description": "Definition of RemoteAccess", "properties": { "ec2SshKey": { "type": "string", "description": "Property ec2SshKey" }, "sourceSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "Property sourceSecurityGroups" } }, "type": "object" }, "azure-native:awsconnector:RemoteAccessResponse": { "description": "Definition of RemoteAccess", "properties": { "ec2SshKey": { "type": "string", "description": "Property ec2SshKey" }, "sourceSecurityGroups": { "type": "array", "items": { "type": "string" }, "description": "Property sourceSecurityGroups" } }, "type": "object" }, "azure-native:awsconnector:RenewalEligibility": { "description": "Property value", "type": "string", "enum": [ { "name": "ELIGIBLE", "description": "RenewalEligibility enum ELIGIBLE", "value": "ELIGIBLE" }, { "name": "INELIGIBLE", "description": "RenewalEligibility enum INELIGIBLE", "value": "INELIGIBLE" } ] }, "azure-native:awsconnector:RenewalEligibilityEnumValue": { "description": "Definition of RenewalEligibilityEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RenewalEligibility" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RenewalEligibilityEnumValueResponse": { "description": "Definition of RenewalEligibilityEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ReplicaModifications": { "description": "Definition of ReplicaModifications", "properties": { "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ReplicaModificationsStatus" } ], "description": "Specifies whether Amazon S3 replicates modifications on replicas. *Allowed values*: ``Enabled`` | ``Disabled``" } }, "type": "object" }, "azure-native:awsconnector:ReplicaModificationsResponse": { "description": "Definition of ReplicaModifications", "properties": { "status": { "type": "string", "description": "Specifies whether Amazon S3 replicates modifications on replicas. *Allowed values*: ``Enabled`` | ``Disabled``" } }, "type": "object" }, "azure-native:awsconnector:ReplicaModificationsStatus": { "description": "Specifies whether Amazon S3 replicates modifications on replicas. *Allowed values*: ``Enabled`` | ``Disabled``", "type": "string", "enum": [ { "name": "Disabled", "description": "ReplicaModificationsStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "ReplicaModificationsStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:ReplicaRegion": { "description": "Definition of ReplicaRegion", "properties": { "kmsKeyId": { "type": "string", "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``." }, "region": { "type": "string", "description": "A string that represents a ``Region``, for example 'us-east-1'." } }, "type": "object" }, "azure-native:awsconnector:ReplicaRegionResponse": { "description": "Definition of ReplicaRegion", "properties": { "kmsKeyId": { "type": "string", "description": "The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``." }, "region": { "type": "string", "description": "A string that represents a ``Region``, for example 'us-east-1'." } }, "type": "object" }, "azure-native:awsconnector:ReplicationConfiguration": { "description": "Definition of ReplicationConfiguration", "properties": { "destinations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationDestination" }, "description": "An array of destination objects. Only one destination object is supported." }, "role": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationRule" }, "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules." } }, "type": "object" }, "azure-native:awsconnector:ReplicationConfigurationResponse": { "description": "Definition of ReplicationConfiguration", "properties": { "destinations": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationDestinationResponse" }, "description": "An array of destination objects. Only one destination object is supported." } }, "type": "object" }, "azure-native:awsconnector:ReplicationConfigurationResponseV1": { "description": "Definition of ReplicationConfiguration", "properties": { "role": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*." }, "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationRuleResponse" }, "description": "A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules." } }, "type": "object" }, "azure-native:awsconnector:ReplicationDestination": { "description": "Definition of ReplicationDestination", "properties": { "accessControlTranslation": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessControlTranslation", "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." }, "account": { "type": "string", "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*. If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required." }, "availabilityZoneName": { "type": "string", "description": "The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*. One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available." }, "bucket": { "type": "string", "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results." }, "encryptionConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionConfiguration", "description": "Specifies encryption-related information. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects." }, "fileSystemId": { "type": "string", "description": "The ID of the destination Amazon EFS file system." }, "kmsKeyId": { "type": "string", "description": "The ID of an kms-key-long used to protect the encrypted file system." }, "metrics": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Metrics", "description": "A container specifying replication metrics-related settings enabling replication metrics and events. A container specifying replication metrics-related settings enabling replication metrics and events." }, "region": { "type": "string", "description": "The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located." }, "replicationTime": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationTime", "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." }, "storageClass": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ReplicationDestinationStorageClass" } ], "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*." } }, "type": "object" }, "azure-native:awsconnector:ReplicationDestinationResponse": { "description": "Definition of ReplicationDestination", "properties": { "availabilityZoneName": { "type": "string", "description": "The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*. One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available." }, "fileSystemId": { "type": "string", "description": "The ID of the destination Amazon EFS file system." }, "kmsKeyId": { "type": "string", "description": "The ID of an kms-key-long used to protect the encrypted file system." }, "region": { "type": "string", "description": "The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located." } }, "type": "object" }, "azure-native:awsconnector:ReplicationDestinationResponseV1": { "description": "Definition of ReplicationDestination", "properties": { "accessControlTranslation": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AccessControlTranslationResponse", "description": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object." }, "account": { "type": "string", "description": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*. If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required." }, "bucket": { "type": "string", "description": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results." }, "encryptionConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EncryptionConfigurationResponseV1", "description": "Specifies encryption-related information. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects." }, "metrics": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MetricsResponse", "description": "A container specifying replication metrics-related settings enabling replication metrics and events. A container specifying replication metrics-related settings enabling replication metrics and events." }, "replicationTime": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationTimeResponse", "description": "A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block." }, "storageClass": { "type": "string", "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*." } }, "type": "object" }, "azure-native:awsconnector:ReplicationDestinationStorageClass": { "description": "The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*.", "type": "string", "enum": [ { "name": "DEEP_ARCHIVE", "description": "ReplicationDestinationStorageClass enum DEEP_ARCHIVE", "value": "DEEP_ARCHIVE" }, { "name": "GLACIER", "description": "ReplicationDestinationStorageClass enum GLACIER", "value": "GLACIER" }, { "name": "GLACIER_IR", "description": "ReplicationDestinationStorageClass enum GLACIER_IR", "value": "GLACIER_IR" }, { "name": "INTELLIGENT_TIERING", "description": "ReplicationDestinationStorageClass enum INTELLIGENT_TIERING", "value": "INTELLIGENT_TIERING" }, { "name": "ONEZONE_IA", "description": "ReplicationDestinationStorageClass enum ONEZONE_IA", "value": "ONEZONE_IA" }, { "name": "REDUCED_REDUNDANCY", "description": "ReplicationDestinationStorageClass enum REDUCED_REDUNDANCY", "value": "REDUCED_REDUNDANCY" }, { "name": "STANDARD", "description": "ReplicationDestinationStorageClass enum STANDARD", "value": "STANDARD" }, { "name": "STANDARD_IA", "description": "ReplicationDestinationStorageClass enum STANDARD_IA", "value": "STANDARD_IA" } ] }, "azure-native:awsconnector:ReplicationPendingModifiedValues": { "description": "Definition of ReplicationPendingModifiedValues", "properties": { "allocatedStorage": { "type": "integer", "description": "\u003cp\u003eThe amount of storage (in gigabytes) that is allocated for the replication instance.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eThe engine version number of the replication instance.\u003c/p\u003e" }, "multiAZ": { "type": "boolean", "description": "\u003cp\u003e Specifies whether the replication instance is a Multi-AZ deployment. You can't set the \u003ccode\u003eAvailabilityZone\u003c/code\u003e parameter if the Multi-AZ parameter is set to \u003ccode\u003etrue\u003c/code\u003e. \u003c/p\u003e" }, "networkType": { "type": "string", "description": "\u003cp\u003eThe type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.\u003c/p\u003e" }, "replicationInstanceClass": { "type": "string", "description": "\u003cp\u003eThe compute and memory capacity of the replication instance as defined for the specified replication instance class.\u003c/p\u003e \u003cp\u003eFor more information on the settings and capacities for the available replication instance classes, see \u003ca href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'\u003e Selecting the right DMS replication instance for your migration\u003c/a\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ReplicationPendingModifiedValuesResponse": { "description": "Definition of ReplicationPendingModifiedValues", "properties": { "allocatedStorage": { "type": "integer", "description": "\u003cp\u003eThe amount of storage (in gigabytes) that is allocated for the replication instance.\u003c/p\u003e" }, "engineVersion": { "type": "string", "description": "\u003cp\u003eThe engine version number of the replication instance.\u003c/p\u003e" }, "multiAZ": { "type": "boolean", "description": "\u003cp\u003e Specifies whether the replication instance is a Multi-AZ deployment. You can't set the \u003ccode\u003eAvailabilityZone\u003c/code\u003e parameter if the Multi-AZ parameter is set to \u003ccode\u003etrue\u003c/code\u003e. \u003c/p\u003e" }, "networkType": { "type": "string", "description": "\u003cp\u003eThe type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.\u003c/p\u003e" }, "replicationInstanceClass": { "type": "string", "description": "\u003cp\u003eThe compute and memory capacity of the replication instance as defined for the specified replication instance class.\u003c/p\u003e \u003cp\u003eFor more information on the settings and capacities for the available replication instance classes, see \u003ca href='https://docs.aws.amazon.com/dms/latest/userguide/CHAP_ReplicationInstance.html#CHAP_ReplicationInstance.InDepth'\u003e Selecting the right DMS replication instance for your migration\u003c/a\u003e. \u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ReplicationRule": { "description": "Definition of ReplicationRule", "properties": { "deleteMarkerReplication": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeleteMarkerReplication", "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." }, "destination": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationDestination", "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." }, "filter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationRuleFilter", "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration. V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element." }, "id": { "type": "string", "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as 'ID'." }, "prefix": { "type": "string", "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "priority": { "type": "integer", "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*." }, "sourceSelectionCriteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceSelectionCriteria", "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ReplicationRuleStatus" } ], "description": "Specifies whether the rule is enabled." } }, "type": "object" }, "azure-native:awsconnector:ReplicationRuleAndOperator": { "description": "Definition of ReplicationRuleAndOperator", "properties": { "prefix": { "type": "string", "description": "An object key name prefix that identifies the subset of objects to which the rule applies." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilter" }, "description": "An array of tags containing key and value pairs." } }, "type": "object" }, "azure-native:awsconnector:ReplicationRuleAndOperatorResponse": { "description": "Definition of ReplicationRuleAndOperator", "properties": { "prefix": { "type": "string", "description": "An object key name prefix that identifies the subset of objects to which the rule applies." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilterResponse" }, "description": "An array of tags containing key and value pairs." } }, "type": "object" }, "azure-native:awsconnector:ReplicationRuleFilter": { "description": "Definition of ReplicationRuleFilter", "properties": { "and": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationRuleAndOperator", "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag. A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag" }, "prefix": { "type": "string", "description": "An object key name prefix that identifies the subset of objects to which the rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "tagFilter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilter", "description": "A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket." } }, "type": "object" }, "azure-native:awsconnector:ReplicationRuleFilterResponse": { "description": "Definition of ReplicationRuleFilter", "properties": { "and": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationRuleAndOperatorResponse", "description": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag. A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag" }, "prefix": { "type": "string", "description": "An object key name prefix that identifies the subset of objects to which the rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "tagFilter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilterResponse", "description": "A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket." } }, "type": "object" }, "azure-native:awsconnector:ReplicationRuleResponse": { "description": "Definition of ReplicationRule", "properties": { "deleteMarkerReplication": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeleteMarkerReplicationResponse", "description": "Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations)." }, "destination": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationDestinationResponseV1", "description": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC)." }, "filter": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationRuleFilterResponse", "description": "A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration. V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element." }, "id": { "type": "string", "description": "A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as 'ID'." }, "prefix": { "type": "string", "description": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "priority": { "type": "integer", "description": "The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*." }, "sourceSelectionCriteria": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceSelectionCriteriaResponse", "description": "A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects." }, "status": { "type": "string", "description": "Specifies whether the rule is enabled." } }, "type": "object" }, "azure-native:awsconnector:ReplicationRuleStatus": { "description": "Specifies whether the rule is enabled.", "type": "string", "enum": [ { "name": "Disabled", "description": "ReplicationRuleStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "ReplicationRuleStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:ReplicationSubnetGroup": { "description": "Definition of ReplicationSubnetGroup", "properties": { "replicationSubnetGroupDescription": { "type": "string", "description": "\u003cp\u003eA description for the replication subnet group.\u003c/p\u003e" }, "replicationSubnetGroupIdentifier": { "type": "string", "description": "\u003cp\u003eThe identifier of the replication instance subnet group.\u003c/p\u003e" }, "subnetGroupStatus": { "type": "string", "description": "\u003cp\u003eThe status of the subnet group.\u003c/p\u003e" }, "subnets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Subnet" }, "description": "\u003cp\u003eThe subnets that are in the subnet group.\u003c/p\u003e" }, "supportedNetworkTypes": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ReplicationSubnetGroupResponse": { "description": "Definition of ReplicationSubnetGroup", "properties": { "replicationSubnetGroupDescription": { "type": "string", "description": "\u003cp\u003eA description for the replication subnet group.\u003c/p\u003e" }, "replicationSubnetGroupIdentifier": { "type": "string", "description": "\u003cp\u003eThe identifier of the replication instance subnet group.\u003c/p\u003e" }, "subnetGroupStatus": { "type": "string", "description": "\u003cp\u003eThe status of the subnet group.\u003c/p\u003e" }, "subnets": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SubnetResponse" }, "description": "\u003cp\u003eThe subnets that are in the subnet group.\u003c/p\u003e" }, "supportedNetworkTypes": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eThe IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.\u003c/p\u003e" }, "vpcId": { "type": "string", "description": "\u003cp\u003eThe ID of the VPC.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ReplicationTime": { "description": "Definition of ReplicationTime", "properties": { "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ReplicationTimeStatus" } ], "description": "Specifies whether the replication time is enabled." }, "time": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationTimeValue", "description": "A container specifying the time by which replication should be complete for all objects and operations on objects. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``." } }, "type": "object" }, "azure-native:awsconnector:ReplicationTimeResponse": { "description": "Definition of ReplicationTime", "properties": { "status": { "type": "string", "description": "Specifies whether the replication time is enabled." }, "time": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicationTimeValueResponse", "description": "A container specifying the time by which replication should be complete for all objects and operations on objects. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``." } }, "type": "object" }, "azure-native:awsconnector:ReplicationTimeStatus": { "description": "Specifies whether the replication time is enabled.", "type": "string", "enum": [ { "name": "Disabled", "description": "ReplicationTimeStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "ReplicationTimeStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:ReplicationTimeValue": { "description": "Definition of ReplicationTimeValue", "properties": { "minutes": { "type": "integer", "description": "Contains an integer specifying time in minutes. Valid value: 15" } }, "type": "object" }, "azure-native:awsconnector:ReplicationTimeValueResponse": { "description": "Definition of ReplicationTimeValue", "properties": { "minutes": { "type": "integer", "description": "Contains an integer specifying time in minutes. Valid value: 15" } }, "type": "object" }, "azure-native:awsconnector:RepoUpgradeOnBoot": { "description": "Property value", "type": "string", "enum": [ { "name": "NONE", "description": "RepoUpgradeOnBoot enum NONE", "value": "NONE" }, { "name": "SECURITY", "description": "RepoUpgradeOnBoot enum SECURITY", "value": "SECURITY" } ] }, "azure-native:awsconnector:RepoUpgradeOnBootEnumValue": { "description": "Definition of RepoUpgradeOnBootEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RepoUpgradeOnBoot" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RepoUpgradeOnBootEnumValueResponse": { "description": "Definition of RepoUpgradeOnBootEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:RepositoryCredentials": { "description": "Definition of RepositoryCredentials", "properties": { "credentialsParameter": { "type": "string", "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret." } }, "type": "object" }, "azure-native:awsconnector:RepositoryCredentialsResponse": { "description": "Definition of RepositoryCredentials", "properties": { "credentialsParameter": { "type": "string", "description": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret." } }, "type": "object" }, "azure-native:awsconnector:ResolverLevelMetricsBehavior": { "description": "Property value", "type": "string", "enum": [ { "name": "FULL_REQUEST_RESOLVER_METRICS", "description": "ResolverLevelMetricsBehavior enum FULL_REQUEST_RESOLVER_METRICS", "value": "FULL_REQUEST_RESOLVER_METRICS" }, { "name": "PER_RESOLVER_METRICS", "description": "ResolverLevelMetricsBehavior enum PER_RESOLVER_METRICS", "value": "PER_RESOLVER_METRICS" } ] }, "azure-native:awsconnector:ResolverLevelMetricsBehaviorEnumValue": { "description": "Definition of ResolverLevelMetricsBehaviorEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResolverLevelMetricsBehavior" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResolverLevelMetricsBehaviorEnumValueResponse": { "description": "Definition of ResolverLevelMetricsBehaviorEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResourcePolicy": { "description": "Definition of ResourcePolicy", "properties": { "policyDocument": { "$ref": "pulumi.json#/Any", "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." } }, "type": "object" }, "azure-native:awsconnector:ResourcePolicyResponse": { "description": "Definition of ResourcePolicy", "properties": { "policyDocument": { "$ref": "pulumi.json#/Any", "description": "A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html)." } }, "type": "object" }, "azure-native:awsconnector:ResourceRecord": { "description": "Definition of ResourceRecord", "properties": { "value": { "type": "string", "description": "\u003cp\u003eThe current or new DNS record value, not to exceed 4,000 characters. In the case of a \u003ccode\u003eDELETE\u003c/code\u003e action, if the current value does not match the actual value, an error is returned. For descriptions about how to format \u003ccode\u003eValue\u003c/code\u003e for different record types, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'\u003eSupported DNS Resource Record Types\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eYou can specify more than one value for all record types except \u003ccode\u003eCNAME\u003c/code\u003e and \u003ccode\u003eSOA\u003c/code\u003e. \u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias resource record set, omit \u003ccode\u003eValue\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:ResourceRecordResponse": { "description": "Definition of ResourceRecord", "properties": { "value": { "type": "string", "description": "\u003cp\u003eThe current or new DNS record value, not to exceed 4,000 characters. In the case of a \u003ccode\u003eDELETE\u003c/code\u003e action, if the current value does not match the actual value, an error is returned. For descriptions about how to format \u003ccode\u003eValue\u003c/code\u003e for different record types, see \u003ca href='https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/ResourceRecordTypes.html'\u003eSupported DNS Resource Record Types\u003c/a\u003e in the \u003ci\u003eAmazon Route 53 Developer Guide\u003c/i\u003e.\u003c/p\u003e \u003cp\u003eYou can specify more than one value for all record types except \u003ccode\u003eCNAME\u003c/code\u003e and \u003ccode\u003eSOA\u003c/code\u003e. \u003c/p\u003e \u003cnote\u003e \u003cp\u003eIf you're creating an alias resource record set, omit \u003ccode\u003eValue\u003c/code\u003e.\u003c/p\u003e \u003c/note\u003e" } }, "type": "object" }, "azure-native:awsconnector:ResourceRecordSetFailover": { "description": "Property value", "type": "string", "enum": [ { "name": "PRIMARY", "description": "ResourceRecordSetFailover enum PRIMARY", "value": "PRIMARY" }, { "name": "SECONDARY", "description": "ResourceRecordSetFailover enum SECONDARY", "value": "SECONDARY" } ] }, "azure-native:awsconnector:ResourceRecordSetFailoverEnumValue": { "description": "Definition of ResourceRecordSetFailoverEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceRecordSetFailover" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResourceRecordSetFailoverEnumValueResponse": { "description": "Definition of ResourceRecordSetFailoverEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResourceRecordSetRegion": { "description": "Property value", "type": "string", "enum": [ { "name": "AfSouth1", "description": "ResourceRecordSetRegion enum af-south-1", "value": "af-south-1" }, { "name": "ApEast1", "description": "ResourceRecordSetRegion enum ap-east-1", "value": "ap-east-1" }, { "name": "ApNortheast1", "description": "ResourceRecordSetRegion enum ap-northeast-1", "value": "ap-northeast-1" }, { "name": "ApNortheast2", "description": "ResourceRecordSetRegion enum ap-northeast-2", "value": "ap-northeast-2" }, { "name": "ApNortheast3", "description": "ResourceRecordSetRegion enum ap-northeast-3", "value": "ap-northeast-3" }, { "name": "ApSouth1", "description": "ResourceRecordSetRegion enum ap-south-1", "value": "ap-south-1" }, { "name": "ApSouth2", "description": "ResourceRecordSetRegion enum ap-south-2", "value": "ap-south-2" }, { "name": "ApSoutheast1", "description": "ResourceRecordSetRegion enum ap-southeast-1", "value": "ap-southeast-1" }, { "name": "ApSoutheast2", "description": "ResourceRecordSetRegion enum ap-southeast-2", "value": "ap-southeast-2" }, { "name": "ApSoutheast3", "description": "ResourceRecordSetRegion enum ap-southeast-3", "value": "ap-southeast-3" }, { "name": "ApSoutheast4", "description": "ResourceRecordSetRegion enum ap-southeast-4", "value": "ap-southeast-4" }, { "name": "CaCentral1", "description": "ResourceRecordSetRegion enum ca-central-1", "value": "ca-central-1" }, { "name": "CaWest1", "description": "ResourceRecordSetRegion enum ca-west-1", "value": "ca-west-1" }, { "name": "CnNorth1", "description": "ResourceRecordSetRegion enum cn-north-1", "value": "cn-north-1" }, { "name": "CnNorthwest1", "description": "ResourceRecordSetRegion enum cn-northwest-1", "value": "cn-northwest-1" }, { "name": "EuCentral1", "description": "ResourceRecordSetRegion enum eu-central-1", "value": "eu-central-1" }, { "name": "EuCentral2", "description": "ResourceRecordSetRegion enum eu-central-2", "value": "eu-central-2" }, { "name": "EuNorth1", "description": "ResourceRecordSetRegion enum eu-north-1", "value": "eu-north-1" }, { "name": "EuSouth1", "description": "ResourceRecordSetRegion enum eu-south-1", "value": "eu-south-1" }, { "name": "EuSouth2", "description": "ResourceRecordSetRegion enum eu-south-2", "value": "eu-south-2" }, { "name": "EuWest1", "description": "ResourceRecordSetRegion enum eu-west-1", "value": "eu-west-1" }, { "name": "EuWest2", "description": "ResourceRecordSetRegion enum eu-west-2", "value": "eu-west-2" }, { "name": "EuWest3", "description": "ResourceRecordSetRegion enum eu-west-3", "value": "eu-west-3" }, { "name": "IlCentral1", "description": "ResourceRecordSetRegion enum il-central-1", "value": "il-central-1" }, { "name": "MeCentral1", "description": "ResourceRecordSetRegion enum me-central-1", "value": "me-central-1" }, { "name": "MeSouth1", "description": "ResourceRecordSetRegion enum me-south-1", "value": "me-south-1" }, { "name": "SaEast1", "description": "ResourceRecordSetRegion enum sa-east-1", "value": "sa-east-1" }, { "name": "UsEast1", "description": "ResourceRecordSetRegion enum us-east-1", "value": "us-east-1" }, { "name": "UsEast2", "description": "ResourceRecordSetRegion enum us-east-2", "value": "us-east-2" }, { "name": "UsWest1", "description": "ResourceRecordSetRegion enum us-west-1", "value": "us-west-1" }, { "name": "UsWest2", "description": "ResourceRecordSetRegion enum us-west-2", "value": "us-west-2" } ] }, "azure-native:awsconnector:ResourceRecordSetRegionEnumValue": { "description": "Definition of ResourceRecordSetRegionEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceRecordSetRegion" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResourceRecordSetRegionEnumValueResponse": { "description": "Definition of ResourceRecordSetRegionEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResourceRequirement": { "description": "Definition of ResourceRequirement", "properties": { "type": { "type": "string", "description": "The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``." }, "value": { "type": "string", "description": "The value for the specified resource type. 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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." } }, "type": "object" }, "azure-native:awsconnector:ResourceRequirementResponse": { "description": "Definition of ResourceRequirement", "properties": { "type": { "type": "string", "description": "The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``." }, "value": { "type": "string", "description": "The value for the specified resource type. 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](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition." } }, "type": "object" }, "azure-native:awsconnector:ResourceSpec": { "description": "Definition of ResourceSpec", "properties": { "instanceType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceSpecInstanceType" } ], "description": "The instance type that the image version runs on." }, "sageMakerImageArn": { "type": "string", "description": "The ARN of the SageMaker image that the image version belongs to." }, "sageMakerImageVersionArn": { "type": "string", "description": "The ARN of the image version created on the instance." } }, "type": "object" }, "azure-native:awsconnector:ResourceSpecInstanceType": { "description": "The instance type that the image version runs on.", "type": "string", "enum": [ { "name": "MlC512xlarge", "description": "ResourceSpecInstanceType enum ml.c5.12xlarge", "value": "ml.c5.12xlarge" }, { "name": "MlC518xlarge", "description": "ResourceSpecInstanceType enum ml.c5.18xlarge", "value": "ml.c5.18xlarge" }, { "name": "MlC524xlarge", "description": "ResourceSpecInstanceType enum ml.c5.24xlarge", "value": "ml.c5.24xlarge" }, { "name": "MlC52xlarge", "description": "ResourceSpecInstanceType enum ml.c5.2xlarge", "value": "ml.c5.2xlarge" }, { "name": "MlC54xlarge", "description": "ResourceSpecInstanceType enum ml.c5.4xlarge", "value": "ml.c5.4xlarge" }, { "name": "MlC59xlarge", "description": "ResourceSpecInstanceType enum ml.c5.9xlarge", "value": "ml.c5.9xlarge" }, { "name": "MlC5Large", "description": "ResourceSpecInstanceType enum ml.c5.large", "value": "ml.c5.large" }, { "name": "MlC5Xlarge", "description": "ResourceSpecInstanceType enum ml.c5.xlarge", "value": "ml.c5.xlarge" }, { "name": "MlG4dn12xlarge", "description": "ResourceSpecInstanceType enum ml.g4dn.12xlarge", "value": "ml.g4dn.12xlarge" }, { "name": "MlG4dn16xlarge", "description": "ResourceSpecInstanceType enum ml.g4dn.16xlarge", "value": "ml.g4dn.16xlarge" }, { "name": "MlG4dn2xlarge", "description": "ResourceSpecInstanceType enum ml.g4dn.2xlarge", "value": "ml.g4dn.2xlarge" }, { "name": "MlG4dn4xlarge", "description": "ResourceSpecInstanceType enum ml.g4dn.4xlarge", "value": "ml.g4dn.4xlarge" }, { "name": "MlG4dn8xlarge", "description": "ResourceSpecInstanceType enum ml.g4dn.8xlarge", "value": "ml.g4dn.8xlarge" }, { "name": "MlG4dnXlarge", "description": "ResourceSpecInstanceType enum ml.g4dn.xlarge", "value": "ml.g4dn.xlarge" }, { "name": "MlG512xlarge", "description": "ResourceSpecInstanceType enum ml.g5.12xlarge", "value": "ml.g5.12xlarge" }, { "name": "MlG516xlarge", "description": "ResourceSpecInstanceType enum ml.g5.16xlarge", "value": "ml.g5.16xlarge" }, { "name": "MlG524xlarge", "description": "ResourceSpecInstanceType enum ml.g5.24xlarge", "value": "ml.g5.24xlarge" }, { "name": "MlG52xlarge", "description": "ResourceSpecInstanceType enum ml.g5.2xlarge", "value": "ml.g5.2xlarge" }, { "name": "MlG548xlarge", "description": "ResourceSpecInstanceType enum ml.g5.48xlarge", "value": "ml.g5.48xlarge" }, { "name": "MlG54xlarge", "description": "ResourceSpecInstanceType enum ml.g5.4xlarge", "value": "ml.g5.4xlarge" }, { "name": "MlG58xlarge", "description": "ResourceSpecInstanceType enum ml.g5.8xlarge", "value": "ml.g5.8xlarge" }, { "name": "MlG5Xlarge", "description": "ResourceSpecInstanceType enum ml.g5.xlarge", "value": "ml.g5.xlarge" }, { "name": "MlGeospatialInteractive", "description": "ResourceSpecInstanceType enum ml.geospatial.interactive", "value": "ml.geospatial.interactive" }, { "name": "MlM512xlarge", "description": "ResourceSpecInstanceType enum ml.m5.12xlarge", "value": "ml.m5.12xlarge" }, { "name": "MlM516xlarge", "description": "ResourceSpecInstanceType enum ml.m5.16xlarge", "value": "ml.m5.16xlarge" }, { "name": "MlM524xlarge", "description": "ResourceSpecInstanceType enum ml.m5.24xlarge", "value": "ml.m5.24xlarge" }, { "name": "MlM52xlarge", "description": "ResourceSpecInstanceType enum ml.m5.2xlarge", "value": "ml.m5.2xlarge" }, { "name": "MlM54xlarge", "description": "ResourceSpecInstanceType enum ml.m5.4xlarge", "value": "ml.m5.4xlarge" }, { "name": "MlM58xlarge", "description": "ResourceSpecInstanceType enum ml.m5.8xlarge", "value": "ml.m5.8xlarge" }, { "name": "MlM5Large", "description": "ResourceSpecInstanceType enum ml.m5.large", "value": "ml.m5.large" }, { "name": "MlM5Xlarge", "description": "ResourceSpecInstanceType enum ml.m5.xlarge", "value": "ml.m5.xlarge" }, { "name": "MlM5d12xlarge", "description": "ResourceSpecInstanceType enum ml.m5d.12xlarge", "value": "ml.m5d.12xlarge" }, { "name": "MlM5d16xlarge", "description": "ResourceSpecInstanceType enum ml.m5d.16xlarge", "value": "ml.m5d.16xlarge" }, { "name": "MlM5d24xlarge", "description": "ResourceSpecInstanceType enum ml.m5d.24xlarge", "value": "ml.m5d.24xlarge" }, { "name": "MlM5d2xlarge", "description": "ResourceSpecInstanceType enum ml.m5d.2xlarge", "value": "ml.m5d.2xlarge" }, { "name": "MlM5d4xlarge", "description": "ResourceSpecInstanceType enum ml.m5d.4xlarge", "value": "ml.m5d.4xlarge" }, { "name": "MlM5d8xlarge", "description": "ResourceSpecInstanceType enum ml.m5d.8xlarge", "value": "ml.m5d.8xlarge" }, { "name": "MlM5dLarge", "description": "ResourceSpecInstanceType enum ml.m5d.large", "value": "ml.m5d.large" }, { "name": "MlM5dXlarge", "description": "ResourceSpecInstanceType enum ml.m5d.xlarge", "value": "ml.m5d.xlarge" }, { "name": "MlP316xlarge", "description": "ResourceSpecInstanceType enum ml.p3.16xlarge", "value": "ml.p3.16xlarge" }, { "name": "MlP32xlarge", "description": "ResourceSpecInstanceType enum ml.p3.2xlarge", "value": "ml.p3.2xlarge" }, { "name": "MlP38xlarge", "description": "ResourceSpecInstanceType enum ml.p3.8xlarge", "value": "ml.p3.8xlarge" }, { "name": "MlP3dn24xlarge", "description": "ResourceSpecInstanceType enum ml.p3dn.24xlarge", "value": "ml.p3dn.24xlarge" }, { "name": "MlP4d24xlarge", "description": "ResourceSpecInstanceType enum ml.p4d.24xlarge", "value": "ml.p4d.24xlarge" }, { "name": "MlP4de24xlarge", "description": "ResourceSpecInstanceType enum ml.p4de.24xlarge", "value": "ml.p4de.24xlarge" }, { "name": "MlR512xlarge", "description": "ResourceSpecInstanceType enum ml.r5.12xlarge", "value": "ml.r5.12xlarge" }, { "name": "MlR516xlarge", "description": "ResourceSpecInstanceType enum ml.r5.16xlarge", "value": "ml.r5.16xlarge" }, { "name": "MlR524xlarge", "description": "ResourceSpecInstanceType enum ml.r5.24xlarge", "value": "ml.r5.24xlarge" }, { "name": "MlR52xlarge", "description": "ResourceSpecInstanceType enum ml.r5.2xlarge", "value": "ml.r5.2xlarge" }, { "name": "MlR54xlarge", "description": "ResourceSpecInstanceType enum ml.r5.4xlarge", "value": "ml.r5.4xlarge" }, { "name": "MlR58xlarge", "description": "ResourceSpecInstanceType enum ml.r5.8xlarge", "value": "ml.r5.8xlarge" }, { "name": "MlR5Large", "description": "ResourceSpecInstanceType enum ml.r5.large", "value": "ml.r5.large" }, { "name": "MlR5Xlarge", "description": "ResourceSpecInstanceType enum ml.r5.xlarge", "value": "ml.r5.xlarge" }, { "name": "MlT32xlarge", "description": "ResourceSpecInstanceType enum ml.t3.2xlarge", "value": "ml.t3.2xlarge" }, { "name": "MlT3Large", "description": "ResourceSpecInstanceType enum ml.t3.large", "value": "ml.t3.large" }, { "name": "MlT3Medium", "description": "ResourceSpecInstanceType enum ml.t3.medium", "value": "ml.t3.medium" }, { "name": "MlT3Micro", "description": "ResourceSpecInstanceType enum ml.t3.micro", "value": "ml.t3.micro" }, { "name": "MlT3Small", "description": "ResourceSpecInstanceType enum ml.t3.small", "value": "ml.t3.small" }, { "name": "MlT3Xlarge", "description": "ResourceSpecInstanceType enum ml.t3.xlarge", "value": "ml.t3.xlarge" }, { "name": "MlTrn12xlarge", "description": "ResourceSpecInstanceType enum ml.trn1.2xlarge", "value": "ml.trn1.2xlarge" }, { "name": "MlTrn132xlarge", "description": "ResourceSpecInstanceType enum ml.trn1.32xlarge", "value": "ml.trn1.32xlarge" }, { "name": "MlTrn1n32xlarge", "description": "ResourceSpecInstanceType enum ml.trn1n.32xlarge", "value": "ml.trn1n.32xlarge" }, { "name": "system", "description": "ResourceSpecInstanceType enum system", "value": "system" } ] }, "azure-native:awsconnector:ResourceSpecResponse": { "description": "Definition of ResourceSpec", "properties": { "instanceType": { "type": "string", "description": "The instance type that the image version runs on." }, "sageMakerImageArn": { "type": "string", "description": "The ARN of the SageMaker image that the image version belongs to." }, "sageMakerImageVersionArn": { "type": "string", "description": "The ARN of the image version created on the instance." } }, "type": "object" }, "azure-native:awsconnector:ResourceType": { "description": "Property value", "type": "string", "enum": [ { "name": "EC2Instance", "description": "ResourceType enum EC2Instance", "value": "EC2Instance" }, { "name": "ManagedInstance", "description": "ResourceType enum ManagedInstance", "value": "ManagedInstance" } ] }, "azure-native:awsconnector:ResourceTypeEnumValue": { "description": "Definition of ResourceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ResourceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ResourceTypeEnumValueResponse": { "description": "Definition of ResourceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:Restrictions": { "description": "Definition of Restrictions", "properties": { "geoRestriction": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GeoRestriction", "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." } }, "type": "object" }, "azure-native:awsconnector:RestrictionsResponse": { "description": "Definition of Restrictions", "properties": { "geoRestriction": { "type": "object", "$ref": "#/types/azure-native:awsconnector:GeoRestrictionResponse", "description": "A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template." } }, "type": "object" }, "azure-native:awsconnector:Route53DomainsDomainSummaryProperties": { "description": "Definition of Route53DomainsDomainSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRoute53DomainsDomainSummaryProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Route53DomainsDomainSummaryPropertiesResponse": { "description": "Definition of Route53DomainsDomainSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRoute53DomainsDomainSummaryPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Route53HostedZoneProperties": { "description": "Definition of Route53HostedZone", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRoute53HostedZoneProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Route53HostedZonePropertiesResponse": { "description": "Definition of Route53HostedZone", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRoute53HostedZonePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:Route53ResourceRecordSetProperties": { "description": "Definition of Route53ResourceRecordSet", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRoute53ResourceRecordSetProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:Route53ResourceRecordSetPropertiesResponse": { "description": "Definition of Route53ResourceRecordSet", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsRoute53ResourceRecordSetPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:RoutingRule": { "description": "Definition of RoutingRule", "properties": { "redirectRule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RedirectRule", "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return." }, "routingRuleCondition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RoutingRuleCondition", "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." } }, "type": "object" }, "azure-native:awsconnector:RoutingRuleCondition": { "description": "Definition of RoutingRuleCondition", "properties": { "httpErrorCodeReturnedEquals": { "type": "string", "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied." }, "keyPrefixEquals": { "type": "string", "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied." } }, "type": "object" }, "azure-native:awsconnector:RoutingRuleConditionResponse": { "description": "Definition of RoutingRuleCondition", "properties": { "httpErrorCodeReturnedEquals": { "type": "string", "description": "The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied." }, "keyPrefixEquals": { "type": "string", "description": "The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied." } }, "type": "object" }, "azure-native:awsconnector:RoutingRuleResponse": { "description": "Definition of RoutingRule", "properties": { "redirectRule": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RedirectRuleResponse", "description": "Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return." }, "routingRuleCondition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RoutingRuleConditionResponse", "description": "A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error." } }, "type": "object" }, "azure-native:awsconnector:Rule": { "description": "Definition of Rule", "properties": { "abortIncompleteMultipartUpload": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AbortIncompleteMultipartUpload", "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*." }, "expirationDate": { "type": "string", "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)" }, "expirationInDays": { "type": "integer", "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." }, "expiredObjectDeleteMarker": { "type": "boolean", "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``." }, "id": { "type": "string", "description": "Unique identifier for the rule. The value can't be longer than 255 characters." }, "noncurrentVersionExpiration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionExpiration", "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html)." }, "noncurrentVersionExpirationInDays": { "type": "integer", "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time." }, "noncurrentVersionTransition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionTransition", "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." }, "noncurrentVersionTransitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionTransition" }, "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property." }, "objectSizeGreaterThan": { "type": "string", "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." }, "objectSizeLessThan": { "type": "string", "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." }, "prefix": { "type": "string", "description": "Object key prefix that identifies one or more objects to which this rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RuleStatus" } ], "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilter" }, "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies." }, "transition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Transition", "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*." }, "transitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Transition" }, "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property." } }, "type": "object" }, "azure-native:awsconnector:RuleDefinition": { "description": "Definition of RuleDefinition", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Property actions" }, "matchAttributes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MatchAttributes", "description": "Property matchAttributes" } }, "type": "object" }, "azure-native:awsconnector:RuleDefinitionResponse": { "description": "Definition of RuleDefinition", "properties": { "actions": { "type": "array", "items": { "type": "string" }, "description": "Property actions" }, "matchAttributes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:MatchAttributesResponse", "description": "Property matchAttributes" } }, "type": "object" }, "azure-native:awsconnector:RuleGroup": { "description": "Definition of RuleGroup", "properties": { "referenceSets": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReferenceSets", "description": "Property referenceSets" }, "ruleVariables": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleVariables", "description": "Property ruleVariables" }, "rulesSource": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RulesSource", "description": "Property rulesSource" }, "statefulRuleOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulRuleOptions", "description": "Property statefulRuleOptions" } }, "type": "object" }, "azure-native:awsconnector:RuleGroupResponse": { "description": "Definition of RuleGroup", "properties": { "referenceSets": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReferenceSetsResponse", "description": "Property referenceSets" }, "ruleVariables": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleVariablesResponse", "description": "Property ruleVariables" }, "rulesSource": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RulesSourceResponse", "description": "Property rulesSource" }, "statefulRuleOptions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulRuleOptionsResponse", "description": "Property statefulRuleOptions" } }, "type": "object" }, "azure-native:awsconnector:RuleOption": { "description": "Definition of RuleOption", "properties": { "keyword": { "type": "string", "description": "Property keyword" }, "settings": { "type": "array", "items": { "type": "string" }, "description": "Property settings" } }, "type": "object" }, "azure-native:awsconnector:RuleOptionResponse": { "description": "Definition of RuleOption", "properties": { "keyword": { "type": "string", "description": "Property keyword" }, "settings": { "type": "array", "items": { "type": "string" }, "description": "Property settings" } }, "type": "object" }, "azure-native:awsconnector:RuleResponse": { "description": "Definition of Rule", "properties": { "abortIncompleteMultipartUpload": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AbortIncompleteMultipartUploadResponse", "description": "Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*." }, "expirationDate": { "type": "string", "description": "Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ)" }, "expirationInDays": { "type": "integer", "description": "Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time." }, "expiredObjectDeleteMarker": { "type": "boolean", "description": "Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``." }, "id": { "type": "string", "description": "Unique identifier for the rule. The value can't be longer than 255 characters." }, "noncurrentVersionExpiration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionExpirationResponse", "description": "Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html)." }, "noncurrentVersionExpirationInDays": { "type": "integer", "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time." }, "noncurrentVersionTransition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionTransitionResponse", "description": "(Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property." }, "noncurrentVersionTransitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:NoncurrentVersionTransitionResponse" }, "description": "For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property." }, "objectSizeGreaterThan": { "type": "string", "description": "Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." }, "objectSizeLessThan": { "type": "string", "description": "Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*." }, "prefix": { "type": "string", "description": "Object key prefix that identifies one or more objects to which this rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints)." }, "status": { "type": "string", "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied." }, "tagFilters": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TagFilterResponse" }, "description": "Tags to use to identify a subset of objects to which the lifecycle rule applies." }, "transition": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TransitionResponse", "description": "(Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*." }, "transitions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TransitionResponse" }, "description": "One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property." } }, "type": "object" }, "azure-native:awsconnector:RuleStatus": { "description": "If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied.", "type": "string", "enum": [ { "name": "Disabled", "description": "RuleStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "RuleStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:RuleVariables": { "description": "Definition of RuleVariables", "properties": { "ipSets": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPSet" }, "description": "Property ipSets" }, "portSets": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortSet" }, "description": "Property portSets" } }, "type": "object" }, "azure-native:awsconnector:RuleVariablesModel": { "description": "Definition of RuleVariables", "properties": { "ruleVariables": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPSet" }, "description": "Property ruleVariables" } }, "type": "object" }, "azure-native:awsconnector:RuleVariablesModelResponse": { "description": "Definition of RuleVariables", "properties": { "ruleVariables": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPSetResponse" }, "description": "Property ruleVariables" } }, "type": "object" }, "azure-native:awsconnector:RuleVariablesResponse": { "description": "Definition of RuleVariables", "properties": { "ipSets": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:IPSetResponse" }, "description": "Property ipSets" }, "portSets": { "type": "object", "additionalProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:PortSetResponse" }, "description": "Property portSets" } }, "type": "object" }, "azure-native:awsconnector:RulesSource": { "description": "Definition of RulesSource", "properties": { "rulesSourceList": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RulesSourceList", "description": "Property rulesSourceList" }, "rulesString": { "type": "string", "description": "Property rulesString" }, "statefulRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulRule" }, "description": "Property statefulRules" }, "statelessRulesAndCustomActions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatelessRulesAndCustomActions", "description": "Property statelessRulesAndCustomActions" } }, "type": "object" }, "azure-native:awsconnector:RulesSourceList": { "description": "Definition of RulesSourceList", "properties": { "generatedRulesType": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RulesSourceListGeneratedRulesType" } ], "description": "Property generatedRulesType" }, "targetTypes": { "type": "array", "items": { "type": "string" }, "description": "Property targetTypes" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "Property targets" } }, "type": "object" }, "azure-native:awsconnector:RulesSourceListGeneratedRulesType": { "description": "Property generatedRulesType", "type": "string", "enum": [ { "name": "ALLOWLIST", "description": "RulesSourceListGeneratedRulesType enum ALLOWLIST", "value": "ALLOWLIST" }, { "name": "DENYLIST", "description": "RulesSourceListGeneratedRulesType enum DENYLIST", "value": "DENYLIST" } ] }, "azure-native:awsconnector:RulesSourceListResponse": { "description": "Definition of RulesSourceList", "properties": { "generatedRulesType": { "type": "string", "description": "Property generatedRulesType" }, "targetTypes": { "type": "array", "items": { "type": "string" }, "description": "Property targetTypes" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "Property targets" } }, "type": "object" }, "azure-native:awsconnector:RulesSourceResponse": { "description": "Definition of RulesSource", "properties": { "rulesSourceList": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RulesSourceListResponse", "description": "Property rulesSourceList" }, "rulesString": { "type": "string", "description": "Property rulesString" }, "statefulRules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatefulRuleResponse" }, "description": "Property statefulRules" }, "statelessRulesAndCustomActions": { "type": "object", "$ref": "#/types/azure-native:awsconnector:StatelessRulesAndCustomActionsResponse", "description": "Property statelessRulesAndCustomActions" } }, "type": "object" }, "azure-native:awsconnector:RuntimeManagementConfig": { "description": "Definition of RuntimeManagementConfig", "properties": { "runtimeVersionArn": { "type": "string", "description": "The ARN of the runtime version you want the function to use. This is only required if you're using the *Manual* runtime update mode." }, "updateRuntimeOn": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:RuntimeManagementConfigUpdateRuntimeOn" } ], "description": "Specify the runtime update mode. + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``" } }, "type": "object" }, "azure-native:awsconnector:RuntimeManagementConfigResponse": { "description": "Definition of RuntimeManagementConfig", "properties": { "runtimeVersionArn": { "type": "string", "description": "The ARN of the runtime version you want the function to use. This is only required if you're using the *Manual* runtime update mode." }, "updateRuntimeOn": { "type": "string", "description": "Specify the runtime update mode. + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``" } }, "type": "object" }, "azure-native:awsconnector:RuntimeManagementConfigUpdateRuntimeOn": { "description": "Specify the runtime update mode. + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual``", "type": "string", "enum": [ { "name": "Auto", "description": "RuntimeManagementConfigUpdateRuntimeOn enum Auto", "value": "Auto" }, { "name": "FunctionUpdate", "description": "RuntimeManagementConfigUpdateRuntimeOn enum FunctionUpdate", "value": "FunctionUpdate" }, { "name": "Manual", "description": "RuntimeManagementConfigUpdateRuntimeOn enum Manual", "value": "Manual" } ] }, "azure-native:awsconnector:RuntimePlatform": { "description": "Definition of RuntimePlatform", "properties": { "cpuArchitecture": { "type": "string", "description": "The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate." }, "operatingSystemFamily": { "type": "string", "description": "The operating system." } }, "type": "object" }, "azure-native:awsconnector:RuntimePlatformResponse": { "description": "Definition of RuntimePlatform", "properties": { "cpuArchitecture": { "type": "string", "description": "The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate." }, "operatingSystemFamily": { "type": "string", "description": "The operating system." } }, "type": "object" }, "azure-native:awsconnector:S3AccessControlPolicyProperties": { "description": "Definition of S3AccessControlPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3AccessControlPolicyProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:S3AccessControlPolicyPropertiesResponse": { "description": "Definition of S3AccessControlPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3AccessControlPolicyPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:S3AccessPointProperties": { "description": "Definition of S3AccessPoint", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3AccessPointProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:S3AccessPointPropertiesResponse": { "description": "Definition of S3AccessPoint", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3AccessPointPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:S3BucketCriteriaForJob": { "description": "Definition of S3BucketCriteriaForJob", "properties": { "excludes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaBlockForJob", "description": "\u003cp\u003eThe property- and tag-based conditions that determine which buckets to exclude from the job.\u003c/p\u003e" }, "includes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaBlockForJob", "description": "\u003cp\u003eThe property- and tag-based conditions that determine which buckets to include in the job.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:S3BucketCriteriaForJobResponse": { "description": "Definition of S3BucketCriteriaForJob", "properties": { "excludes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaBlockForJobResponse", "description": "\u003cp\u003eThe property- and tag-based conditions that determine which buckets to exclude from the job.\u003c/p\u003e" }, "includes": { "type": "object", "$ref": "#/types/azure-native:awsconnector:CriteriaBlockForJobResponse", "description": "\u003cp\u003eThe property- and tag-based conditions that determine which buckets to include in the job.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:S3BucketDefinitionForJob": { "description": "Definition of S3BucketDefinitionForJob", "properties": { "accountId": { "type": "string", "description": "\u003cp\u003eThe unique identifier for the Amazon Web Services account that owns the buckets.\u003c/p\u003e" }, "buckets": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array that lists the names of the buckets.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:S3BucketDefinitionForJobResponse": { "description": "Definition of S3BucketDefinitionForJob", "properties": { "accountId": { "type": "string", "description": "\u003cp\u003eThe unique identifier for the Amazon Web Services account that owns the buckets.\u003c/p\u003e" }, "buckets": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array that lists the names of the buckets.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:S3BucketPolicyProperties": { "description": "Definition of S3BucketPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3BucketPolicyProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:S3BucketPolicyPropertiesResponse": { "description": "Definition of S3BucketPolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3BucketPolicyPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:S3BucketProperties": { "description": "Definition of S3Bucket", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3BucketProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:S3BucketPropertiesResponse": { "description": "Definition of S3Bucket", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3BucketPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:S3BucketSource": { "description": "Definition of S3BucketSource", "properties": { "s3Bucket": { "type": "string", "description": "The S3 bucket that is being imported from." }, "s3BucketOwner": { "type": "string", "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional." }, "s3KeyPrefix": { "type": "string", "description": "The key prefix shared by all S3 Objects that are being imported." } }, "type": "object" }, "azure-native:awsconnector:S3BucketSourceResponse": { "description": "Definition of S3BucketSource", "properties": { "s3Bucket": { "type": "string", "description": "The S3 bucket that is being imported from." }, "s3BucketOwner": { "type": "string", "description": "The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional." }, "s3KeyPrefix": { "type": "string", "description": "The key prefix shared by all S3 Objects that are being imported." } }, "type": "object" }, "azure-native:awsconnector:S3ControlMultiRegionAccessPointPolicyDocumentProperties": { "description": "Definition of S3ControlMultiRegionAccessPointPolicyDocument", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3ControlMultiRegionAccessPointPolicyDocumentProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:S3ControlMultiRegionAccessPointPolicyDocumentPropertiesResponse": { "description": "Definition of S3ControlMultiRegionAccessPointPolicyDocument", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsS3ControlMultiRegionAccessPointPolicyDocumentPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:S3KeyFilter": { "description": "Definition of S3KeyFilter", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FilterRule" }, "description": "A list of containers for the key-value pair that defines the criteria for the filter rule." } }, "type": "object" }, "azure-native:awsconnector:S3KeyFilterResponse": { "description": "Definition of S3KeyFilter", "properties": { "rules": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:FilterRuleResponse" }, "description": "A list of containers for the key-value pair that defines the criteria for the filter rule." } }, "type": "object" }, "azure-native:awsconnector:S3Location": { "description": "Definition of S3Location", "properties": { "bucket": { "type": "string", "description": "The name of the S3 bucket where the OpenAPI file is stored." }, "eTag": { "type": "string", "description": "The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file." }, "key": { "type": "string", "description": "The file name of the OpenAPI file (Amazon S3 object name)." }, "version": { "type": "string", "description": "For versioning-enabled buckets, a specific version of the OpenAPI file." } }, "type": "object" }, "azure-native:awsconnector:S3LocationResponse": { "description": "Definition of S3Location", "properties": { "bucket": { "type": "string", "description": "The name of the S3 bucket where the OpenAPI file is stored." }, "eTag": { "type": "string", "description": "The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file." }, "key": { "type": "string", "description": "The file name of the OpenAPI file (Amazon S3 object name)." }, "version": { "type": "string", "description": "For versioning-enabled buckets, a specific version of the OpenAPI file." } }, "type": "object" }, "azure-native:awsconnector:S3LogsConfig": { "description": "Definition of S3LogsConfig", "properties": { "bucketOwnerAccess": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BucketOwnerAccessEnumValue", "description": "Property bucketOwnerAccess" }, "encryptionDisabled": { "type": "boolean", "description": "\u003cp\u003e Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. \u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003e The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is \u003ccode\u003emy-bucket\u003c/code\u003e, and your path prefix is \u003ccode\u003ebuild-log\u003c/code\u003e, then acceptable formats are \u003ccode\u003emy-bucket/build-log\u003c/code\u003e or \u003ccode\u003earn:aws:s3:::my-bucket/build-log\u003c/code\u003e. \u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogsConfigStatusTypeEnumValue", "description": "\u003cp\u003eThe current status of the S3 build logs. Valid values are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e: S3 build logs are enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e: S3 build logs are not enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:S3LogsConfigResponse": { "description": "Definition of S3LogsConfig", "properties": { "bucketOwnerAccess": { "type": "object", "$ref": "#/types/azure-native:awsconnector:BucketOwnerAccessEnumValueResponse", "description": "Property bucketOwnerAccess" }, "encryptionDisabled": { "type": "boolean", "description": "\u003cp\u003e Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. \u003c/p\u003e" }, "location": { "type": "string", "description": "\u003cp\u003e The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is \u003ccode\u003emy-bucket\u003c/code\u003e, and your path prefix is \u003ccode\u003ebuild-log\u003c/code\u003e, then acceptable formats are \u003ccode\u003emy-bucket/build-log\u003c/code\u003e or \u003ccode\u003earn:aws:s3:::my-bucket/build-log\u003c/code\u003e. \u003c/p\u003e" }, "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogsConfigStatusTypeEnumValueResponse", "description": "\u003cp\u003eThe current status of the S3 build logs. Valid values are:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e: S3 build logs are enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e: S3 build logs are not enabled for this build project.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:S3OriginConfigResponse": { "description": "Definition of S3OriginConfig", "properties": { "originAccessIdentity": { "type": "string", "description": "The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: origin-access-identity/cloudfront/*ID-of-origin-access-identity* where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:S3WordsList": { "description": "Definition of S3WordsList", "properties": { "bucketName": { "type": "string", "description": "Property bucketName" }, "objectKey": { "type": "string", "description": "Property objectKey" } }, "type": "object" }, "azure-native:awsconnector:S3WordsListResponse": { "description": "Definition of S3WordsList", "properties": { "bucketName": { "type": "string", "description": "Property bucketName" }, "objectKey": { "type": "string", "description": "Property objectKey" } }, "type": "object" }, "azure-native:awsconnector:SAMLIdp": { "description": "Definition of SAMLIdp", "properties": { "entityId": { "type": "string", "description": "\u003cp\u003eThe unique entity ID of the application in the SAML identity provider.\u003c/p\u003e" }, "metadataContent": { "type": "string", "description": "\u003cp\u003eThe metadata of the SAML application, in XML format.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SAMLIdpResponse": { "description": "Definition of SAMLIdp", "properties": { "entityId": { "type": "string", "description": "\u003cp\u003eThe unique entity ID of the application in the SAML identity provider.\u003c/p\u003e" }, "metadataContent": { "type": "string", "description": "\u003cp\u003eThe metadata of the SAML application, in XML format.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SAMLOptionsOutput": { "description": "Definition of SAMLOptionsOutput", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue if SAML is enabled.\u003c/p\u003e" }, "idp": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SAMLIdp", "description": "\u003cp\u003eDescribes the SAML identity provider's information.\u003c/p\u003e" }, "rolesKey": { "type": "string", "description": "\u003cp\u003eThe key used for matching the SAML roles attribute.\u003c/p\u003e" }, "sessionTimeoutMinutes": { "type": "integer", "description": "\u003cp\u003eThe duration, in minutes, after which a user session becomes inactive.\u003c/p\u003e" }, "subjectKey": { "type": "string", "description": "\u003cp\u003eThe key used for matching the SAML subject attribute.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SAMLOptionsOutputResponse": { "description": "Definition of SAMLOptionsOutput", "properties": { "enabled": { "type": "boolean", "description": "\u003cp\u003eTrue if SAML is enabled.\u003c/p\u003e" }, "idp": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SAMLIdpResponse", "description": "\u003cp\u003eDescribes the SAML identity provider's information.\u003c/p\u003e" }, "rolesKey": { "type": "string", "description": "\u003cp\u003eThe key used for matching the SAML roles attribute.\u003c/p\u003e" }, "sessionTimeoutMinutes": { "type": "integer", "description": "\u003cp\u003eThe duration, in minutes, after which a user session becomes inactive.\u003c/p\u003e" }, "subjectKey": { "type": "string", "description": "\u003cp\u003eThe key used for matching the SAML subject attribute.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SSEDescription": { "description": "Definition of SSEDescription", "properties": { "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSEStatusEnumValue", "description": "\u003cp\u003eThe current state of server-side encryption:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLING\u003c/code\u003e - Server-side encryption is being enabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e - Server-side encryption is enabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLING\u003c/code\u003e - Server-side encryption is being disabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e - Server-side encryption is disabled.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:SSEDescriptionResponse": { "description": "Definition of SSEDescription", "properties": { "status": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SSEStatusEnumValueResponse", "description": "\u003cp\u003eThe current state of server-side encryption:\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLING\u003c/code\u003e - Server-side encryption is being enabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eENABLED\u003c/code\u003e - Server-side encryption is enabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLING\u003c/code\u003e - Server-side encryption is being disabled.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eDISABLED\u003c/code\u003e - Server-side encryption is disabled.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:SSESpecification": { "description": "Definition of SSESpecification", "properties": { "kmsMasterKeyId": { "type": "string", "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``." }, "sseEnabled": { "type": "boolean", "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key." }, "sseType": { "type": "string", "description": "Server-side encryption type. The only supported value is: + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply)." } }, "type": "object" }, "azure-native:awsconnector:SSESpecificationResponse": { "description": "Definition of SSESpecification", "properties": { "kmsMasterKeyId": { "type": "string", "description": "The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``." }, "sseEnabled": { "type": "boolean", "description": "Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key." }, "sseType": { "type": "string", "description": "Server-side encryption type. The only supported value is: + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply)." } }, "type": "object" }, "azure-native:awsconnector:SSEStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "DISABLED", "description": "SSEStatus enum DISABLED", "value": "DISABLED" }, { "name": "DISABLING", "description": "SSEStatus enum DISABLING", "value": "DISABLING" }, { "name": "ENABLED", "description": "SSEStatus enum ENABLED", "value": "ENABLED" }, { "name": "ENABLING", "description": "SSEStatus enum ENABLING", "value": "ENABLING" } ] }, "azure-native:awsconnector:SSEStatusEnumValue": { "description": "Definition of SSEStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SSEStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SSEStatusEnumValueResponse": { "description": "Definition of SSEStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SSEType": { "description": "Property value", "type": "string", "enum": [ { "name": "None", "description": "SSEType enum none", "value": "none" }, { "name": "SseEbs", "description": "SSEType enum sse-ebs", "value": "sse-ebs" }, { "name": "SseKms", "description": "SSEType enum sse-kms", "value": "sse-kms" } ] }, "azure-native:awsconnector:SSETypeEnumValue": { "description": "Definition of SSETypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SSEType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SSETypeEnumValueResponse": { "description": "Definition of SSETypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SageMakerAppProperties": { "description": "Definition of SageMakerApp", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSageMakerAppProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SageMakerAppPropertiesResponse": { "description": "Definition of SageMakerApp", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSageMakerAppPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SageMakerNotebookInstanceSummaryProperties": { "description": "Definition of SageMakerNotebookInstanceSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSageMakerNotebookInstanceSummaryProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SageMakerNotebookInstanceSummaryPropertiesResponse": { "description": "Definition of SageMakerNotebookInstanceSummary", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSageMakerNotebookInstanceSummaryPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:ScaleDownBehavior": { "description": "Property value", "type": "string", "enum": [ { "name": "TERMINATE_AT_INSTANCE_HOUR", "description": "ScaleDownBehavior enum TERMINATE_AT_INSTANCE_HOUR", "value": "TERMINATE_AT_INSTANCE_HOUR" }, { "name": "TERMINATE_AT_TASK_COMPLETION", "description": "ScaleDownBehavior enum TERMINATE_AT_TASK_COMPLETION", "value": "TERMINATE_AT_TASK_COMPLETION" } ] }, "azure-native:awsconnector:ScaleDownBehaviorEnumValue": { "description": "Definition of ScaleDownBehaviorEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ScaleDownBehavior" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ScaleDownBehaviorEnumValueResponse": { "description": "Definition of ScaleDownBehaviorEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ScalingConfig": { "description": "Definition of ScalingConfig", "properties": { "desiredSize": { "type": "integer", "description": "Property desiredSize" }, "maxSize": { "type": "integer", "description": "Property maxSize" }, "minSize": { "type": "integer", "description": "Property minSize" } }, "type": "object" }, "azure-native:awsconnector:ScalingConfigResponse": { "description": "Definition of ScalingConfig", "properties": { "desiredSize": { "type": "integer", "description": "Property desiredSize" }, "maxSize": { "type": "integer", "description": "Property maxSize" }, "minSize": { "type": "integer", "description": "Property minSize" } }, "type": "object" }, "azure-native:awsconnector:ScalingConfiguration": { "description": "Definition of ScalingConfiguration", "properties": { "autoPause": { "type": "boolean", "description": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections)." }, "maxCapacity": { "type": "integer", "description": "The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity." }, "minCapacity": { "type": "integer", "description": "The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity." }, "secondsBeforeTimeout": { "type": "integer", "description": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.The default is 300." }, "secondsUntilAutoPause": { "type": "integer", "description": "The time, in seconds, before an Aurora DB cluster in serverless mode is paused." }, "timeoutAction": { "type": "string", "description": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide." } }, "type": "object" }, "azure-native:awsconnector:ScalingConfigurationResponse": { "description": "Definition of ScalingConfiguration", "properties": { "autoPause": { "type": "boolean", "description": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections)." }, "maxCapacity": { "type": "integer", "description": "The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity." }, "minCapacity": { "type": "integer", "description": "The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity." }, "secondsBeforeTimeout": { "type": "integer", "description": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.The default is 300." }, "secondsUntilAutoPause": { "type": "integer", "description": "The time, in seconds, before an Aurora DB cluster in serverless mode is paused." }, "timeoutAction": { "type": "string", "description": "The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide." } }, "type": "object" }, "azure-native:awsconnector:ScanStatus": { "description": "Property value", "type": "string", "enum": [ { "name": "ACTIVE", "description": "ScanStatus enum ACTIVE", "value": "ACTIVE" }, { "name": "COMPLETE", "description": "ScanStatus enum COMPLETE", "value": "COMPLETE" }, { "name": "FAILED", "description": "ScanStatus enum FAILED", "value": "FAILED" }, { "name": "FINDINGS_UNAVAILABLE", "description": "ScanStatus enum FINDINGS_UNAVAILABLE", "value": "FINDINGS_UNAVAILABLE" }, { "name": "IN_PROGRESS", "description": "ScanStatus enum IN_PROGRESS", "value": "IN_PROGRESS" }, { "name": "PENDING", "description": "ScanStatus enum PENDING", "value": "PENDING" }, { "name": "SCAN_ELIGIBILITY_EXPIRED", "description": "ScanStatus enum SCAN_ELIGIBILITY_EXPIRED", "value": "SCAN_ELIGIBILITY_EXPIRED" }, { "name": "UNSUPPORTED_IMAGE", "description": "ScanStatus enum UNSUPPORTED_IMAGE", "value": "UNSUPPORTED_IMAGE" } ] }, "azure-native:awsconnector:ScanStatusEnumValue": { "description": "Definition of ScanStatusEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ScanStatus" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ScanStatusEnumValueResponse": { "description": "Definition of ScanStatusEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SchedulingStrategy": { "description": "The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). There are two service scheduler strategies available: + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy.", "type": "string", "enum": [ { "name": "DAEMON", "description": "SchedulingStrategy enum DAEMON", "value": "DAEMON" }, { "name": "REPLICA", "description": "SchedulingStrategy enum REPLICA", "value": "REPLICA" } ] }, "azure-native:awsconnector:Secret": { "description": "Definition of Secret", "properties": { "name": { "type": "string", "description": "The name of the secret." }, "valueFrom": { "type": "string", "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified." } }, "type": "object" }, "azure-native:awsconnector:SecretResponse": { "description": "Definition of Secret", "properties": { "name": { "type": "string", "description": "The name of the secret." }, "valueFrom": { "type": "string", "description": "The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified." } }, "type": "object" }, "azure-native:awsconnector:SecretsManagerResourcePolicyProperties": { "description": "Definition of SecretsManagerResourcePolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSecretsManagerResourcePolicyProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SecretsManagerResourcePolicyPropertiesResponse": { "description": "Definition of SecretsManagerResourcePolicy", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSecretsManagerResourcePolicyPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SecretsManagerSecretProperties": { "description": "Definition of SecretsManagerSecret", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSecretsManagerSecretProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SecretsManagerSecretPropertiesResponse": { "description": "Definition of SecretsManagerSecret", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSecretsManagerSecretPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SecurityGroupMembership": { "description": "Definition of SecurityGroupMembership", "properties": { "securityGroupIdentifier": { "type": "string", "description": "\u003cp\u003eThe unique ID for this security group.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eThe status of this security group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SecurityGroupMembershipResponse": { "description": "Definition of SecurityGroupMembership", "properties": { "securityGroupIdentifier": { "type": "string", "description": "\u003cp\u003eThe unique ID for this security group.\u003c/p\u003e" }, "status": { "type": "string", "description": "\u003cp\u003eThe status of this security group.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ServerSideEncryptionByDefault": { "description": "Definition of ServerSideEncryptionByDefault", "properties": { "kmsMasterKeyID": { "type": "string", "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + Key Alias: ``alias/alias-name`` If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." }, "sseAlgorithm": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ServerSideEncryptionByDefaultSSEAlgorithm" } ], "description": "Server-side encryption algorithm to use for the default encryption." } }, "type": "object" }, "azure-native:awsconnector:ServerSideEncryptionByDefaultResponse": { "description": "Definition of ServerSideEncryptionByDefault", "properties": { "kmsMasterKeyID": { "type": "string", "description": "AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + Key Alias: ``alias/alias-name`` If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*." }, "sseAlgorithm": { "type": "string", "description": "Server-side encryption algorithm to use for the default encryption." } }, "type": "object" }, "azure-native:awsconnector:ServerSideEncryptionByDefaultSSEAlgorithm": { "description": "Server-side encryption algorithm to use for the default encryption.", "type": "string", "enum": [ { "name": "AES256", "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum AES256", "value": "AES256" }, { "name": "AwsKms", "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum aws:kms", "value": "aws:kms" }, { "name": "AwsKmsDsse", "description": "ServerSideEncryptionByDefaultSSEAlgorithm enum aws:kms:dsse", "value": "aws:kms:dsse" } ] }, "azure-native:awsconnector:ServerSideEncryptionRule": { "description": "Definition of ServerSideEncryptionRule", "properties": { "bucketKeyEnabled": { "type": "boolean", "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*." }, "serverSideEncryptionByDefault": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerSideEncryptionByDefault", "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*." } }, "type": "object" }, "azure-native:awsconnector:ServerSideEncryptionRuleResponse": { "description": "Definition of ServerSideEncryptionRule", "properties": { "bucketKeyEnabled": { "type": "boolean", "description": "Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*." }, "serverSideEncryptionByDefault": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServerSideEncryptionByDefaultResponse", "description": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*." } }, "type": "object" }, "azure-native:awsconnector:ServerType": { "description": "Property value", "type": "string", "enum": [ { "name": "BITBUCKET", "description": "ServerType enum BITBUCKET", "value": "BITBUCKET" }, { "name": "GITHUB", "description": "ServerType enum GITHUB", "value": "GITHUB" }, { "name": "GITHUB_ENTERPRISE", "description": "ServerType enum GITHUB_ENTERPRISE", "value": "GITHUB_ENTERPRISE" }, { "name": "GITLAB", "description": "ServerType enum GITLAB", "value": "GITLAB" }, { "name": "GITLAB_SELF_MANAGED", "description": "ServerType enum GITLAB_SELF_MANAGED", "value": "GITLAB_SELF_MANAGED" } ] }, "azure-native:awsconnector:ServerTypeEnumValue": { "description": "Definition of ServerTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:ServerType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ServerTypeEnumValueResponse": { "description": "Definition of ServerTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:ServerlessV2ScalingConfiguration": { "description": "Definition of ServerlessV2ScalingConfiguration", "properties": { "maxCapacity": { "type": "number", "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128." }, "minCapacity": { "type": "number", "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5." } }, "type": "object" }, "azure-native:awsconnector:ServerlessV2ScalingConfigurationResponse": { "description": "Definition of ServerlessV2ScalingConfiguration", "properties": { "maxCapacity": { "type": "number", "description": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128." }, "minCapacity": { "type": "number", "description": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectClientAlias": { "description": "Definition of ServiceConnectClientAlias", "properties": { "dnsName": { "type": "string", "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "port": { "type": "integer", "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectClientAliasResponse": { "description": "Definition of ServiceConnectClientAlias", "properties": { "dnsName": { "type": "string", "description": "The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." }, "port": { "type": "integer", "description": "The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectConfiguration": { "description": "Definition of ServiceConnectConfiguration", "properties": { "enabled": { "type": "boolean", "description": "Specifies whether to use Service Connect with this service." }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogConfiguration", "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." }, "namespace": { "type": "string", "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." }, "services": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectService" }, "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a 'client' Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectConfigurationResponse": { "description": "Definition of ServiceConnectConfiguration", "properties": { "enabled": { "type": "boolean", "description": "Specifies whether to use Service Connect with this service." }, "logConfiguration": { "type": "object", "$ref": "#/types/azure-native:awsconnector:LogConfigurationResponse", "description": "The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to." }, "namespace": { "type": "string", "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." }, "services": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectServiceResponse" }, "description": "The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a 'client' Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectDefaults": { "description": "Definition of ServiceConnectDefaults", "properties": { "namespace": { "type": "string", "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (\u003e), less than (\u003c), or slash (/). If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the 'API calls' method of instance discovery only. This instance discovery method is the 'HTTP' namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. If you update the cluster with an empty string ``''`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectDefaultsResponse": { "description": "Definition of ServiceConnectDefaults", "properties": { "namespace": { "type": "string", "description": "The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (\u003e), less than (\u003c), or slash (/). If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the 'API calls' method of instance discovery only. This instance discovery method is the 'HTTP' namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. If you update the cluster with an empty string ``''`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectService": { "description": "Definition of ServiceConnectService", "properties": { "clientAliases": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectClientAlias" }, "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. Each alias ('endpoint') is a fully-qualified name and port number that other Amazon ECS tasks ('clients') can use to connect to this service. Each name and port mapping must be unique within the namespace. For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``." }, "discoveryName": { "type": "string", "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``." }, "ingressPortOverride": { "type": "integer", "description": "The port number for the Service Connect proxy to listen on. Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy." }, "portName": { "type": "string", "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service." }, "timeout": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TimeoutConfiguration", "description": "A reference to an object that represents the configured timeouts for Service Connect. An object that represents the timeout configurations for Service Connect. If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``." }, "tls": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectTlsConfiguration", "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration. An object that represents the configuration for Service Connect TLS." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectServiceResponse": { "description": "Definition of ServiceConnectService", "properties": { "clientAliases": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectClientAliasResponse" }, "description": "The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. Each alias ('endpoint') is a fully-qualified name and port number that other Amazon ECS tasks ('clients') can use to connect to this service. Each name and port mapping must be unique within the namespace. For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``." }, "discoveryName": { "type": "string", "description": "The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``." }, "ingressPortOverride": { "type": "integer", "description": "The port number for the Service Connect proxy to listen on. Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy." }, "portName": { "type": "string", "description": "The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service." }, "timeout": { "type": "object", "$ref": "#/types/azure-native:awsconnector:TimeoutConfigurationResponse", "description": "A reference to an object that represents the configured timeouts for Service Connect. An object that represents the timeout configurations for Service Connect. If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``." }, "tls": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectTlsConfigurationResponse", "description": "A reference to an object that represents a Transport Layer Security (TLS) configuration. An object that represents the configuration for Service Connect TLS." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectTlsCertificateAuthority": { "description": "Definition of ServiceConnectTlsCertificateAuthority", "properties": { "awsPcaAuthorityArn": { "type": "string", "description": "The ARN of the AWS Private Certificate Authority certificate." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectTlsCertificateAuthorityResponse": { "description": "Definition of ServiceConnectTlsCertificateAuthority", "properties": { "awsPcaAuthorityArn": { "type": "string", "description": "The ARN of the AWS Private Certificate Authority certificate." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectTlsConfiguration": { "description": "Definition of ServiceConnectTlsConfiguration", "properties": { "issuerCertificateAuthority": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectTlsCertificateAuthority", "description": "The signer certificate authority. An object that represents the AWS Private Certificate Authority certificate." }, "kmsKey": { "type": "string", "description": "The AWS Key Management Service key." }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS." } }, "type": "object" }, "azure-native:awsconnector:ServiceConnectTlsConfigurationResponse": { "description": "Definition of ServiceConnectTlsConfiguration", "properties": { "issuerCertificateAuthority": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceConnectTlsCertificateAuthorityResponse", "description": "The signer certificate authority. An object that represents the AWS Private Certificate Authority certificate." }, "kmsKey": { "type": "string", "description": "The AWS Key Management Service key." }, "roleArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS." } }, "type": "object" }, "azure-native:awsconnector:ServiceManagedEBSVolumeConfiguration": { "description": "Definition of ServiceManagedEBSVolumeConfiguration", "properties": { "encrypted": { "type": "boolean", "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "filesystemType": { "type": "string", "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available filesystem types are ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default." }, "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails." }, "roleArn": { "type": "string", "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*." }, "sizeInGiB": { "type": "integer", "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. The following are the supported volume size values for each volume type. + ``gp2`` and ``gp3``: 1-16,384 + ``io1`` and ``io2``: 4-16,384 + ``st1`` and ``sc1``: 125-16,384 + ``standard``: 1-1,024" }, "snapshotId": { "type": "string", "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "tagSpecifications": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EBSTagSpecification" }, "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "throughput": { "type": "integer", "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. This parameter is only supported for the ``gp3`` volume type." }, "volumeType": { "type": "string", "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. The following are the supported volume types. + General Purpose SSD: ``gp2``|``gp3`` + Provisioned IOPS SSD: ``io1``|``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` The magnetic volume type is not supported on Fargate." } }, "type": "object" }, "azure-native:awsconnector:ServiceManagedEBSVolumeConfigurationResponse": { "description": "Definition of ServiceManagedEBSVolumeConfiguration", "properties": { "encrypted": { "type": "boolean", "description": "Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "filesystemType": { "type": "string", "description": "The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available filesystem types are ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default." }, "iops": { "type": "integer", "description": "The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "kmsKeyId": { "type": "string", "description": "The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails." }, "roleArn": { "type": "string", "description": "The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*." }, "sizeInGiB": { "type": "integer", "description": "The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. The following are the supported volume size values for each volume type. + ``gp2`` and ``gp3``: 1-16,384 + ``io1`` and ``io2``: 4-16,384 + ``st1`` and ``sc1``: 125-16,384 + ``standard``: 1-1,024" }, "snapshotId": { "type": "string", "description": "The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "tagSpecifications": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:EBSTagSpecificationResponse" }, "description": "The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*." }, "throughput": { "type": "integer", "description": "The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. This parameter is only supported for the ``gp3`` volume type." }, "volumeType": { "type": "string", "description": "The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. The following are the supported volume types. + General Purpose SSD: ``gp2``|``gp3`` + Provisioned IOPS SSD: ``io1``|``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` The magnetic volume type is not supported on Fargate." } }, "type": "object" }, "azure-native:awsconnector:ServiceRegistry": { "description": "Definition of ServiceRegistry", "properties": { "containerName": { "type": "string", "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." }, "containerPort": { "type": "integer", "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." }, "port": { "type": "integer", "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used." }, "registryArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)." } }, "type": "object" }, "azure-native:awsconnector:ServiceRegistryResponse": { "description": "Definition of ServiceRegistry", "properties": { "containerName": { "type": "string", "description": "The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." }, "containerPort": { "type": "integer", "description": "The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both." }, "port": { "type": "integer", "description": "The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used." }, "registryArn": { "type": "string", "description": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html)." } }, "type": "object" }, "azure-native:awsconnector:ServiceSoftwareOptions": { "description": "Definition of ServiceSoftwareOptions", "properties": { "automatedUpdateDate": { "type": "string", "description": "\u003cp\u003eThe timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.\u003c/p\u003e" }, "cancellable": { "type": "boolean", "description": "\u003cp\u003e True if you're able to cancel your service software version update. False if you can't cancel your service software update.\u003c/p\u003e" }, "currentVersion": { "type": "string", "description": "\u003cp\u003eThe current service software version present on the domain.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description of the service software update status.\u003c/p\u003e" }, "newVersion": { "type": "string", "description": "\u003cp\u003eThe new service software version, if one is available.\u003c/p\u003e" }, "optionalDeployment": { "type": "boolean", "description": "\u003cp\u003eTrue if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.\u003c/p\u003e" }, "updateAvailable": { "type": "boolean", "description": "\u003cp\u003eTrue if you're able to update your service software version. False if you can't update your service software version.\u003c/p\u003e" }, "updateStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentStatusEnumValue", "description": "\u003cp\u003eThe status of your service software update.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ServiceSoftwareOptionsResponse": { "description": "Definition of ServiceSoftwareOptions", "properties": { "automatedUpdateDate": { "type": "string", "description": "\u003cp\u003eThe timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.\u003c/p\u003e" }, "cancellable": { "type": "boolean", "description": "\u003cp\u003e True if you're able to cancel your service software version update. False if you can't cancel your service software update.\u003c/p\u003e" }, "currentVersion": { "type": "string", "description": "\u003cp\u003eThe current service software version present on the domain.\u003c/p\u003e" }, "description": { "type": "string", "description": "\u003cp\u003eA description of the service software update status.\u003c/p\u003e" }, "newVersion": { "type": "string", "description": "\u003cp\u003eThe new service software version, if one is available.\u003c/p\u003e" }, "optionalDeployment": { "type": "boolean", "description": "\u003cp\u003eTrue if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.\u003c/p\u003e" }, "updateAvailable": { "type": "boolean", "description": "\u003cp\u003eTrue if you're able to update your service software version. False if you can't update your service software version.\u003c/p\u003e" }, "updateStatus": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentStatusEnumValueResponse", "description": "\u003cp\u003eThe status of your service software update.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:ServiceVolumeConfiguration": { "description": "Definition of ServiceVolumeConfiguration", "properties": { "managedEBSVolume": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceManagedEBSVolumeConfiguration", "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters." }, "name": { "type": "string", "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition." } }, "type": "object" }, "azure-native:awsconnector:ServiceVolumeConfigurationResponse": { "description": "Definition of ServiceVolumeConfiguration", "properties": { "managedEBSVolume": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ServiceManagedEBSVolumeConfigurationResponse", "description": "The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters." }, "name": { "type": "string", "description": "The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition." } }, "type": "object" }, "azure-native:awsconnector:SeveritySummary": { "description": "Definition of SeveritySummary", "properties": { "criticalCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of \u003ccode\u003eCritical\u003c/code\u003e. Critical severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "highCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "informationalCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "lowCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "mediumCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "unspecifiedCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SeveritySummaryResponse": { "description": "Definition of SeveritySummary", "properties": { "criticalCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of \u003ccode\u003eCritical\u003c/code\u003e. Critical severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "highCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "informationalCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "lowCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "mediumCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.\u003c/p\u003e" }, "unspecifiedCount": { "type": "integer", "description": "\u003cp\u003eThe total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SimpleCriterionForJob": { "description": "Definition of SimpleCriterionForJob", "properties": { "comparator": { "type": "object", "$ref": "#/types/azure-native:awsconnector:JobComparatorEnumValue", "description": "\u003cp\u003eThe operator to use in the condition. Valid values are EQ (equals) and NE (not equals).\u003c/p\u003e" }, "key": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SimpleCriterionKeyForJobEnumValue", "description": "\u003cp\u003eThe property to use in the condition.\u003c/p\u003e" }, "values": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eS3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the \u003ca href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission'\u003eBucketPublicAccess.effectivePermission\u003c/a\u003e property of a bucket.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eS3_BUCKET_NAME - A string that represents the name of a bucket.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eS3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the \u003ca href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess'\u003eBucketMetadata.sharedAccess\u003c/a\u003e property of a bucket.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e \u003cp\u003eValues are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SimpleCriterionForJobResponse": { "description": "Definition of SimpleCriterionForJob", "properties": { "comparator": { "type": "object", "$ref": "#/types/azure-native:awsconnector:JobComparatorEnumValueResponse", "description": "\u003cp\u003eThe operator to use in the condition. Valid values are EQ (equals) and NE (not equals).\u003c/p\u003e" }, "key": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SimpleCriterionKeyForJobEnumValueResponse", "description": "\u003cp\u003eThe property to use in the condition.\u003c/p\u003e" }, "values": { "type": "array", "items": { "type": "string" }, "description": "\u003cp\u003eAn array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:\u003c/p\u003e \u003cul\u003e\u003cli\u003e\u003cp\u003eACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eS3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the \u003ca href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketpublicaccess-effectivepermission'\u003eBucketPublicAccess.effectivePermission\u003c/a\u003e property of a bucket.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eS3_BUCKET_NAME - A string that represents the name of a bucket.\u003c/p\u003e\u003c/li\u003e \u003cli\u003e\u003cp\u003eS3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the \u003ca href='https://docs.aws.amazon.com/macie/latest/APIReference/datasources-s3.html#datasources-s3-prop-bucketmetadata-sharedaccess'\u003eBucketMetadata.sharedAccess\u003c/a\u003e property of a bucket.\u003c/p\u003e\u003c/li\u003e\u003c/ul\u003e \u003cp\u003eValues are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SimpleCriterionKeyForJob": { "description": "Property value", "type": "string", "enum": [ { "name": "ACCOUNT_ID", "description": "SimpleCriterionKeyForJob enum ACCOUNT_ID", "value": "ACCOUNT_ID" }, { "name": "S3_BUCKET_EFFECTIVE_PERMISSION", "description": "SimpleCriterionKeyForJob enum S3_BUCKET_EFFECTIVE_PERMISSION", "value": "S3_BUCKET_EFFECTIVE_PERMISSION" }, { "name": "S3_BUCKET_NAME", "description": "SimpleCriterionKeyForJob enum S3_BUCKET_NAME", "value": "S3_BUCKET_NAME" }, { "name": "S3_BUCKET_SHARED_ACCESS", "description": "SimpleCriterionKeyForJob enum S3_BUCKET_SHARED_ACCESS", "value": "S3_BUCKET_SHARED_ACCESS" } ] }, "azure-native:awsconnector:SimpleCriterionKeyForJobEnumValue": { "description": "Definition of SimpleCriterionKeyForJobEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SimpleCriterionKeyForJob" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SimpleCriterionKeyForJobEnumValueResponse": { "description": "Definition of SimpleCriterionKeyForJobEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SingleHeaderModelProperties": { "description": "Definition of SingleHeaderModelProperties", "properties": { "name": { "type": "string", "description": "The name of the query header to inspect." } }, "type": "object" }, "azure-native:awsconnector:SingleHeaderModelPropertiesResponse": { "description": "Definition of SingleHeaderModelProperties", "properties": { "name": { "type": "string", "description": "The name of the query header to inspect." } }, "type": "object" }, "azure-native:awsconnector:SnapStart": { "description": "Definition of SnapStart", "properties": { "applyOn": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SnapStartApplyOn" } ], "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version." } }, "type": "object" }, "azure-native:awsconnector:SnapStartApplyOn": { "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version.", "type": "string", "enum": [ { "name": "None", "description": "SnapStartApplyOn enum None", "value": "None" }, { "name": "PublishedVersions", "description": "SnapStartApplyOn enum PublishedVersions", "value": "PublishedVersions" } ] }, "azure-native:awsconnector:SnapStartResponse": { "description": "Definition of SnapStart", "properties": { "applyOn": { "type": "string", "description": "Set ``ApplyOn`` to ``PublishedVersions`` to create a snapshot of the initialized execution environment when you publish a function version." } }, "type": "object" }, "azure-native:awsconnector:SnapStartResponseResponse": { "description": "Definition of SnapStartResponse", "properties": { "applyOn": { "type": "string", "description": "When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version." }, "optimizationStatus": { "type": "string", "description": "When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version." } }, "type": "object" }, "azure-native:awsconnector:SnapshotOptions": { "description": "Definition of SnapshotOptions", "properties": { "automatedSnapshotStartHour": { "type": "integer", "description": "\u003cp\u003eThe time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is \u003ccode\u003e0\u003c/code\u003e hours.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SnapshotOptionsResponse": { "description": "Definition of SnapshotOptions", "properties": { "automatedSnapshotStartHour": { "type": "integer", "description": "\u003cp\u003eThe time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is \u003ccode\u003e0\u003c/code\u003e hours.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SnapshotState": { "description": "Property value", "type": "string", "enum": [ { "name": "Completed", "description": "SnapshotState enum completed", "value": "completed" }, { "name": "Error", "description": "SnapshotState enum error", "value": "error" }, { "name": "Pending", "description": "SnapshotState enum pending", "value": "pending" }, { "name": "Recoverable", "description": "SnapshotState enum recoverable", "value": "recoverable" }, { "name": "Recovering", "description": "SnapshotState enum recovering", "value": "recovering" } ] }, "azure-native:awsconnector:SnapshotStateEnumValue": { "description": "Definition of SnapshotStateEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SnapshotState" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SnapshotStateEnumValueResponse": { "description": "Definition of SnapshotStateEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SnsSubscriptionProperties": { "description": "Definition of SnsSubscription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSnsSubscriptionProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SnsSubscriptionPropertiesResponse": { "description": "Definition of SnsSubscription", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSnsSubscriptionPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SnsTopicProperties": { "description": "Definition of SnsTopic", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSnsTopicProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SnsTopicPropertiesResponse": { "description": "Definition of SnsTopic", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSnsTopicPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SoftwareUpdateOptions": { "description": "Definition of SoftwareUpdateOptions", "properties": { "autoSoftwareUpdateEnabled": { "type": "boolean", "description": "\u003cp\u003eWhether automatic service software updates are enabled for the domain.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SoftwareUpdateOptionsResponse": { "description": "Definition of SoftwareUpdateOptions", "properties": { "autoSoftwareUpdateEnabled": { "type": "boolean", "description": "\u003cp\u003eWhether automatic service software updates are enabled for the domain.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SourceAuth": { "description": "Definition of SourceAuth", "properties": { "resource": { "type": "string", "description": "\u003cp\u003eThe resource value that applies to the specified authorization type.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceAuthTypeEnumValue", "description": "\u003cp\u003eThe authorization type to use. Valid options are OAUTH or CODECONNECTIONS.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SourceAuthResponse": { "description": "Definition of SourceAuth", "properties": { "resource": { "type": "string", "description": "\u003cp\u003eThe resource value that applies to the specified authorization type.\u003c/p\u003e" }, "type": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SourceAuthTypeEnumValueResponse", "description": "\u003cp\u003eThe authorization type to use. Valid options are OAUTH or CODECONNECTIONS.\u003c/p\u003e" } }, "type": "object" }, "azure-native:awsconnector:SourceAuthType": { "description": "Property value", "type": "string", "enum": [ { "name": "CODECONNECTIONS", "description": "SourceAuthType enum CODECONNECTIONS", "value": "CODECONNECTIONS" }, { "name": "OAUTH", "description": "SourceAuthType enum OAUTH", "value": "OAUTH" } ] }, "azure-native:awsconnector:SourceAuthTypeEnumValue": { "description": "Definition of SourceAuthTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SourceAuthType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SourceAuthTypeEnumValueResponse": { "description": "Definition of SourceAuthTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SourceConfiguration": { "description": "Definition of SourceConfiguration", "properties": { "applicationName": { "type": "string", "description": "The name of the application associated with the configuration." }, "templateName": { "type": "string", "description": "The name of the configuration template." } }, "type": "object" }, "azure-native:awsconnector:SourceConfigurationResponse": { "description": "Definition of SourceConfiguration", "properties": { "applicationName": { "type": "string", "description": "The name of the application associated with the configuration." }, "templateName": { "type": "string", "description": "The name of the configuration template." } }, "type": "object" }, "azure-native:awsconnector:SourceSelectionCriteria": { "description": "Definition of SourceSelectionCriteria", "properties": { "replicaModifications": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicaModifications", "description": "A filter that you can specify for selection for modifications on replicas. A filter that you can specify for selection for modifications on replicas." }, "sseKmsEncryptedObjects": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SseKmsEncryptedObjects", "description": "A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. A container for filter information for the selection of S3 objects encrypted with AWS KMS." } }, "type": "object" }, "azure-native:awsconnector:SourceSelectionCriteriaResponse": { "description": "Definition of SourceSelectionCriteria", "properties": { "replicaModifications": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ReplicaModificationsResponse", "description": "A filter that you can specify for selection for modifications on replicas. A filter that you can specify for selection for modifications on replicas." }, "sseKmsEncryptedObjects": { "type": "object", "$ref": "#/types/azure-native:awsconnector:SseKmsEncryptedObjectsResponse", "description": "A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. A container for filter information for the selection of S3 objects encrypted with AWS KMS." } }, "type": "object" }, "azure-native:awsconnector:SourceType": { "description": "Property value", "type": "string", "enum": [ { "name": "AWSEC2Instance", "description": "SourceType enum AWS::EC2::Instance", "value": "AWS::EC2::Instance" }, { "name": "AWSIoTThing", "description": "SourceType enum AWS::IoT::Thing", "value": "AWS::IoT::Thing" }, { "name": "AWSSSMManagedInstance", "description": "SourceType enum AWS::SSM::ManagedInstance", "value": "AWS::SSM::ManagedInstance" } ] }, "azure-native:awsconnector:SourceTypeEnumValue": { "description": "Definition of SourceTypeEnumValue", "properties": { "value": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SourceType" } ], "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SourceTypeEnumValueResponse": { "description": "Definition of SourceTypeEnumValue", "properties": { "value": { "type": "string", "description": "Property value" } }, "type": "object" }, "azure-native:awsconnector:SqsQueueProperties": { "description": "Definition of SqsQueue", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSqsQueueProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SqsQueuePropertiesResponse": { "description": "Definition of SqsQueue", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSqsQueuePropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SseKmsEncryptedObjects": { "description": "Definition of SseKmsEncryptedObjects", "properties": { "status": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:SseKmsEncryptedObjectsStatus" } ], "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service." } }, "type": "object" }, "azure-native:awsconnector:SseKmsEncryptedObjectsResponse": { "description": "Definition of SseKmsEncryptedObjects", "properties": { "status": { "type": "string", "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service." } }, "type": "object" }, "azure-native:awsconnector:SseKmsEncryptedObjectsStatus": { "description": "Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service.", "type": "string", "enum": [ { "name": "Disabled", "description": "SseKmsEncryptedObjectsStatus enum Disabled", "value": "Disabled" }, { "name": "Enabled", "description": "SseKmsEncryptedObjectsStatus enum Enabled", "value": "Enabled" } ] }, "azure-native:awsconnector:SsmInstanceInformationProperties": { "description": "Definition of SsmInstanceInformation", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSsmInstanceInformationProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SsmInstanceInformationPropertiesResponse": { "description": "Definition of SsmInstanceInformation", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSsmInstanceInformationPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SsmParameterProperties": { "description": "Definition of SsmParameter", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSsmParameterProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SsmParameterPropertiesResponse": { "description": "Definition of SsmParameter", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSsmParameterPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:SsmResourceComplianceSummaryItemProperties": { "description": "Definition of SsmResourceComplianceSummaryItem", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSsmResourceComplianceSummaryItemProperties", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object" }, "azure-native:awsconnector:SsmResourceComplianceSummaryItemPropertiesResponse": { "description": "Definition of SsmResourceComplianceSummaryItem", "properties": { "arn": { "type": "string", "description": "Amazon Resource Name (ARN)" }, "awsAccountId": { "type": "string", "description": "AWS Account ID" }, "awsProperties": { "type": "object", "$ref": "#/types/azure-native:awsconnector:AwsSsmResourceComplianceSummaryItemPropertiesResponse", "description": "AWS Properties" }, "awsRegion": { "type": "string", "description": "AWS Region" }, "awsSourceSchema": { "type": "string", "description": "AWS Source Schema" }, "awsTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "AWS Tags" }, "provisioningState": { "type": "string", "description": "The status of the last operation." }, "publicCloudConnectorsResourceId": { "type": "string", "description": "Public Cloud Connectors Resource ID" }, "publicCloudResourceName": { "type": "string", "description": "Public Cloud Resource Name" } }, "type": "object", "required": [ "provisioningState" ] }, "azure-native:awsconnector:StackInstances": { "description": "Definition of StackInstances", "properties": { "deploymentTargets": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentTargets", "description": "The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions." }, "parameterOverrides": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Parameter" }, "description": "A list of stack set parameters whose values you want to override in the selected stack instances." }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s)." } }, "type": "object" }, "azure-native:awsconnector:StackInstancesResponse": { "description": "Definition of StackInstances", "properties": { "deploymentTargets": { "type": "object", "$ref": "#/types/azure-native:awsconnector:DeploymentTargetsResponse", "description": "The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions." }, "parameterOverrides": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:ParameterResponse" }, "description": "A list of stack set parameters whose values you want to override in the selected stack instances." }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The names of one or more Regions where you want to create stack instances using the specified AWS account(s)." } }, "type": "object" }, "azure-native:awsconnector:StackStatus": { "description": "Property stackStatus", "type": "string", "enum": [ { "name": "CREATE_COMPLETE", "description": "StackStatus enum CREATE_COMPLETE", "value": "CREATE_COMPLETE" }, { "name": "CREATE_FAILED", "description": "StackStatus enum CREATE_FAILED", "value": "CREATE_FAILED" }, { "name": "CREATE_IN_PROGRESS", "description": "StackStatus enum CREATE_IN_PROGRESS", "value": "CREATE_IN_PROGRESS" }, { "name": "DELETE_COMPLETE", "description": "StackStatus enum DELETE_COMPLETE", "value": "DELETE_COMPLETE" }, { "name": "DELETE_FAILED", "description": "StackStatus enum DELETE_FAILED", "value": "DELETE_FAILED" }, { "name": "DELETE_IN_PROGRESS", "description": "StackStatus enum DELETE_IN_PROGRESS", "value": "DELETE_IN_PROGRESS" }, { "name": "IMPORT_COMPLETE", "description": "StackStatus enum IMPORT_COMPLETE", "value": "IMPORT_COMPLETE" }, { "name": "IMPORT_IN_PROGRESS", "description": "StackStatus enum IMPORT_IN_PROGRESS", "value": "IMPORT_IN_PROGRESS" }, { "name": "IMPORT_ROLLBACK_COMPLETE", "description": "StackStatus enum IMPORT_ROLLBACK_COMPLETE", "value": "IMPORT_ROLLBACK_COMPLETE" }, { "name": "IMPORT_ROLLBACK_FAILED", "description": "StackStatus enum IMPORT_ROLLBACK_FAILED", "value": "IMPORT_ROLLBACK_FAILED" }, { "name": "IMPORT_ROLLBACK_IN_PROGRESS", "description": "StackStatus enum IMPORT_ROLLBACK_IN_PROGRESS", "value": "IMPORT_ROLLBACK_IN_PROGRESS" }, { "name": "REVIEW_IN_PROGRESS", "description": "StackStatus enum REVIEW_IN_PROGRESS", "value": "REVIEW_IN_PROGRESS" }, { "name": "ROLLBACK_COMPLETE", "description": "StackStatus enum ROLLBACK_COMPLETE", "value": "ROLLBACK_COMPLETE" }, { "name": "ROLLBACK_FAILED", "description": "StackStatus enum ROLLBACK_FAILED", "value": "ROLLBACK_FAILED" }, { "name": "ROLLBACK_IN_PROGRESS", "description": "StackStatus enum ROLLBACK_IN_PROGRESS", "value": "ROLLBACK_IN_PROGRESS" }, { "name": "UPDATE_COMPLETE", "description": "StackStatus enum UPDATE_COMPLETE", "value": "UPDATE_COMPLETE" }, { "name": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "description": "StackStatus enum UPDATE_COMPLETE_CLEANUP_IN_PROGRESS", "value": "UPDATE_COMPLETE_CLEANUP_IN_PROGRESS" }, { "name": "UPDATE_FAILED", "description": "StackStatus enum UPDATE_FAILED", "value": "UPDATE_FAILED" }, { "name": "UPDATE_IN_PROGRESS", "description": "StackStatus enum UPDATE_IN_PROGRESS", "value": "UPDATE_IN_PROGRESS" }, { "name": "UPDATE_ROLLBACK_COMPLETE", "description": "StackStatus enum UPDATE_ROLLBACK_COMPLETE", "value": "UPDATE_ROLLBACK_COMPLETE" }, { "name": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "description": "StackStatus enum UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS", "value": "UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS" }, { "name": "UPDATE_ROLLBACK_FAILED", "description": "StackStatus enum UPDATE_ROLLBACK_FAILED", "value": "UPDATE_ROLLBACK_FAILED" }, { "name": "UPDATE_ROLLBACK_IN_PROGRESS", "description": "StackStatus enum UPDATE_ROLLBACK_IN_PROGRESS", "value": "UPDATE_ROLLBACK_IN_PROGRESS" } ] }, "azure-native:awsconnector:State": { "description": "Definition of State", "properties": { "code": { "type": "integer", "description": "Status code of the Instance." }, "name": { "type": "string", "description": "Status code of the Instance." } }, "type": "object" }, "azure-native:awsconnector:StateReason": { "description": "Definition of StateReason", "properties": { "code": { "type": "string", "description": "\u003cp\u003eThe reason code for the state change.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eThe message for the state change.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.InsufficientInstanceCapacity\u003c/code\u003e: There was insufficient capacity available to satisfy the launch request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.InternalError\u003c/code\u003e: An internal error caused the instance to terminate during launch.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.ScheduledStop\u003c/code\u003e: The instance was stopped due to a scheduled retirement.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.SpotInstanceShutdown\u003c/code\u003e: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.SpotInstanceTermination\u003c/code\u003e: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InstanceInitiatedShutdown\u003c/code\u003e: The instance was shut down from the operating system of the instance.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InstanceTerminated\u003c/code\u003e: The instance was terminated or rebooted during AMI creation.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InternalError\u003c/code\u003e: A client error caused the instance to terminate during launch.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InvalidSnapshot.NotFound\u003c/code\u003e: The specified snapshot was not found.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.UserInitiatedHibernate\u003c/code\u003e: Hibernation was initiated on the instance.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.UserInitiatedShutdown\u003c/code\u003e: The instance was shut down using the Amazon EC2 API.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.VolumeLimitExceeded\u003c/code\u003e: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:StateReasonResponse": { "description": "Definition of StateReason", "properties": { "code": { "type": "string", "description": "\u003cp\u003eThe reason code for the state change.\u003c/p\u003e" }, "message": { "type": "string", "description": "\u003cp\u003eThe message for the state change.\u003c/p\u003e \u003cul\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.InsufficientInstanceCapacity\u003c/code\u003e: There was insufficient capacity available to satisfy the launch request.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.InternalError\u003c/code\u003e: An internal error caused the instance to terminate during launch.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.ScheduledStop\u003c/code\u003e: The instance was stopped due to a scheduled retirement.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.SpotInstanceShutdown\u003c/code\u003e: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eServer.SpotInstanceTermination\u003c/code\u003e: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InstanceInitiatedShutdown\u003c/code\u003e: The instance was shut down from the operating system of the instance.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InstanceTerminated\u003c/code\u003e: The instance was terminated or rebooted during AMI creation.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InternalError\u003c/code\u003e: A client error caused the instance to terminate during launch.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.InvalidSnapshot.NotFound\u003c/code\u003e: The specified snapshot was not found.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.UserInitiatedHibernate\u003c/code\u003e: Hibernation was initiated on the instance.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.UserInitiatedShutdown\u003c/code\u003e: The instance was shut down using the Amazon EC2 API.\u003c/p\u003e \u003c/li\u003e \u003cli\u003e \u003cp\u003e \u003ccode\u003eClient.VolumeLimitExceeded\u003c/code\u003e: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.\u003c/p\u003e \u003c/li\u003e \u003c/ul\u003e" } }, "type": "object" }, "azure-native:awsconnector:StateResponse": { "description": "Definition of State", "properties": { "code": { "type": "integer", "description": "Status code of the Instance." }, "name": { "type": "string", "description": "Status code of the Instance." } }, "type": "object" }, "azure-native:awsconnector:StatefulEngineOptions": { "description": "Definition of StatefulEngineOptions", "properties": { "ruleOrder": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:StatefulEngineOptionsRuleOrder" } ], "description": "Property ruleOrder" }, "streamExceptionPolicy": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:StatefulEngineOptionsStreamExceptionPolicy" } ], "description": "Property streamExceptionPolicy" } }, "type": "object" }, "azure-native:awsconnector:StatefulEngineOptionsResponse": { "description": "Definition of StatefulEngineOptions", "properties": { "ruleOrder": { "type": "string", "description": "Property ruleOrder" }, "streamExceptionPolicy": { "type": "string", "description": "Property streamExceptionPolicy" } }, "type": "object" }, "azure-native:awsconnector:StatefulEngineOptionsRuleOrder": { "description": "Property ruleOrder", "type": "string", "enum": [ { "name": "DEFAULT_ACTION_ORDER", "description": "StatefulEngineOptionsRuleOrder enum DEFAULT_ACTION_ORDER", "value": "DEFAULT_ACTION_ORDER" }, { "name": "STRICT_ORDER", "description": "StatefulEngineOptionsRuleOrder enum STRICT_ORDER", "value": "STRICT_ORDER" } ] }, "azure-native:awsconnector:StatefulEngineOptionsStreamExceptionPolicy": { "description": "Property streamExceptionPolicy", "type": "string", "enum": [ { "name": "CONTINUE", "description": "StatefulEngineOptionsStreamExceptionPolicy enum CONTINUE", "value": "CONTINUE" }, { "name": "DROP", "description": "StatefulEngineOptionsStreamExceptionPolicy enum DROP", "value": "DROP" }, { "name": "REJECT", "description": "StatefulEngineOptionsStreamExceptionPolicy enum REJECT", "value": "REJECT" } ] }, "azure-native:awsconnector:StatefulRule": { "description": "Definition of StatefulRule", "properties": { "action": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:StatefulRuleAction" } ], "description": "Property action" }, "header": { "type": "object", "$ref": "#/types/azure-native:awsconnector:Header", "description": "Property header" }, "ruleOptions": { "type": "array", "items": { "type": "object", "$ref": "#/types/azure-native:awsconnector:RuleOption" }, "description": "Property ruleOptions" } }, "type": "object" }, "azure-native:awsconnector:StatefulRuleAction": { "description": "Property action", "type": "string", "enum": [ { "name": "ALERT", "description": "StatefulRuleAction enum ALERT", "value": "ALERT" }, { "name": "DROP", "description": "StatefulRuleAction enum DROP", "value": "DROP" }, { "name": "PASS", "description": "StatefulRuleAction enum PASS", "value": "PASS" }, { "name": "REJECT", "description": "StatefulRuleAction enum REJECT", "value": "REJECT" } ] }, "azure-native:awsconnector:StatefulRuleGroupOverride": { "description": "Definition of StatefulRuleGroupOverride", "properties": { "action": { "oneOf": [ { "type": "string" }, { "$ref": "#/types/azure-native:awsconnector:StatefulRuleGroupOverrideAction" } ], "description": "Property action" } }, "type": "object" }, "azure-native:awsconnector:StatefulRuleGroupOverrideAction": { "description": "Property action", "type": "string", "enum": [ { "name": "DROP_TO_ALERT", "description": "StatefulRuleGroupOverrideAction enum DROP_TO_ALERT", "value": "DROP_TO_ALERT" } ] }, "azure-native:awsconnector:StatefulRuleGroupOverrideResponse": { "description": "Definition of StatefulRuleGroupOverride", "properties": { "action": { "type": "string", "description": "Property action" } }, "type": "object" }, "azure-native:awsconnector:StatefulRuleGroupReference": { "description": "Definition of StatefulRuleGroupReference", "properties": { "override": { "type": "object", "$ref": "#/types/azure-native:awsconnect