{ "name": "oci", "displayName": "Oracle Cloud Infrastructure", "description": "A Pulumi package for creating and managing Oracle Cloud Infrastructure resources.", "keywords": [ "pulumi", "oci", "oracle", "category/cloud" ], "homepage": "https://www.pulumi.com", "license": "Apache-2.0", "attribution": "This Pulumi package is based on the [`oci` Terraform Provider](https://github.com/oracle/terraform-provider-oci).", "repository": "https://github.com/pulumi/pulumi-oci", "publisher": "Pulumi", "meta": { "moduleFormat": "(.*)(?:/[^/]*)" }, "language": { "csharp": { "packageReferences": { "Pulumi": "3.*" }, "compatibility": "tfbridge20", "respectSchemaVersion": true }, "go": { "importBasePath": "github.com/pulumi/pulumi-oci/sdk/v4/go/oci", "generateResourceContainerTypes": true, "generateExtraInputTypes": true, "respectSchemaVersion": true }, "nodejs": { "packageDescription": "A Pulumi package for creating and managing Oracle Cloud Infrastructure resources.", "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/oracle/terraform-provider-oci)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-oci` repo](https://github.com/pulumi/pulumi-oci/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-oci` repo](https://github.com/oracle/terraform-provider-oci/issues).", "devDependencies": { "@types/mime": "^2.0.0", "@types/node": "^10.0.0" }, "compatibility": "tfbridge20", "disableUnionOutputTypes": true, "respectSchemaVersion": true }, "python": { "readme": "\u003e This provider is a derived work of the [Terraform Provider](https://github.com/oracle/terraform-provider-oci)\n\u003e distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature,\n\u003e first check the [`pulumi-oci` repo](https://github.com/pulumi/pulumi-oci/issues); however, if that doesn't turn up anything,\n\u003e please consult the source [`terraform-provider-oci` repo](https://github.com/oracle/terraform-provider-oci/issues).", "compatibility": "tfbridge20", "respectSchemaVersion": true, "pyproject": { "enabled": true } } }, "config": { "variables": { "auth": { "type": "string", "description": "(Optional) The type of auth to use. Options are 'ApiKey', 'InstancePrincipal', 'InstancePrincipalWithCerts', 'SecurityToken', 'ResourcePrincipal', 'OKEWorkloadIdentity', 'WorkloadIdentityFederation'. By default, 'ApiKey' will be used." }, "configFileProfile": { "type": "string", "description": "(Optional) The profile name to be used from config file, if not set it will be DEFAULT." }, "disableAutoRetries": { "type": "boolean", "description": "(Optional) Disable automatic retries for retriable errors.\nAutomatic retries were introduced to solve some eventual consistency problems but it also introduced performance issues on destroy operations." }, "dualStackEndpointEnabled": { "type": "boolean", "description": "(Optional) flags to enable Dual Stack endpoint." }, "fingerprint": { "type": "string", "description": "(Optional) The fingerprint for the user's RSA key. This can be found in user settings in the Oracle Cloud Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise." }, "ignoreDefinedTags": { "type": "array", "items": { "type": "string" }, "description": "(Optional) List of defined tags keys that Terraform should ignore when planning creates and updates to the associated remote object" }, "privateKey": { "type": "string", "description": "(Optional) A PEM formatted RSA private key for the user.\nA\u003cspan pulumi-lang-nodejs=\" privateKey \" pulumi-lang-dotnet=\" PrivateKey \" pulumi-lang-go=\" privateKey \" pulumi-lang-python=\" private_key \" pulumi-lang-yaml=\" privateKey \" pulumi-lang-java=\" privateKey \" pulumi-lang-hcl=\" private_key \"\u003e privateKey \u003c/span\u003eor a\u003cspan pulumi-lang-nodejs=\" privateKeyPath \" pulumi-lang-dotnet=\" PrivateKeyPath \" pulumi-lang-go=\" privateKeyPath \" pulumi-lang-python=\" private_key_path \" pulumi-lang-yaml=\" privateKeyPath \" pulumi-lang-java=\" privateKeyPath \" pulumi-lang-hcl=\" private_key_path \"\u003e privateKeyPath \u003c/span\u003emust be provided if auth is set to 'ApiKey', ignored otherwise.", "secret": true }, "privateKeyPassword": { "type": "string", "description": "(Optional) The password used to secure the private key.", "secret": true }, "privateKeyPath": { "type": "string", "description": "(Optional) The path to the user's PEM formatted private key.\nA\u003cspan pulumi-lang-nodejs=\" privateKey \" pulumi-lang-dotnet=\" PrivateKey \" pulumi-lang-go=\" privateKey \" pulumi-lang-python=\" private_key \" pulumi-lang-yaml=\" privateKey \" pulumi-lang-java=\" privateKey \" pulumi-lang-hcl=\" private_key \"\u003e privateKey \u003c/span\u003eor a\u003cspan pulumi-lang-nodejs=\" privateKeyPath \" pulumi-lang-dotnet=\" PrivateKeyPath \" pulumi-lang-go=\" privateKeyPath \" pulumi-lang-python=\" private_key_path \" pulumi-lang-yaml=\" privateKeyPath \" pulumi-lang-java=\" privateKeyPath \" pulumi-lang-hcl=\" private_key_path \"\u003e privateKeyPath \u003c/span\u003emust be provided if auth is set to 'ApiKey', ignored otherwise." }, "realmSpecificServiceEndpointTemplateEnabled": { "type": "boolean", "description": "(Optional) flags to enable realm specific service endpoint." }, "region": { "type": "string", "description": "(Required) The region for API connections (e.g. us-ashburn-1)." }, "retriesConfigFile": { "type": "string", "description": "(Optional) Config file which has the configuration for 4xx and 5xx retries in JSON format" }, "retryDurationSeconds": { "type": "integer", "description": "(Optional) The minimum duration (in seconds) to retry a resource operation in response to an error.\nThe actual retry duration may be longer due to jittering of retry operations. This value is ignored if the \u003cspan pulumi-lang-nodejs=\"`disableAutoRetries`\" pulumi-lang-dotnet=\"`DisableAutoRetries`\" pulumi-lang-go=\"`disableAutoRetries`\" pulumi-lang-python=\"`disable_auto_retries`\" pulumi-lang-yaml=\"`disableAutoRetries`\" pulumi-lang-java=\"`disableAutoRetries`\" pulumi-lang-hcl=\"`disable_auto_retries`\"\u003e`disableAutoRetries`\u003c/span\u003e field is set to true." }, "tenancyOcid": { "type": "string", "description": "(Optional) The tenancy OCID for a user. The tenancy OCID can be found at the bottom of user settings in the Oracle Cloud Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise." }, "testTimeMaintenanceRebootDue": { "type": "string" }, "tokenExchangeAuth": { "type": "string", "description": "(Optional) Authentication method for the token-exchange client. Valid values are 'OAuthClientCredentials' and 'InstancePrincipal'. Used only if auth is set to 'WorkloadIdentityFederation'. Defaults to 'OAuthClientCredentials'." }, "tokenExchangeClientId": { "type": "string", "description": "(Optional) Token-exchange client ID. Required when auth is set to 'WorkloadIdentityFederation' and\u003cspan pulumi-lang-nodejs=\" tokenExchangeAuth \" pulumi-lang-dotnet=\" TokenExchangeAuth \" pulumi-lang-go=\" tokenExchangeAuth \" pulumi-lang-python=\" token_exchange_auth \" pulumi-lang-yaml=\" tokenExchangeAuth \" pulumi-lang-java=\" tokenExchangeAuth \" pulumi-lang-hcl=\" token_exchange_auth \"\u003e tokenExchangeAuth \u003c/span\u003eis 'OAuthClientCredentials', ignored otherwise." }, "tokenExchangeClientSecret": { "type": "string", "description": "(Optional) Token-exchange client secret. Required when auth is set to 'WorkloadIdentityFederation' and\u003cspan pulumi-lang-nodejs=\" tokenExchangeAuth \" pulumi-lang-dotnet=\" TokenExchangeAuth \" pulumi-lang-go=\" tokenExchangeAuth \" pulumi-lang-python=\" token_exchange_auth \" pulumi-lang-yaml=\" tokenExchangeAuth \" pulumi-lang-java=\" tokenExchangeAuth \" pulumi-lang-hcl=\" token_exchange_auth \"\u003e tokenExchangeAuth \u003c/span\u003eis 'OAuthClientCredentials', ignored otherwise.", "secret": true }, "tokenExchangeDomainUrl": { "type": "string", "description": "(Optional) OCI IAM identity domain URL for token exchange. Required if auth is set to 'WorkloadIdentityFederation', ignored otherwise." }, "tokenExchangePublicKey": { "type": "string", "description": "(Optional) Public key used by the token-exchange flow, where applicable. Used only if auth is set to 'WorkloadIdentityFederation'." }, "tokenExchangeRequestedTokenType": { "type": "string", "description": "(Optional) Requested token type for token exchange. Required if auth is set to 'WorkloadIdentityFederation', ignored otherwise." }, "tokenExchangeResourceType": { "type": "string", "description": "(Optional) Resource type used during token exchange. Required if auth is set to 'WorkloadIdentityFederation', ignored otherwise." }, "tokenExchangeRpstExp": { "type": "string", "description": "(Optional) Requested RPST expiration for token exchange. Used only if auth is set to 'WorkloadIdentityFederation'." }, "tokenExchangeSubjectTokenType": { "type": "string", "description": "(Optional) Subject token type for the Kubernetes service account JWT. Required if auth is set to 'WorkloadIdentityFederation', ignored otherwise." }, "userOcid": { "type": "string", "description": "(Optional) The user OCID. This can be found in user settings in the Oracle Cloud Infrastructure console. Required if auth is set to 'ApiKey', ignored otherwise." }, "workloadIdentityTokenPath": { "type": "string", "description": "(Optional) Path to the projected Kubernetes service account token. Required if auth is set to 'WorkloadIdentityFederation', ignored otherwise." } } }, "types": { "oci:Adm/RemediationRecipeDetectConfiguration:RemediationRecipeDetectConfiguration": { "properties": { "exclusions": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of dependencies to be ignored by the recommendation algorithm. The dependency pattern is matched against the 'group:artifact:version' or the purl of a dependency. An asterisk (*) at the end in the dependency pattern acts as a wildcard and matches zero or more characters.\n" }, "maxPermissibleCvssV2score": { "type": "number", "description": "(Updatable) The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score. A vulnerability with a CVSS V2 score below this value is not considered for remediation.\n" }, "maxPermissibleCvssV3score": { "type": "number", "description": "(Updatable) The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score. A vulnerability with a CVSS V3 score below this value is not considered for patching.\n" }, "maxPermissibleSeverity": { "type": "string", "description": "(Updatable) The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation.\n" }, "upgradePolicy": { "type": "string", "description": "(Updatable) The upgrade policy for recommendations. The `Nearest` upgrade policy upgrades a dependency to the oldest version that meets both of the following criteria: it is newer than the current version and it is not affected by a vulnerability.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "exclusions", "maxPermissibleCvssV2score", "maxPermissibleCvssV3score", "maxPermissibleSeverity", "upgradePolicy" ] } } }, "oci:Adm/RemediationRecipeNetworkConfiguration:RemediationRecipeNetworkConfiguration": { "properties": { "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of Oracle Cloud Identifiers ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) corresponding to Network Security Groups.\n" }, "subnetId": { "type": "string", "description": "(Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subnet.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "nsgIds", "subnetId" ] } } }, "oci:Adm/RemediationRecipeScmConfiguration:RemediationRecipeScmConfiguration": { "properties": { "branch": { "type": "string", "description": "(Updatable) The branch used by ADM to patch vulnerabilities.\n" }, "buildFileLocation": { "type": "string", "description": "(Updatable) The location of the build file relative to the root of the repository. Only Maven build files (POM) are currently supported. If this property is not specified, ADM will use the build file located at the root of the repository.\n" }, "externalScmType": { "type": "string", "description": "(Updatable) The type of External Source Code Management.\n" }, "isAutomergeEnabled": { "type": "boolean", "description": "(Updatable) If true, the Pull Request (PR) will be merged after the verify stage completes successfully If false, the PR with the proposed changes must be reviewed and manually merged.\n" }, "ociCodeRepositoryId": { "type": "string", "description": "(Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure DevOps repository.\n" }, "patSecretId": { "type": "string", "description": "(Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Private Access Token (PAT) Secret. The secret provides the credentials necessary to authenticate against the SCM.\n" }, "repositoryUrl": { "type": "string", "description": "(Updatable) The repository URL for the SCM. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName] For GitLab the expected format is https://gitlab.com/[groupName]/[repoName]\n" }, "scmType": { "type": "string", "description": "(Updatable) The type of Source Code Management.\n" }, "username": { "type": "string", "description": "(Updatable) The username for the SCM (to perform operations such as cloning or pushing via HTTP).\n" } }, "type": "object", "required": [ "branch", "isAutomergeEnabled", "scmType" ], "language": { "nodejs": { "requiredOutputs": [ "branch", "buildFileLocation", "externalScmType", "isAutomergeEnabled", "ociCodeRepositoryId", "patSecretId", "repositoryUrl", "scmType", "username" ] } } }, "oci:Adm/RemediationRecipeVerifyConfiguration:RemediationRecipeVerifyConfiguration": { "properties": { "additionalParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Additional key-value pairs passed as parameters to the build service when running an experiment.\n" }, "buildServiceType": { "type": "string", "description": "(Updatable) The type of Build Service.\n" }, "jenkinsUrl": { "type": "string", "description": "(Updatable) The URL that locates the Jenkins pipeline.\n" }, "jobName": { "type": "string", "description": "(Updatable) The name of the Jenkins pipeline job that identifies the build pipeline.\n" }, "patSecretId": { "type": "string", "description": "(Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.\n" }, "pipelineId": { "type": "string", "description": "(Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the user's DevOps Build Pipeline.\n" }, "repositoryUrl": { "type": "string", "description": "(Updatable) The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName]\n" }, "triggerSecretId": { "type": "string", "description": "(Updatable) The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the trigger Secret. The Secret provides access to the trigger for a GitLab pipeline.\n" }, "username": { "type": "string", "description": "(Updatable) The username that will be used to authenticate with Jenkins.\n" }, "workflowName": { "type": "string", "description": "(Updatable) The name of the GitHub Actions workflow that defines the build pipeline.\n" } }, "type": "object", "required": [ "buildServiceType" ], "language": { "nodejs": { "requiredOutputs": [ "additionalParameters", "buildServiceType", "jenkinsUrl", "jobName", "patSecretId", "pipelineId", "repositoryUrl", "triggerSecretId", "username", "workflowName" ] } } }, "oci:Adm/RemediationRunStage:RemediationRunStage": { "properties": { "summary": { "type": "string", "description": "Information about the current step within the given stage.\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeFinished": { "type": "string", "description": "The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeStarted": { "type": "string", "description": "The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "type": { "type": "string", "description": "The type of stage.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "summary", "timeCreated", "timeFinished", "timeStarted", "type" ] } } }, "oci:Adm/VulnerabilityAuditApplicationDependency:VulnerabilityAuditApplicationDependency": { "properties": { "applicationDependencyNodeIds": { "type": "array", "items": { "type": "string" }, "description": "List of application dependencies on which this application dependency depends, each identified by its nodeId.\n", "willReplaceOnChanges": true }, "gav": { "type": "string", "description": "Group Artifact Version (GAV) identifier (Group:Artifact:Version). Example: org.graalvm.nativeimage:svm:21.1.0. \"N/A\" for non-maven artifacts.\n", "willReplaceOnChanges": true }, "nodeId": { "type": "string", "description": "Unique identifier of an application dependency, for example nodeId1. The nodeId can be generated by assigning a unique id to each application dependency in the tree of application dependencies. Every node, even those who share the same GAV, should have a different nodeId. The preferred way of constructing a nodeId is to assign incremental integers during a breadth first or depth first search. A nodeId can be reused only it refers to the same subtree of application dependencies. (This is not equivalent to referring to the same GAV, that is, a GAV can have multiple transitive dependencies.)\n", "willReplaceOnChanges": true }, "purl": { "type": "string", "description": "Package URL identifier, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.1.0\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "nodeId" ], "language": { "nodejs": { "requiredOutputs": [ "applicationDependencyNodeIds", "gav", "nodeId", "purl" ] } } }, "oci:Adm/VulnerabilityAuditConfiguration:VulnerabilityAuditConfiguration": { "properties": { "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A vulnerable application dependency is ignored if its name matches any of the items in \u003cspan pulumi-lang-nodejs=\"`exclusions`\" pulumi-lang-dotnet=\"`Exclusions`\" pulumi-lang-go=\"`exclusions`\" pulumi-lang-python=\"`exclusions`\" pulumi-lang-yaml=\"`exclusions`\" pulumi-lang-java=\"`exclusions`\" pulumi-lang-hcl=\"`exclusions`\"\u003e`exclusions`\u003c/span\u003e. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters.\n", "willReplaceOnChanges": true }, "maxPermissibleCvssV2score": { "type": "number", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.\n", "willReplaceOnChanges": true }, "maxPermissibleCvssV3score": { "type": "number", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.\n", "willReplaceOnChanges": true }, "maxPermissibleSeverity": { "type": "string", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "exclusions", "maxPermissibleCvssV2score", "maxPermissibleCvssV3score", "maxPermissibleSeverity" ] } } }, "oci:Adm/VulnerabilityAuditSource:VulnerabilityAuditSource": { "properties": { "description": { "type": "string", "description": "Description of the external resource source.\n", "willReplaceOnChanges": true }, "ociResourceId": { "type": "string", "description": "The Oracle Cloud identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure resource that triggered the vulnerability audit.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Source type of the vulnerability audit.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "description", "ociResourceId", "type" ] } } }, "oci:Adm/VulnerabilityAuditUsageData:VulnerabilityAuditUsageData": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket to read the usage data from.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The Object Storage namespace to read the usage data from.\n", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The Object Storage object name to read the usage data from.\n", "willReplaceOnChanges": true }, "sourceType": { "type": "string", "description": "The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "namespace", "object", "sourceType" ] }, "oci:Adm/VulnerabilityAuditVulnerability:VulnerabilityAuditVulnerability": { "properties": { "cvssV2score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 2, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV2Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "cvssV3score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 3, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV3Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "id": { "type": "string", "description": "Unique vulnerability identifier, e.g. CVE-1999-0067.\n" }, "isFalsePositive": { "type": "boolean", "description": "Indicates if the vulnerability is a false positive according to the usage data. If no usage data was provided or the service cannot infer usage of the vulnerable code then this property is \u003cspan pulumi-lang-nodejs=\"`null`\" pulumi-lang-dotnet=\"`Null`\" pulumi-lang-go=\"`null`\" pulumi-lang-python=\"`null`\" pulumi-lang-yaml=\"`null`\" pulumi-lang-java=\"`null`\" pulumi-lang-hcl=\"`null`\"\u003e`null`\u003c/span\u003e.\n" }, "isIgnored": { "type": "boolean", "description": "Indicates if the vulnerability was ignored according to the audit configuration.\n" }, "matchingVulnerableArtifactVersionRanges": { "type": "array", "items": { "$ref": "#/types/oci:Adm/VulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange:VulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange" }, "description": "List of artifact version ranges affected by a particular vulnerability.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Adm/VulnerabilityAuditVulnerabilityMetric:VulnerabilityAuditVulnerabilityMetric" }, "description": "List of reported metrics by the source.\n" }, "severity": { "type": "string", "description": "ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL.\n" }, "source": { "type": "string", "description": "vulnerability audit source.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cvssV2score", "cvssV3score", "id", "isFalsePositive", "isIgnored", "matchingVulnerableArtifactVersionRanges", "metrics", "severity", "source" ] } } }, "oci:Adm/VulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange:VulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange": { "properties": { "versionEndExcluding": { "type": "string", "description": "The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable.\n" }, "versionEndIncluding": { "type": "string", "description": "Marks the latest version that is affected by the vulnerability. This version and all preceding versions, going back to versionStartExcluding or versionStartIncluding, are considered vulnerable.\n" }, "versionStartExcluding": { "type": "string", "description": "The version immediately before the start of affected versions. The specified version is not affected, but versions immediately after are, up to versionStartIncluding or beyond, if not otherwise defined.\n" }, "versionStartIncluding": { "type": "string", "description": "The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "versionEndExcluding", "versionEndIncluding", "versionStartExcluding", "versionStartIncluding" ] } } }, "oci:Adm/VulnerabilityAuditVulnerabilityMetric:VulnerabilityAuditVulnerabilityMetric": { "properties": { "score": { "type": "number", "description": "Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system.\n" }, "source": { "type": "string", "description": "vulnerability audit source.\n" }, "type": { "type": "string", "description": "Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity.\n" }, "value": { "type": "string", "description": "Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "score", "source", "type", "value" ] } } }, "oci:Adm/getKnowledgebasesFilter:getKnowledgebasesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getKnowledgebasesKnowledgeBaseCollection:getKnowledgebasesKnowledgeBaseCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getKnowledgebasesKnowledgeBaseCollectionItem:getKnowledgebasesKnowledgeBaseCollectionItem" }, "description": "List of knowledge base summaries.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getKnowledgebasesKnowledgeBaseCollectionItem:getKnowledgebasesKnowledgeBaseCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.\n" }, "state": { "type": "string", "description": "A filter to return only Knowledge Bases that match the specified lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the knowledge base (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeUpdated": { "type": "string", "description": "The date and time the knowledge base was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipeDetectConfiguration:getRemediationRecipeDetectConfiguration": { "properties": { "exclusions": { "type": "array", "items": { "type": "string" }, "description": "The list of dependencies to be ignored by the recommendation algorithm. The dependency pattern is matched against the 'group:artifact:version' or the purl of a dependency. An asterisk (*) at the end in the dependency pattern acts as a wildcard and matches zero or more characters.\n" }, "maxPermissibleCvssV2score": { "type": "number", "description": "The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score. A vulnerability with a CVSS V2 score below this value is not considered for remediation.\n" }, "maxPermissibleCvssV3score": { "type": "number", "description": "The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score. A vulnerability with a CVSS V3 score below this value is not considered for patching.\n" }, "maxPermissibleSeverity": { "type": "string", "description": "The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation.\n" }, "upgradePolicy": { "type": "string", "description": "The upgrade policy for recommendations. The `Nearest` upgrade policy upgrades a dependency to the oldest version that meets both of the following criteria: it is newer than the current version and it is not affected by a vulnerability.\n" } }, "type": "object", "required": [ "exclusions", "maxPermissibleCvssV2score", "maxPermissibleCvssV3score", "maxPermissibleSeverity", "upgradePolicy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipeNetworkConfiguration:getRemediationRecipeNetworkConfiguration": { "properties": { "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "The list of Oracle Cloud Identifiers ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) corresponding to Network Security Groups.\n" }, "subnetId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subnet.\n" } }, "type": "object", "required": [ "nsgIds", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipeScmConfiguration:getRemediationRecipeScmConfiguration": { "properties": { "branch": { "type": "string", "description": "The branch used by ADM to patch vulnerabilities.\n" }, "buildFileLocation": { "type": "string", "description": "The location of the build file relative to the root of the repository. Only Maven build files (POM) are currently supported. If this property is not specified, ADM will use the build file located at the root of the repository.\n" }, "externalScmType": { "type": "string", "description": "The type of External Source Code Management.\n" }, "isAutomergeEnabled": { "type": "boolean", "description": "If true, the Pull Request (PR) will be merged after the verify stage completes successfully If false, the PR with the proposed changes must be reviewed and manually merged.\n" }, "ociCodeRepositoryId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure DevOps repository.\n" }, "patSecretId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.\n" }, "repositoryUrl": { "type": "string", "description": "The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName]\n" }, "scmType": { "type": "string", "description": "The type of Source Code Management.\n" }, "username": { "type": "string", "description": "The username that will be used to authenticate with Jenkins.\n" } }, "type": "object", "required": [ "branch", "buildFileLocation", "externalScmType", "isAutomergeEnabled", "ociCodeRepositoryId", "patSecretId", "repositoryUrl", "scmType", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipeVerifyConfiguration:getRemediationRecipeVerifyConfiguration": { "properties": { "additionalParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional key-value pairs passed as parameters to the build service when running an experiment.\n" }, "buildServiceType": { "type": "string", "description": "The type of Build Service.\n" }, "jenkinsUrl": { "type": "string", "description": "The URL that locates the Jenkins pipeline.\n" }, "jobName": { "type": "string", "description": "The name of the Jenkins pipeline job that identifies the build pipeline.\n" }, "patSecretId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.\n" }, "pipelineId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the user's DevOps Build Pipeline.\n" }, "repositoryUrl": { "type": "string", "description": "The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName]\n" }, "triggerSecretId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the trigger Secret. The Secret provides access to the trigger for a GitLab pipeline.\n" }, "username": { "type": "string", "description": "The username that will be used to authenticate with Jenkins.\n" }, "workflowName": { "type": "string", "description": "The name of the GitHub Actions workflow that defines the build pipeline.\n" } }, "type": "object", "required": [ "additionalParameters", "buildServiceType", "jenkinsUrl", "jobName", "patSecretId", "pipelineId", "repositoryUrl", "triggerSecretId", "username", "workflowName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipesFilter:getRemediationRecipesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getRemediationRecipesRemediationRecipeCollection:getRemediationRecipesRemediationRecipeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRecipesRemediationRecipeCollectionItem:getRemediationRecipesRemediationRecipeCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipesRemediationRecipeCollectionItem:getRemediationRecipesRemediationRecipeCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "detectConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemDetectConfiguration:getRemediationRecipesRemediationRecipeCollectionItemDetectConfiguration" }, "description": "A configuration to define the constraints when detecting vulnerable dependencies and recommending remediations.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.\n" }, "isRunTriggeredOnKbChange": { "type": "boolean", "description": "Boolean indicating if a run should be automatically triggered once the Knowledge Base contents are updated.\n" }, "knowledgeBaseId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the knowledge base.\n" }, "networkConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemNetworkConfiguration:getRemediationRecipesRemediationRecipeCollectionItemNetworkConfiguration" }, "description": "A network configuration defines the required network characteristics for the remediation run of the recipe to access the source repository and/or verify build services.\n" }, "scmConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemScmConfiguration:getRemediationRecipesRemediationRecipeCollectionItemScmConfiguration" }, "description": "A configuration for the Source Code Management tool/platform used by a remediation recipe.\n" }, "state": { "type": "string", "description": "A filter to return only Remediation Recipes that match the specified lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the Remediation Recipe (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeUpdated": { "type": "string", "description": "The date and time the Remediation Recipe was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "verifyConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemVerifyConfiguration:getRemediationRecipesRemediationRecipeCollectionItemVerifyConfiguration" }, "description": "The Verify stage configuration specifies a build service to run a pipeline for the recommended code changes. The build pipeline will be initiated to ensure that there is no breaking change after the dependency versions have been updated in source to avoid vulnerabilities.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "detectConfigurations", "displayName", "freeformTags", "id", "isRunTriggeredOnKbChange", "knowledgeBaseId", "networkConfigurations", "scmConfigurations", "state", "systemTags", "timeCreated", "timeUpdated", "verifyConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemDetectConfiguration:getRemediationRecipesRemediationRecipeCollectionItemDetectConfiguration": { "properties": { "exclusions": { "type": "array", "items": { "type": "string" }, "description": "The list of dependencies to be ignored by the recommendation algorithm. The dependency pattern is matched against the 'group:artifact:version' or the purl of a dependency. An asterisk (*) at the end in the dependency pattern acts as a wildcard and matches zero or more characters.\n" }, "maxPermissibleCvssV2score": { "type": "number", "description": "The maximum Common Vulnerability Scoring System Version 2 (CVSS V2) score. A vulnerability with a CVSS V2 score below this value is not considered for remediation.\n" }, "maxPermissibleCvssV3score": { "type": "number", "description": "The maximum Common Vulnerability Scoring System Version 3 (CVSS V3) score. A vulnerability with a CVSS V3 score below this value is not considered for patching.\n" }, "maxPermissibleSeverity": { "type": "string", "description": "The maximum ADM Severity. A vulnerability with an severity below this value is not considered for remediation.\n" }, "upgradePolicy": { "type": "string", "description": "The upgrade policy for recommendations. The `Nearest` upgrade policy upgrades a dependency to the oldest version that meets both of the following criteria: it is newer than the current version and it is not affected by a vulnerability.\n" } }, "type": "object", "required": [ "exclusions", "maxPermissibleCvssV2score", "maxPermissibleCvssV3score", "maxPermissibleSeverity", "upgradePolicy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemNetworkConfiguration:getRemediationRecipesRemediationRecipeCollectionItemNetworkConfiguration": { "properties": { "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "The list of Oracle Cloud Identifiers ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) corresponding to Network Security Groups.\n" }, "subnetId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the subnet.\n" } }, "type": "object", "required": [ "nsgIds", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemScmConfiguration:getRemediationRecipesRemediationRecipeCollectionItemScmConfiguration": { "properties": { "branch": { "type": "string", "description": "The branch used by ADM to patch vulnerabilities.\n" }, "buildFileLocation": { "type": "string", "description": "The location of the build file relative to the root of the repository. Only Maven build files (POM) are currently supported. If this property is not specified, ADM will use the build file located at the root of the repository.\n" }, "externalScmType": { "type": "string", "description": "The type of External Source Code Management.\n" }, "isAutomergeEnabled": { "type": "boolean", "description": "If true, the Pull Request (PR) will be merged after the verify stage completes successfully If false, the PR with the proposed changes must be reviewed and manually merged.\n" }, "ociCodeRepositoryId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure DevOps repository.\n" }, "patSecretId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.\n" }, "repositoryUrl": { "type": "string", "description": "The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName]\n" }, "scmType": { "type": "string", "description": "The type of Source Code Management.\n" }, "username": { "type": "string", "description": "The username that will be used to authenticate with Jenkins.\n" } }, "type": "object", "required": [ "branch", "buildFileLocation", "externalScmType", "isAutomergeEnabled", "ociCodeRepositoryId", "patSecretId", "repositoryUrl", "scmType", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRecipesRemediationRecipeCollectionItemVerifyConfiguration:getRemediationRecipesRemediationRecipeCollectionItemVerifyConfiguration": { "properties": { "additionalParameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional key-value pairs passed as parameters to the build service when running an experiment.\n" }, "buildServiceType": { "type": "string", "description": "The type of Build Service.\n" }, "jenkinsUrl": { "type": "string", "description": "The URL that locates the Jenkins pipeline.\n" }, "jobName": { "type": "string", "description": "The name of the Jenkins pipeline job that identifies the build pipeline.\n" }, "patSecretId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Private Access Token (PAT) Secret. The PAT provides the credentials to access the Jenkins Pipeline.\n" }, "pipelineId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the user's DevOps Build Pipeline.\n" }, "repositoryUrl": { "type": "string", "description": "The location of the repository where the GitHub Actions is defined. For Non-Enterprise GitHub the expected format is https://github.com/[owner]/[repoName] For Enterprise GitHub the expected format is http(s)://[hostname]/api/v3/repos/[owner]/[repoName]\n" }, "triggerSecretId": { "type": "string", "description": "The Oracle Cloud Identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the trigger Secret. The Secret provides access to the trigger for a GitLab pipeline.\n" }, "username": { "type": "string", "description": "The username that will be used to authenticate with Jenkins.\n" }, "workflowName": { "type": "string", "description": "The name of the GitHub Actions workflow that defines the build pipeline.\n" } }, "type": "object", "required": [ "additionalParameters", "buildServiceType", "jenkinsUrl", "jobName", "patSecretId", "pipelineId", "repositoryUrl", "triggerSecretId", "username", "workflowName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollection:getRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollectionItem:getRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollectionItem" }, "description": "List of application recommendation summaries.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollectionItem:getRemediationRunApplicationDependencyRecommendationsApplicationDependencyRecommendationCollectionItem": { "properties": { "applicationDependencyNodeIds": { "type": "array", "items": { "type": "string" }, "description": "List of (application dependencies) node identifiers from which this node depends.\n" }, "gav": { "type": "string", "description": "A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given.\n" }, "nodeId": { "type": "string", "description": "Unique node identifier of an application dependency with an associated Recommendation, e.g. nodeId1.\n" }, "purl": { "type": "string", "description": "A filter to return only resources that match the entire purl given.\n" }, "recommendedGav": { "type": "string", "description": "Recommended application dependency in \"group:artifact:version\" (GAV) format, e.g. org.graalvm.nativeimage:svm:21.2.0.\n" }, "recommendedPurl": { "type": "string", "description": "Recommended application dependency in purl format, e.g. pkg:maven/org.graalvm.nativeimage/svm@21.2.0\n" } }, "type": "object", "required": [ "applicationDependencyNodeIds", "gav", "nodeId", "purl", "recommendedGav", "recommendedPurl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunApplicationDependencyRecommendationsFilter:getRemediationRunApplicationDependencyRecommendationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getRemediationRunStage:getRemediationRunStage": { "properties": { "summary": { "type": "string", "description": "Information about the current step within the given stage.\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeFinished": { "type": "string", "description": "The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeStarted": { "type": "string", "description": "The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "type": { "type": "string", "description": "The type of stage.\n" } }, "type": "object", "required": [ "summary", "timeCreated", "timeFinished", "timeStarted", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunStagePipelineProperty:getRemediationRunStagePipelineProperty": { "properties": { "pipelineIdentifier": { "type": "string", "description": "Unique identifier for the pipeline or action created in the Verify stage.\n" }, "pipelineUrl": { "type": "string", "description": "The web link to the pipeline from the Verify stage.\n" } }, "type": "object", "required": [ "pipelineIdentifier", "pipelineUrl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunStagePullRequestProperty:getRemediationRunStagePullRequestProperty": { "properties": { "pullRequestIdentifier": { "type": "string", "description": "Unique identifier for the pull or merge request created in the recommend stage.\n" }, "pullRequestUrl": { "type": "string", "description": "The web link to the pull or merge request created in the recommend stage.\n" } }, "type": "object", "required": [ "pullRequestIdentifier", "pullRequestUrl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunStagesFilter:getRemediationRunStagesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getRemediationRunStagesRemediationRunStageCollection:getRemediationRunStagesRemediationRunStageCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRunStagesRemediationRunStageCollectionItem:getRemediationRunStagesRemediationRunStageCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunStagesRemediationRunStageCollectionItem:getRemediationRunStagesRemediationRunStageCollectionItem": { "properties": { "auditId": { "type": "string", "description": "The Oracle Cloud identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the vulnerability audit.\n" }, "nextStageType": { "type": "string", "description": "The next type of stage in the remediation run.\n" }, "pipelineProperties": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRunStagesRemediationRunStageCollectionItemPipelineProperty:getRemediationRunStagesRemediationRunStageCollectionItemPipelineProperty" }, "description": "Pipeline properties which result from the run of the verify stage.\n" }, "previousStageType": { "type": "string", "description": "The previous type of stage in the remediation run.\n" }, "pullRequestProperties": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRunStagesRemediationRunStageCollectionItemPullRequestProperty:getRemediationRunStagesRemediationRunStageCollectionItemPullRequestProperty" }, "description": "Pull request properties from recommend stage of the remediation run.\n" }, "recommendedUpdatesCount": { "type": "integer", "description": "Count of recommended application dependencies to update.\n" }, "remediationRunId": { "type": "string", "description": "Unique Remediation Run identifier path parameter.\n" }, "status": { "type": "string", "description": "A filter to return only Stages that match the specified status.\n" }, "summary": { "type": "string", "description": "Information about the current step within the stage.\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the remediation run stage (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeFinished": { "type": "string", "description": "The date and time of the finish of the remediation run stage (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeStarted": { "type": "string", "description": "The date and time of the start of the remediation run stage (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "type": { "type": "string", "description": "A filter to return only Stages that match the specified type.\n" } }, "type": "object", "required": [ "auditId", "nextStageType", "pipelineProperties", "previousStageType", "pullRequestProperties", "recommendedUpdatesCount", "remediationRunId", "status", "summary", "timeCreated", "timeFinished", "timeStarted", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunStagesRemediationRunStageCollectionItemPipelineProperty:getRemediationRunStagesRemediationRunStageCollectionItemPipelineProperty": { "properties": { "pipelineIdentifier": { "type": "string", "description": "Unique identifier for the pipeline or action created in the Verify stage.\n" }, "pipelineUrl": { "type": "string", "description": "The web link to the pipeline from the Verify stage.\n" } }, "type": "object", "required": [ "pipelineIdentifier", "pipelineUrl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunStagesRemediationRunStageCollectionItemPullRequestProperty:getRemediationRunStagesRemediationRunStageCollectionItemPullRequestProperty": { "properties": { "pullRequestIdentifier": { "type": "string", "description": "Unique identifier for the pull or merge request created in the recommend stage.\n" }, "pullRequestUrl": { "type": "string", "description": "The web link to the pull or merge request created in the recommend stage.\n" } }, "type": "object", "required": [ "pullRequestIdentifier", "pullRequestUrl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunsFilter:getRemediationRunsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getRemediationRunsRemediationRunCollection:getRemediationRunsRemediationRunCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRunsRemediationRunCollectionItem:getRemediationRunsRemediationRunCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunsRemediationRunCollectionItem:getRemediationRunsRemediationRunCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.\n" }, "currentStageType": { "type": "string", "description": "The type of the current stage of the remediation run.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.\n" }, "remediationRecipeId": { "type": "string", "description": "A filter to return only resources that match the specified Remediation Recipe identifier.\n" }, "remediationRunSource": { "type": "string", "description": "The source that triggered the Remediation Recipe.\n" }, "stages": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getRemediationRunsRemediationRunCollectionItemStage:getRemediationRunsRemediationRunCollectionItemStage" }, "description": "The list of remediation run stage summaries.\n" }, "state": { "type": "string", "description": "A filter to return only Remediation Runs that match the specified lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeFinished": { "type": "string", "description": "The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeStarted": { "type": "string", "description": "The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeUpdated": { "type": "string", "description": "The date and time the remediation run was last updated (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" } }, "type": "object", "required": [ "compartmentId", "currentStageType", "definedTags", "displayName", "freeformTags", "id", "remediationRecipeId", "remediationRunSource", "stages", "state", "systemTags", "timeCreated", "timeFinished", "timeStarted", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getRemediationRunsRemediationRunCollectionItemStage:getRemediationRunsRemediationRunCollectionItemStage": { "properties": { "summary": { "type": "string", "description": "Information about the current step within the given stage.\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeFinished": { "type": "string", "description": "The date and time of the finish of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeStarted": { "type": "string", "description": "The date and time of the start of the remediation run (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "type": { "type": "string", "description": "The type of stage.\n" } }, "type": "object", "required": [ "summary", "timeCreated", "timeFinished", "timeStarted", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependency:getVulnerabilityAuditApplicationDependency": { "properties": { "applicationDependencyNodeIds": { "type": "array", "items": { "type": "string" } }, "gav": { "type": "string" }, "nodeId": { "type": "string" }, "purl": { "type": "string" } }, "type": "object", "required": [ "applicationDependencyNodeIds", "gav", "nodeId", "purl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollection:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItem:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItem" }, "description": "List of vulnerability audit summaries.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItem:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItem": { "properties": { "applicationDependencyNodeIds": { "type": "array", "items": { "type": "string" }, "description": "List of application dependencies on which this application dependency depends, each identified by its nodeId.\n" }, "gav": { "type": "string", "description": "A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given.\n" }, "isFoundInKnowledgeBase": { "type": "boolean", "description": "Indicates if the artifact is found in the knowledge base, this field is deprecated and will be removed in the future.\n" }, "nodeId": { "type": "string", "description": "Unique identifier of an application dependency, for example nodeId1.\n" }, "purl": { "type": "string", "description": "A filter to return only resources that match the entire purl given.\n" }, "vulnerabilities": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerability:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerability" }, "description": "List of vulnerabilities for the application dependency.\n" }, "warnings": { "type": "array", "items": { "type": "string" }, "description": "Potential issues in the artifact identifiers (purls) provided by the user, that the user is alerted about. ADM supports the following warnings:\n* MISSING_VERSION: Missing version\n* INCORRECT_FORMAT_VERSION: Version can not be parsed according to the ecosystem\n* UNKNOWN_ECOSYSTEM: The purl's ecosystem is unknown to ADM\n* INCORRECT_FORMAT_EPOCH: Epoch qualifier can not be parsed according to the ecosystem\n* MISSING_DISTRO: The distro qualifier is required for the ecosystem, but was not provided in the purl\n* UNKNOWN_DISTRO: ADM does not have data for the provided distro value for the given ecosystem\n* MISSING_ARCH: The arch qualifier is required for the ecosystem and distro, but was not provided in the purl\n* UNKNOWN_ARCH: ADM does not have data for the provided arch value for the given ecosystem and distro\n* EPOCH_VALUE_MISMATCH: Epoch value in qualifier is not the same as the epoch value in version\n* INVALID_PURL: The provided PURL could not be parsed\n" } }, "type": "object", "required": [ "applicationDependencyNodeIds", "gav", "isFoundInKnowledgeBase", "nodeId", "purl", "vulnerabilities", "warnings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerability:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerability": { "properties": { "cvssV2score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 2, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV2Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "cvssV3score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 3, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV3Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "id": { "type": "string", "description": "Unique vulnerability identifier, e.g. CVE-1999-0067.\n" }, "isFalsePositive": { "type": "boolean", "description": "Indicates if the vulnerability is a false positive according to the usage data. If no usage data was provided or the service cannot infer usage of the vulnerable code then this property is \u003cspan pulumi-lang-nodejs=\"`null`\" pulumi-lang-dotnet=\"`Null`\" pulumi-lang-go=\"`null`\" pulumi-lang-python=\"`null`\" pulumi-lang-yaml=\"`null`\" pulumi-lang-java=\"`null`\" pulumi-lang-hcl=\"`null`\"\u003e`null`\u003c/span\u003e.\n" }, "isIgnored": { "type": "boolean", "description": "Indicates if the vulnerability was ignored according to the audit configuration.\n" }, "matchingVulnerableArtifactVersionRanges": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange" }, "description": "List of artifact version ranges affected by a particular vulnerability.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMetric:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMetric" }, "description": "List of reported metrics by the source.\n" }, "severity": { "type": "string", "description": "ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL.\n" }, "source": { "type": "string", "description": "Source that published the vulnerability\n" } }, "type": "object", "required": [ "cvssV2score", "cvssV3score", "id", "isFalsePositive", "isIgnored", "matchingVulnerableArtifactVersionRanges", "metrics", "severity", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange": { "properties": { "versionEndExcluding": { "type": "string", "description": "The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable.\n" }, "versionEndIncluding": { "type": "string", "description": "Marks the latest version that is affected by the vulnerability. This version and all preceding versions, going back to versionStartExcluding or versionStartIncluding, are considered vulnerable.\n" }, "versionStartExcluding": { "type": "string", "description": "The version immediately before the start of affected versions. The specified version is not affected, but versions immediately after are, up to versionStartIncluding or beyond, if not otherwise defined.\n" }, "versionStartIncluding": { "type": "string", "description": "The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached.\n" } }, "type": "object", "required": [ "versionEndExcluding", "versionEndIncluding", "versionStartExcluding", "versionStartIncluding" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMetric:getVulnerabilityAuditApplicationDependencyVulnerabilitiesApplicationDependencyVulnerabilityCollectionItemVulnerabilityMetric": { "properties": { "score": { "type": "number", "description": "Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system.\n" }, "source": { "type": "string", "description": "Source that published the vulnerability\n" }, "type": { "type": "string", "description": "Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity.\n" }, "value": { "type": "string", "description": "Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector.\n" } }, "type": "object", "required": [ "score", "source", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilitiesFilter:getVulnerabilityAuditApplicationDependencyVulnerabilitiesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItem:getVulnerabilityAuditApplicationDependencyVulnerabilityItem": { "properties": { "applicationDependencyNodeIds": { "type": "array", "items": { "type": "string" }, "description": "List of Application Dependencies on which this Application Dependency depends, each identified by its nodeId.\n" }, "gav": { "type": "string", "description": "A filter to return only resources that match the entire GAV (Group Artifact Version) identifier given.\n" }, "isFoundInKnowledgeBase": { "type": "boolean", "description": "Indicates if the artifact is found in the knowledge base.\n" }, "nodeId": { "type": "string", "description": "Unique identifier of an Application Dependency, for example nodeId1.\n" }, "purl": { "type": "string" }, "vulnerabilities": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerability:getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerability" }, "description": "List of vulnerabilities for the Application Dependency.\n" } }, "type": "object", "required": [ "applicationDependencyNodeIds", "gav", "isFoundInKnowledgeBase", "nodeId", "purl", "vulnerabilities" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerability:getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerability": { "properties": { "cvssV2score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 2.\n" }, "cvssV3score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 3.\n" }, "id": { "type": "string", "description": "Unique vulnerability identifier, e.g. CVE-1999-0067.\n" }, "isFalsePositive": { "type": "boolean" }, "isIgnored": { "type": "boolean", "description": "Indicates if the vulnerability was ignored according to the audit configuration.\n" }, "matchingVulnerableArtifactVersionRanges": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMatchingVulnerableArtifactVersionRange" } }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMetric:getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMetric" } }, "severity": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "cvssV2score", "cvssV3score", "id", "isFalsePositive", "isIgnored", "matchingVulnerableArtifactVersionRanges", "metrics", "severity", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMatchingVulnerableArtifactVersionRange": { "properties": { "versionEndExcluding": { "type": "string" }, "versionEndIncluding": { "type": "string" }, "versionStartExcluding": { "type": "string" }, "versionStartIncluding": { "type": "string" } }, "type": "object", "required": [ "versionEndExcluding", "versionEndIncluding", "versionStartExcluding", "versionStartIncluding" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMetric:getVulnerabilityAuditApplicationDependencyVulnerabilityItemVulnerabilityMetric": { "properties": { "score": { "type": "number" }, "source": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "score", "source", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditConfiguration:getVulnerabilityAuditConfiguration": { "properties": { "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A vulnerable application dependency is ignored if its name matches any of the items in \u003cspan pulumi-lang-nodejs=\"`exclusions`\" pulumi-lang-dotnet=\"`Exclusions`\" pulumi-lang-go=\"`exclusions`\" pulumi-lang-python=\"`exclusions`\" pulumi-lang-yaml=\"`exclusions`\" pulumi-lang-java=\"`exclusions`\" pulumi-lang-hcl=\"`exclusions`\"\u003e`exclusions`\u003c/span\u003e. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters.\n" }, "maxPermissibleCvssV2score": { "type": "number", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.\n" }, "maxPermissibleCvssV3score": { "type": "number", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.\n" }, "maxPermissibleSeverity": { "type": "string", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity.\n" } }, "type": "object", "required": [ "exclusions", "maxPermissibleCvssV2score", "maxPermissibleCvssV3score", "maxPermissibleSeverity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditSource:getVulnerabilityAuditSource": { "properties": { "description": { "type": "string", "description": "Description of the external resource source.\n" }, "ociResourceId": { "type": "string", "description": "The Oracle Cloud identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure resource that triggered the vulnerability audit.\n" }, "type": { "type": "string", "description": "Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity.\n" } }, "type": "object", "required": [ "description", "ociResourceId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditUsageData:getVulnerabilityAuditUsageData": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket to read the usage data from.\n" }, "namespace": { "type": "string", "description": "The Object Storage namespace to read the usage data from.\n" }, "object": { "type": "string", "description": "The Object Storage object name to read the usage data from.\n" }, "sourceType": { "type": "string", "description": "The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name.\n" } }, "type": "object", "required": [ "bucket", "namespace", "object", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditVulnerability:getVulnerabilityAuditVulnerability": { "properties": { "cvssV2score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 2, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV2Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "cvssV3score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 3, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV3Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "id": { "type": "string", "description": "Unique vulnerability identifier, e.g. CVE-1999-0067.\n" }, "isFalsePositive": { "type": "boolean", "description": "Indicates if the vulnerability is a false positive according to the usage data. If no usage data was provided or the service cannot infer usage of the vulnerable code then this property is \u003cspan pulumi-lang-nodejs=\"`null`\" pulumi-lang-dotnet=\"`Null`\" pulumi-lang-go=\"`null`\" pulumi-lang-python=\"`null`\" pulumi-lang-yaml=\"`null`\" pulumi-lang-java=\"`null`\" pulumi-lang-hcl=\"`null`\"\u003e`null`\u003c/span\u003e.\n" }, "isIgnored": { "type": "boolean", "description": "Indicates if the vulnerability was ignored according to the audit configuration.\n" }, "matchingVulnerableArtifactVersionRanges": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange" }, "description": "List of artifact version ranges affected by a particular vulnerability.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditVulnerabilityMetric:getVulnerabilityAuditVulnerabilityMetric" }, "description": "List of reported metrics by the source.\n" }, "severity": { "type": "string", "description": "ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL.\n" }, "source": { "type": "string", "description": "Source that published the vulnerability\n" } }, "type": "object", "required": [ "cvssV2score", "cvssV3score", "id", "isFalsePositive", "isIgnored", "matchingVulnerableArtifactVersionRanges", "metrics", "severity", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditVulnerabilityFilter:getVulnerabilityAuditVulnerabilityFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getVulnerabilityAuditVulnerabilityItem:getVulnerabilityAuditVulnerabilityItem": { "properties": { "isDirectVulnerability": { "type": "boolean" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditVulnerabilityItemMetric:getVulnerabilityAuditVulnerabilityItemMetric" } }, "references": { "type": "array", "items": { "type": "string" } }, "relatedVulnerabilities": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditVulnerabilityItemRelatedVulnerability:getVulnerabilityAuditVulnerabilityItemRelatedVulnerability" } }, "severity": { "type": "string" }, "source": { "type": "string" }, "status": { "type": "string" }, "timeCreated": { "type": "string" }, "timeUpdated": { "type": "string" }, "vulnerabilityDescription": { "type": "string" }, "vulnerabilityId": { "type": "string" }, "vulnerabilitySummary": { "type": "string" } }, "type": "object", "required": [ "isDirectVulnerability", "metrics", "references", "relatedVulnerabilities", "severity", "source", "status", "timeCreated", "timeUpdated", "vulnerabilityDescription", "vulnerabilityId", "vulnerabilitySummary" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditVulnerabilityItemMetric:getVulnerabilityAuditVulnerabilityItemMetric": { "properties": { "score": { "type": "number" }, "source": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "score", "source", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditVulnerabilityItemRelatedVulnerability:getVulnerabilityAuditVulnerabilityItemRelatedVulnerability": { "properties": { "id": { "type": "string" }, "source": { "type": "string" } }, "type": "object", "required": [ "id", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditVulnerabilityMatchingVulnerableArtifactVersionRange": { "properties": { "versionEndExcluding": { "type": "string", "description": "The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable.\n" }, "versionEndIncluding": { "type": "string", "description": "Marks the latest version that is affected by the vulnerability. This version and all preceding versions, going back to versionStartExcluding or versionStartIncluding, are considered vulnerable.\n" }, "versionStartExcluding": { "type": "string", "description": "The version immediately before the start of affected versions. The specified version is not affected, but versions immediately after are, up to versionStartIncluding or beyond, if not otherwise defined.\n" }, "versionStartIncluding": { "type": "string", "description": "The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached.\n" } }, "type": "object", "required": [ "versionEndExcluding", "versionEndIncluding", "versionStartExcluding", "versionStartIncluding" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditVulnerabilityMetric:getVulnerabilityAuditVulnerabilityMetric": { "properties": { "score": { "type": "number", "description": "Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system.\n" }, "source": { "type": "string", "description": "Source that published the vulnerability\n" }, "type": { "type": "string", "description": "Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity.\n" }, "value": { "type": "string", "description": "Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector.\n" } }, "type": "object", "required": [ "score", "source", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsFilter:getVulnerabilityAuditsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollection:getVulnerabilityAuditsVulnerabilityAuditCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItem:getVulnerabilityAuditsVulnerabilityAuditCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItem:getVulnerabilityAuditsVulnerabilityAuditCollectionItem": { "properties": { "applicationDependencies": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemApplicationDependency:getVulnerabilityAuditsVulnerabilityAuditCollectionItemApplicationDependency" } }, "buildType": { "type": "string", "description": "The type of the build tool is restricted to only two values MAVEN or UNSET. Use UNSET when the list of application dependencies is not Maven-related or is a mix of Maven and other ecosystems. This option is soon to be deprecated.\n" }, "compartmentId": { "type": "string", "description": "A filter to return only resources that belong to the specified compartment identifier. Required only if the id query param is not specified.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemConfiguration:getVulnerabilityAuditsVulnerabilityAuditCollectionItemConfiguration" }, "description": "Configuration for a vulnerability audit. A vulnerable application dependency is ignored if its name does match any of the items in \u003cspan pulumi-lang-nodejs=\"`exclusions`\" pulumi-lang-dotnet=\"`Exclusions`\" pulumi-lang-go=\"`exclusions`\" pulumi-lang-python=\"`exclusions`\" pulumi-lang-yaml=\"`exclusions`\" pulumi-lang-java=\"`exclusions`\" pulumi-lang-hcl=\"`exclusions`\"\u003e`exclusions`\u003c/span\u003e, or all of the associated Vulnerabilies have a CVSS v2 score below `maxPermissibleCvssV2Score` and a CVSS v3 score below `maxPermissibleCvssV3Score`. type: object\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.\n" }, "isSuccess": { "type": "boolean", "description": "A filter to return only successful or failed Vulnerability Audits.\n" }, "knowledgeBaseId": { "type": "string", "description": "A filter to return only Audits that were created against the specified knowledge base.\n" }, "lifecycleDetails": { "type": "string", "description": "Details on the lifecycle state.\n" }, "maxObservedCvssV2score": { "type": "number", "description": "Maximum Common Vulnerability Scoring System Version 2 score observed for non-ignored vulnerable application dependencies.\n" }, "maxObservedCvssV2scoreWithIgnored": { "type": "number", "description": "Maximum Common Vulnerability Scoring System Version 2 score observed for vulnerable application dependencies including ignored ones.\n" }, "maxObservedCvssV3score": { "type": "number", "description": "Maximum Common Vulnerability Scoring System Version 3 score observed for non-ignored vulnerable application dependencies.\n" }, "maxObservedCvssV3scoreWithIgnored": { "type": "number", "description": "Maximum Common Vulnerability Scoring System Version 3 score observed for vulnerable application dependencies including ignored ones.\n" }, "maxObservedSeverity": { "type": "string", "description": "Maximum ADM Severity observed for non-ignored vulnerable application dependencies.\n" }, "maxObservedSeverityWithIgnored": { "type": "string", "description": "Maximum ADM Severity observed for vulnerable application dependencies including ignored ones.\n" }, "sources": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemSource:getVulnerabilityAuditsVulnerabilityAuditCollectionItemSource" }, "description": "Source that published the vulnerability\n" }, "state": { "type": "string", "description": "A filter to return only Vulnerability Audits that match the specified lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The creation date and time of the vulnerability audit (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "timeUpdated": { "type": "string", "description": "The update date and time of the vulnerability audit (formatted according to [RFC3339](https://datatracker.ietf.org/doc/html/rfc3339)).\n" }, "usageDatas": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemUsageData:getVulnerabilityAuditsVulnerabilityAuditCollectionItemUsageData" }, "description": "The source details of the usage data in object storage. The usage data file uploaded to object storage must be a gzip archive of the JSON usage data returned from the GraalVM native-image-inspect tool after a native-image build. Set `sourceType` to `objectStorageTuple` and use [UsageDataViaObjectStorageTupleDetails](https://docs.cloud.oracle.com/iaas/api/#/en/adm/latest/requests/UsageDataViaObjectStorageTupleDetails) when specifying the namespace, bucket name, and object name.\n" }, "vulnerabilities": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerability:getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerability" }, "description": "List of vulnerabilities found in the vulnerability audit. If a vulnerability affects multiple dependencies, the metadata returned here consists of audit-wide aggregates.\n" }, "vulnerableArtifactsCount": { "type": "integer", "description": "Count of non-ignored vulnerable application dependencies.\n" }, "vulnerableArtifactsCountWithIgnored": { "type": "integer", "description": "Count of all vulnerable application dependencies.\n" } }, "type": "object", "required": [ "applicationDependencies", "buildType", "compartmentId", "configurations", "definedTags", "displayName", "freeformTags", "id", "isSuccess", "knowledgeBaseId", "lifecycleDetails", "maxObservedCvssV2score", "maxObservedCvssV2scoreWithIgnored", "maxObservedCvssV3score", "maxObservedCvssV3scoreWithIgnored", "maxObservedSeverity", "maxObservedSeverityWithIgnored", "sources", "state", "systemTags", "timeCreated", "timeUpdated", "usageDatas", "vulnerabilities", "vulnerableArtifactsCount", "vulnerableArtifactsCountWithIgnored" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemApplicationDependency:getVulnerabilityAuditsVulnerabilityAuditCollectionItemApplicationDependency": { "properties": { "applicationDependencyNodeIds": { "type": "array", "items": { "type": "string" } }, "gav": { "type": "string" }, "nodeId": { "type": "string" }, "purl": { "type": "string" } }, "type": "object", "required": [ "applicationDependencyNodeIds", "gav", "nodeId", "purl" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemConfiguration:getVulnerabilityAuditsVulnerabilityAuditCollectionItemConfiguration": { "properties": { "exclusions": { "type": "array", "items": { "type": "string" }, "description": "A vulnerable application dependency is ignored if its name matches any of the items in \u003cspan pulumi-lang-nodejs=\"`exclusions`\" pulumi-lang-dotnet=\"`Exclusions`\" pulumi-lang-go=\"`exclusions`\" pulumi-lang-python=\"`exclusions`\" pulumi-lang-yaml=\"`exclusions`\" pulumi-lang-java=\"`exclusions`\" pulumi-lang-hcl=\"`exclusions`\"\u003e`exclusions`\u003c/span\u003e. An asterisk (*) in the dependency pattern acts as a wildcard and matches zero or more characters.\n" }, "maxPermissibleCvssV2score": { "type": "number", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.\n" }, "maxPermissibleCvssV3score": { "type": "number", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleCvssV2Score and below maxPermissibleCvssV3Score.\n" }, "maxPermissibleSeverity": { "type": "string", "description": "A vulnerable application dependency is ignored if the score of its associated Vulnerability is below maxPermissibleSeverity.\n" } }, "type": "object", "required": [ "exclusions", "maxPermissibleCvssV2score", "maxPermissibleCvssV3score", "maxPermissibleSeverity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemSource:getVulnerabilityAuditsVulnerabilityAuditCollectionItemSource": { "properties": { "description": { "type": "string", "description": "Description of the external resource source.\n" }, "ociResourceId": { "type": "string", "description": "The Oracle Cloud identifier ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) of the Oracle Cloud Infrastructure resource that triggered the vulnerability audit.\n" }, "type": { "type": "string", "description": "Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity.\n" } }, "type": "object", "required": [ "description", "ociResourceId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemUsageData:getVulnerabilityAuditsVulnerabilityAuditCollectionItemUsageData": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket to read the usage data from.\n" }, "namespace": { "type": "string", "description": "The Object Storage namespace to read the usage data from.\n" }, "object": { "type": "string", "description": "The Object Storage object name to read the usage data from.\n" }, "sourceType": { "type": "string", "description": "The destination type. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name.\n" } }, "type": "object", "required": [ "bucket", "namespace", "object", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerability:getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerability": { "properties": { "cvssV2score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 2, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV2Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "cvssV3score": { "type": "number", "description": "Common Vulnerability Scoring System (CVSS) Version 3, calculated from the metrics provided in the CVSS vector provided from the vulnerability source. This field is deprecated and will be removed in the future. The cvssV3Score can be obtained from the metrics field of the listVulnerabilities endpoint.\n" }, "id": { "type": "string", "description": "A filter to return only resources that match the specified identifier. Required only if the compartmentId query parameter is not specified.\n" }, "isFalsePositive": { "type": "boolean", "description": "Indicates if the vulnerability is a false positive according to the usage data. If no usage data was provided or the service cannot infer usage of the vulnerable code then this property is \u003cspan pulumi-lang-nodejs=\"`null`\" pulumi-lang-dotnet=\"`Null`\" pulumi-lang-go=\"`null`\" pulumi-lang-python=\"`null`\" pulumi-lang-yaml=\"`null`\" pulumi-lang-java=\"`null`\" pulumi-lang-hcl=\"`null`\"\u003e`null`\u003c/span\u003e.\n" }, "isIgnored": { "type": "boolean", "description": "Indicates if the vulnerability was ignored according to the audit configuration.\n" }, "matchingVulnerableArtifactVersionRanges": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange" }, "description": "List of artifact version ranges affected by a particular vulnerability.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMetric:getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMetric" }, "description": "List of reported metrics by the source.\n" }, "severity": { "type": "string", "description": "ADM qualitative severity score. Can be either NONE, LOW, MEDIUM, HIGH or CRITICAL.\n" }, "source": { "type": "string", "description": "Source that published the vulnerability\n" } }, "type": "object", "required": [ "cvssV2score", "cvssV3score", "id", "isFalsePositive", "isIgnored", "matchingVulnerableArtifactVersionRanges", "metrics", "severity", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange:getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMatchingVulnerableArtifactVersionRange": { "properties": { "versionEndExcluding": { "type": "string", "description": "The version immediately after the last affected version. Versions up to, but not including this version, are vulnerable.\n" }, "versionEndIncluding": { "type": "string", "description": "Marks the latest version that is affected by the vulnerability. This version and all preceding versions, going back to versionStartExcluding or versionStartIncluding, are considered vulnerable.\n" }, "versionStartExcluding": { "type": "string", "description": "The version immediately before the start of affected versions. The specified version is not affected, but versions immediately after are, up to versionStartIncluding or beyond, if not otherwise defined.\n" }, "versionStartIncluding": { "type": "string", "description": "The first version affected by the vulnerability. This version and those following it are considered vulnerable until versionEndExcluding or versionEndIncluding is reached.\n" } }, "type": "object", "required": [ "versionEndExcluding", "versionEndIncluding", "versionStartExcluding", "versionStartIncluding" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Adm/getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMetric:getVulnerabilityAuditsVulnerabilityAuditCollectionItemVulnerabilityMetric": { "properties": { "score": { "type": "number", "description": "Numerical representation of metric (if exists). For example for CVSS vectors, the score is the base score according to the CVSS scoring system.\n" }, "source": { "type": "string", "description": "Source that published the vulnerability\n" }, "type": { "type": "string", "description": "Type of the vulnerability metric e.g., CVSS2, CVSS3, Severity.\n" }, "value": { "type": "string", "description": "Value of the vulnerability metric e.g., a string representation of a severity value or a cvss vector.\n" } }, "type": "object", "required": [ "score", "source", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/ModelComponentModel:ModelComponentModel": { "properties": { "modelId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "modelId" ] } } }, "oci:AiDocument/ModelLock:ModelLock": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The compartment identifier.\n" }, "message": { "type": "string", "description": "A message added by the lock creator. The message typically gives an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.\n" }, "timeCreated": { "type": "string", "description": "When the model was created, as an RFC3339 datetime string.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Lock type.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:AiDocument/ModelMetric:ModelMetric": { "properties": { "datasetSummaries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ModelMetricDatasetSummary:ModelMetricDatasetSummary" }, "description": "Summary of count of samples used during model training.\n" }, "labelMetricsReports": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ModelMetricLabelMetricsReport:ModelMetricLabelMetricsReport" }, "description": "List of metrics entries per label.\n" }, "modelType": { "type": "string", "description": "The type of the Document model.\n" }, "overallMetricsReports": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ModelMetricOverallMetricsReport:ModelMetricOverallMetricsReport" }, "description": "Overall Metrics report for Document Classification Model.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "datasetSummaries", "labelMetricsReports", "modelType", "overallMetricsReports" ] } } }, "oci:AiDocument/ModelMetricDatasetSummary:ModelMetricDatasetSummary": { "properties": { "testSampleCount": { "type": "integer", "description": "Number of samples used for testing the model.\n" }, "trainingSampleCount": { "type": "integer", "description": "Number of samples used for training the model.\n" }, "validationSampleCount": { "type": "integer", "description": "Number of samples used for validating the model.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "testSampleCount", "trainingSampleCount", "validationSampleCount" ] } } }, "oci:AiDocument/ModelMetricLabelMetricsReport:ModelMetricLabelMetricsReport": { "properties": { "confidenceEntries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ModelMetricLabelMetricsReportConfidenceEntry:ModelMetricLabelMetricsReportConfidenceEntry" }, "description": "List of document classification confidence report.\n" }, "documentCount": { "type": "integer", "description": "Total test documents in the label.\n" }, "label": { "type": "string", "description": "Label name\n" }, "meanAveragePrecision": { "type": "number", "description": "Mean average precision under different thresholds\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "confidenceEntries", "documentCount", "label", "meanAveragePrecision" ] } } }, "oci:AiDocument/ModelMetricLabelMetricsReportConfidenceEntry:ModelMetricLabelMetricsReportConfidenceEntry": { "properties": { "accuracy": { "type": "number", "description": "accuracy under the threshold\n" }, "f1score": { "type": "number", "description": "f1Score under the threshold\n" }, "precision": { "type": "number", "description": "Precision under the threshold\n" }, "recall": { "type": "number", "description": "Recall under the threshold\n" }, "threshold": { "type": "number", "description": "Threshold used to calculate precision and recall.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accuracy", "f1score", "precision", "recall", "threshold" ] } } }, "oci:AiDocument/ModelMetricOverallMetricsReport:ModelMetricOverallMetricsReport": { "properties": { "confidenceEntries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ModelMetricOverallMetricsReportConfidenceEntry:ModelMetricOverallMetricsReportConfidenceEntry" }, "description": "List of document classification confidence report.\n" }, "documentCount": { "type": "integer", "description": "Total test documents in the label.\n" }, "meanAveragePrecision": { "type": "number", "description": "Mean average precision under different thresholds\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "confidenceEntries", "documentCount", "meanAveragePrecision" ] } } }, "oci:AiDocument/ModelMetricOverallMetricsReportConfidenceEntry:ModelMetricOverallMetricsReportConfidenceEntry": { "properties": { "accuracy": { "type": "number", "description": "accuracy under the threshold\n" }, "f1score": { "type": "number", "description": "f1Score under the threshold\n" }, "precision": { "type": "number", "description": "Precision under the threshold\n" }, "recall": { "type": "number", "description": "Recall under the threshold\n" }, "threshold": { "type": "number", "description": "Threshold used to calculate precision and recall.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accuracy", "f1score", "precision", "recall", "threshold" ] } } }, "oci:AiDocument/ModelModelSubType:ModelModelSubType": { "properties": { "modelSubType": { "type": "string", "description": "The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are:\n* `RECEIPT`\n* `INVOICE`\n* `PASSPORT`\n* `DRIVER_LICENSE`\n* `HEALTH_INSURANCE_ID`\n", "willReplaceOnChanges": true }, "modelType": { "type": "string", "description": "Sub type model based on the model type. The allowed values are:\n* `PRE_TRAINED_KEY_VALUE_EXTRACTION`\n* `PRE_TRAINED_DOCUMENT_ELEMENTS_EXTRACTION`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "modelSubType", "modelType" ] }, "oci:AiDocument/ModelTestingDataset:ModelTestingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The object name of the input data file.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "datasetId", "datasetType", "namespace", "object" ] } } }, "oci:AiDocument/ModelTrainingDataset:ModelTrainingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The object name of the input data file.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "datasetId", "datasetType", "namespace", "object" ] } } }, "oci:AiDocument/ModelValidationDataset:ModelValidationDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The object name of the input data file.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "datasetId", "datasetType", "namespace", "object" ] } } }, "oci:AiDocument/ProcessorJobInputLocation:ProcessorJobInputLocation": { "properties": { "data": { "type": "string", "description": "Raw document data with Base64 encoding.\n", "willReplaceOnChanges": true }, "objectLocations": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ProcessorJobInputLocationObjectLocation:ProcessorJobInputLocationObjectLocation" }, "description": "The list of ObjectLocations.\n", "willReplaceOnChanges": true }, "pageRanges": { "type": "array", "items": { "type": "string" }, "description": "The page ranges to be analysed.\n", "willReplaceOnChanges": true }, "sourceType": { "type": "string", "description": "The type of input location. The allowed values are:\n* `OBJECT_STORAGE_LOCATIONS`: A list of object locations in Object Storage.\n* `INLINE_DOCUMENT_CONTENT`: The content of an inline document.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "data", "objectLocations", "pageRanges", "sourceType" ] } } }, "oci:AiDocument/ProcessorJobInputLocationObjectLocation:ProcessorJobInputLocationObjectLocation": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket name.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The Object Storage namespace name.\n", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The Object Storage object name.\n", "willReplaceOnChanges": true }, "pageRanges": { "type": "array", "items": { "type": "string" }, "description": "The page ranges to be analysed.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucket", "namespace", "object", "pageRanges" ] } } }, "oci:AiDocument/ProcessorJobOutputLocation:ProcessorJobOutputLocation": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket name.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The Object Storage namespace.\n", "willReplaceOnChanges": true }, "prefix": { "type": "string", "description": "The Object Storage folder name.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "namespace", "prefix" ] }, "oci:AiDocument/ProcessorJobProcessorConfig:ProcessorJobProcessorConfig": { "properties": { "documentType": { "type": "string", "description": "The document type.\n", "willReplaceOnChanges": true }, "features": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ProcessorJobProcessorConfigFeature:ProcessorJobProcessorConfigFeature" }, "description": "The types of document analysis requested.\n", "willReplaceOnChanges": true }, "isZipOutputEnabled": { "type": "boolean", "description": "Whether or not to generate a ZIP file containing the results.\n", "willReplaceOnChanges": true }, "language": { "type": "string", "description": "The document language, abbreviated according to the BCP 47 Language-Tag syntax.\n", "willReplaceOnChanges": true }, "modelId": { "type": "string", "description": "Unique identifier custom model OCID that should be used for inference.\n", "willReplaceOnChanges": true }, "normalizationFields": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ProcessorJobProcessorConfigNormalizationField:ProcessorJobProcessorConfigNormalizationField" }, "description": "A string-to-object map where the key is the normalization field and the object contains information about the field.\n" }, "processorType": { "type": "string", "description": "The type of the processor.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "features", "processorType" ], "language": { "nodejs": { "requiredOutputs": [ "documentType", "features", "isZipOutputEnabled", "language", "modelId", "processorType" ] } } }, "oci:AiDocument/ProcessorJobProcessorConfigFeature:ProcessorJobProcessorConfigFeature": { "properties": { "featureType": { "type": "string", "description": "The type of document analysis requested. The allowed values are:\n* `LANGUAGE_CLASSIFICATION`: Detect the language.\n* `TEXT_EXTRACTION`: Recognize text.\n* `TABLE_EXTRACTION`: Detect and extract data in tables.\n* `KEY_VALUE_EXTRACTION`: Extract form fields.\n* `DOCUMENT_CLASSIFICATION`: Identify the type of document.\n* `DOCUMENT_ELEMENTS_EXTRACTION`: Extract information from bar code\n", "willReplaceOnChanges": true }, "generateSearchablePdf": { "type": "boolean", "description": "Whether or not to generate a searchable PDF file.\n", "willReplaceOnChanges": true }, "maxResults": { "type": "integer", "description": "The maximum number of results to return.\n", "willReplaceOnChanges": true }, "modelId": { "type": "string", "description": "Unique identifier custom model OCID that should be used for inference.\n", "willReplaceOnChanges": true }, "selectionMarkDetection": { "type": "boolean", "description": "Whether checkbox detection feature is enabled or disabled.\n", "willReplaceOnChanges": true }, "tenancyId": { "type": "string", "description": "The custom model tenancy ID when modelId represents aliasName.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "featureType" ], "language": { "nodejs": { "requiredOutputs": [ "featureType", "generateSearchablePdf", "maxResults", "modelId", "selectionMarkDetection", "tenancyId" ] } } }, "oci:AiDocument/ProcessorJobProcessorConfigNormalizationField:ProcessorJobProcessorConfigNormalizationField": { "properties": { "maps": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/ProcessorJobProcessorConfigNormalizationFieldMap:ProcessorJobProcessorConfigNormalizationFieldMap" }, "description": "A wrapped map.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maps" ] } } }, "oci:AiDocument/ProcessorJobProcessorConfigNormalizationFieldMap:ProcessorJobProcessorConfigNormalizationFieldMap": { "properties": { "normalizationType": { "type": "string", "description": "A string mapping to the normalization type.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "normalizationType" ] } } }, "oci:AiDocument/ProjectLock:ProjectLock": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The compartment identifier.\n" }, "message": { "type": "string", "description": "A message added by the lock creator. The message typically gives an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.\n" }, "timeCreated": { "type": "string", "description": "When the project was created, as an RFC3339 datetime string.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Lock type.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:AiDocument/getModelComponentModel:getModelComponentModel": { "properties": { "modelId": { "type": "string", "description": "A unique model identifier.\n" } }, "type": "object", "required": [ "modelId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelLock:getModelLock": { "properties": { "compartmentId": { "type": "string", "description": "The lock compartment ID.\n" }, "message": { "type": "string", "description": "A message added by the lock creator. The message typically gives an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.\n" }, "timeCreated": { "type": "string", "description": "When the model was created, as an RFC3339 datetime string.\n" }, "type": { "type": "string", "description": "Lock type.\n" } }, "type": "object", "required": [ "compartmentId", "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelMetric:getModelMetric": { "properties": { "datasetSummaries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelMetricDatasetSummary:getModelMetricDatasetSummary" }, "description": "Summary of count of samples used during model training.\n" }, "labelMetricsReports": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelMetricLabelMetricsReport:getModelMetricLabelMetricsReport" }, "description": "List of metrics entries per label.\n" }, "modelType": { "type": "string", "description": "The type of the Document model.\n" }, "overallMetricsReports": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelMetricOverallMetricsReport:getModelMetricOverallMetricsReport" }, "description": "Overall Metrics report for Document Classification Model.\n" } }, "type": "object", "required": [ "datasetSummaries", "labelMetricsReports", "modelType", "overallMetricsReports" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelMetricDatasetSummary:getModelMetricDatasetSummary": { "properties": { "testSampleCount": { "type": "integer", "description": "Number of samples used for testing the model.\n" }, "trainingSampleCount": { "type": "integer", "description": "Number of samples used for training the model.\n" }, "validationSampleCount": { "type": "integer", "description": "Number of samples used for validating the model.\n" } }, "type": "object", "required": [ "testSampleCount", "trainingSampleCount", "validationSampleCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelMetricLabelMetricsReport:getModelMetricLabelMetricsReport": { "properties": { "confidenceEntries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelMetricLabelMetricsReportConfidenceEntry:getModelMetricLabelMetricsReportConfidenceEntry" }, "description": "List of document classification confidence report.\n" }, "documentCount": { "type": "integer", "description": "Total test documents in the label.\n" }, "label": { "type": "string", "description": "Label name\n" }, "meanAveragePrecision": { "type": "number", "description": "Mean average precision under different thresholds\n" } }, "type": "object", "required": [ "confidenceEntries", "documentCount", "label", "meanAveragePrecision" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelMetricLabelMetricsReportConfidenceEntry:getModelMetricLabelMetricsReportConfidenceEntry": { "properties": { "accuracy": { "type": "number", "description": "accuracy under the threshold\n" }, "f1score": { "type": "number", "description": "f1Score under the threshold\n" }, "precision": { "type": "number", "description": "Precision under the threshold\n" }, "recall": { "type": "number", "description": "Recall under the threshold\n" }, "threshold": { "type": "number", "description": "Threshold used to calculate precision and recall.\n" } }, "type": "object", "required": [ "accuracy", "f1score", "precision", "recall", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelMetricOverallMetricsReport:getModelMetricOverallMetricsReport": { "properties": { "confidenceEntries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelMetricOverallMetricsReportConfidenceEntry:getModelMetricOverallMetricsReportConfidenceEntry" }, "description": "List of document classification confidence report.\n" }, "documentCount": { "type": "integer", "description": "Total test documents in the label.\n" }, "meanAveragePrecision": { "type": "number", "description": "Mean average precision under different thresholds\n" } }, "type": "object", "required": [ "confidenceEntries", "documentCount", "meanAveragePrecision" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelMetricOverallMetricsReportConfidenceEntry:getModelMetricOverallMetricsReportConfidenceEntry": { "properties": { "accuracy": { "type": "number", "description": "accuracy under the threshold\n" }, "f1score": { "type": "number", "description": "f1Score under the threshold\n" }, "precision": { "type": "number", "description": "Precision under the threshold\n" }, "recall": { "type": "number", "description": "Recall under the threshold\n" }, "threshold": { "type": "number", "description": "Threshold used to calculate precision and recall.\n" } }, "type": "object", "required": [ "accuracy", "f1score", "precision", "recall", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelModelSubType:getModelModelSubType": { "properties": { "modelSubType": { "type": "string", "description": "The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are:\n* `RECEIPT`\n* `INVOICE`\n* `PASSPORT`\n* `DRIVER_LICENSE`\n* `HEALTH_INSURANCE_ID`\n" }, "modelType": { "type": "string", "description": "The type of the Document model.\n" } }, "type": "object", "required": [ "modelSubType", "modelType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelTestingDataset:getModelTestingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespace", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelTrainingDataset:getModelTrainingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespace", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelValidationDataset:getModelValidationDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespace", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsFilter:getModelsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiDocument/getModelsModelCollection:getModelsModelCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItem:getModelsModelCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItem:getModelsModelCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "componentModels": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemComponentModel:getModelsModelCollectionItemComponentModel" }, "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) collection of active custom Key Value models that need to be composed.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "description": { "type": "string", "description": "An optional description of the model.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the model with the given identifier.\n" }, "inferenceUnits": { "type": "integer", "description": "Number of replicas required for this model.\n" }, "isComposedModel": { "type": "boolean", "description": "Set to true when the model is created by using multiple key value extraction models.\n" }, "isQuickMode": { "type": "boolean", "description": "Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "The collection of labels used to train the custom model.\n" }, "language": { "type": "string", "description": "The document language for model training, abbreviated according to the BCP 47 syntax.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail, that can provide actionable information if training failed.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemLock:getModelsModelCollectionItemLock" }, "description": "Locks associated with this resource.\n" }, "maxTrainingTimeInHours": { "type": "number", "description": "The maximum model training time in hours, expressed as a decimal fraction.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemMetric:getModelsModelCollectionItemMetric" }, "description": "Trained Model Metrics.\n" }, "modelId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed.\n" }, "modelSubTypes": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemModelSubType:getModelsModelCollectionItemModelSubType" }, "description": "The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are:\n* `RECEIPT`\n* `INVOICE`\n* `PASSPORT`\n* `DRIVER_LICENSE`\n* `HEALTH_INSURANCE_ID`\n" }, "modelType": { "type": "string", "description": "The type of the Document model.\n" }, "modelVersion": { "type": "string", "description": "The version of the model.\n" }, "projectId": { "type": "string", "description": "The ID of the project for which to list the objects.\n" }, "state": { "type": "string", "description": "The filter to match models with the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "tenancyId": { "type": "string", "description": "The tenancy id of the model.\n" }, "testingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemTestingDataset:getModelsModelCollectionItemTestingDataset" }, "description": "The base entity which is the input for creating and training a model.\n" }, "timeCreated": { "type": "string", "description": "When the model was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the model was updated, as an RFC3339 datetime string.\n" }, "trainedTimeInHours": { "type": "number", "description": "The total hours actually used for model training.\n" }, "trainingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemTrainingDataset:getModelsModelCollectionItemTrainingDataset" }, "description": "The base entity which is the input for creating and training a model.\n" }, "validationDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemValidationDataset:getModelsModelCollectionItemValidationDataset" }, "description": "The base entity which is the input for creating and training a model.\n" } }, "type": "object", "required": [ "compartmentId", "componentModels", "definedTags", "description", "displayName", "freeformTags", "id", "inferenceUnits", "isComposedModel", "isQuickMode", "labels", "language", "lifecycleDetails", "locks", "maxTrainingTimeInHours", "metrics", "modelId", "modelSubTypes", "modelType", "modelVersion", "projectId", "state", "systemTags", "tenancyId", "testingDatasets", "timeCreated", "timeUpdated", "trainedTimeInHours", "trainingDatasets", "validationDatasets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemComponentModel:getModelsModelCollectionItemComponentModel": { "properties": { "modelId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of active custom Key Value model that need to be composed.\n" } }, "type": "object", "required": [ "modelId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemLock:getModelsModelCollectionItemLock": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "message": { "type": "string", "description": "A message added by the lock creator. The message typically gives an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.\n" }, "timeCreated": { "type": "string", "description": "When the model was created, as an RFC3339 datetime string.\n" }, "type": { "type": "string", "description": "Lock type.\n" } }, "type": "object", "required": [ "compartmentId", "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemMetric:getModelsModelCollectionItemMetric": { "properties": { "datasetSummaries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemMetricDatasetSummary:getModelsModelCollectionItemMetricDatasetSummary" }, "description": "Summary of count of samples used during model training.\n" }, "labelMetricsReports": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemMetricLabelMetricsReport:getModelsModelCollectionItemMetricLabelMetricsReport" }, "description": "List of metrics entries per label.\n" }, "modelType": { "type": "string", "description": "The type of the Document model.\n" }, "overallMetricsReports": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemMetricOverallMetricsReport:getModelsModelCollectionItemMetricOverallMetricsReport" }, "description": "Overall Metrics report for Document Classification Model.\n" } }, "type": "object", "required": [ "datasetSummaries", "labelMetricsReports", "modelType", "overallMetricsReports" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemMetricDatasetSummary:getModelsModelCollectionItemMetricDatasetSummary": { "properties": { "testSampleCount": { "type": "integer", "description": "Number of samples used for testing the model.\n" }, "trainingSampleCount": { "type": "integer", "description": "Number of samples used for training the model.\n" }, "validationSampleCount": { "type": "integer", "description": "Number of samples used for validating the model.\n" } }, "type": "object", "required": [ "testSampleCount", "trainingSampleCount", "validationSampleCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemMetricLabelMetricsReport:getModelsModelCollectionItemMetricLabelMetricsReport": { "properties": { "confidenceEntries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemMetricLabelMetricsReportConfidenceEntry:getModelsModelCollectionItemMetricLabelMetricsReportConfidenceEntry" }, "description": "List of document classification confidence report.\n" }, "documentCount": { "type": "integer", "description": "Total test documents in the label.\n" }, "label": { "type": "string", "description": "Label name\n" }, "meanAveragePrecision": { "type": "number", "description": "Mean average precision under different thresholds\n" } }, "type": "object", "required": [ "confidenceEntries", "documentCount", "label", "meanAveragePrecision" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemMetricLabelMetricsReportConfidenceEntry:getModelsModelCollectionItemMetricLabelMetricsReportConfidenceEntry": { "properties": { "accuracy": { "type": "number", "description": "accuracy under the threshold\n" }, "f1score": { "type": "number", "description": "f1Score under the threshold\n" }, "precision": { "type": "number", "description": "Precision under the threshold\n" }, "recall": { "type": "number", "description": "Recall under the threshold\n" }, "threshold": { "type": "number", "description": "Threshold used to calculate precision and recall.\n" } }, "type": "object", "required": [ "accuracy", "f1score", "precision", "recall", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemMetricOverallMetricsReport:getModelsModelCollectionItemMetricOverallMetricsReport": { "properties": { "confidenceEntries": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getModelsModelCollectionItemMetricOverallMetricsReportConfidenceEntry:getModelsModelCollectionItemMetricOverallMetricsReportConfidenceEntry" }, "description": "List of document classification confidence report.\n" }, "documentCount": { "type": "integer", "description": "Total test documents in the label.\n" }, "meanAveragePrecision": { "type": "number", "description": "Mean average precision under different thresholds\n" } }, "type": "object", "required": [ "confidenceEntries", "documentCount", "meanAveragePrecision" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemMetricOverallMetricsReportConfidenceEntry:getModelsModelCollectionItemMetricOverallMetricsReportConfidenceEntry": { "properties": { "accuracy": { "type": "number", "description": "accuracy under the threshold\n" }, "f1score": { "type": "number", "description": "f1Score under the threshold\n" }, "precision": { "type": "number", "description": "Precision under the threshold\n" }, "recall": { "type": "number", "description": "Recall under the threshold\n" }, "threshold": { "type": "number", "description": "Threshold used to calculate precision and recall.\n" } }, "type": "object", "required": [ "accuracy", "f1score", "precision", "recall", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemModelSubType:getModelsModelCollectionItemModelSubType": { "properties": { "modelSubType": { "type": "string", "description": "The model sub type for PRE_TRAINED_KEY_VALUE_EXTRACTION The allowed values are:\n* `RECEIPT`\n* `INVOICE`\n* `PASSPORT`\n* `DRIVER_LICENSE`\n* `HEALTH_INSURANCE_ID`\n" }, "modelType": { "type": "string", "description": "The type of the Document model.\n" } }, "type": "object", "required": [ "modelSubType", "modelType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemTestingDataset:getModelsModelCollectionItemTestingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespace", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemTrainingDataset:getModelsModelCollectionItemTrainingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespace", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getModelsModelCollectionItemValidationDataset:getModelsModelCollectionItemValidationDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespace": { "type": "string", "description": "The namespace name of the Object Storage bucket that contains the input data file.\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespace", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobInputLocation:getProcessorJobInputLocation": { "properties": { "data": { "type": "string", "description": "Raw document data with Base64 encoding.\n" }, "objectLocations": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getProcessorJobInputLocationObjectLocation:getProcessorJobInputLocationObjectLocation" }, "description": "The list of ObjectLocations.\n" }, "pageRanges": { "type": "array", "items": { "type": "string" }, "description": "The page ranges to be analysed.\n" }, "sourceType": { "type": "string", "description": "The type of input location. The allowed values are:\n* `OBJECT_STORAGE_LOCATIONS`: A list of object locations in Object Storage.\n* `INLINE_DOCUMENT_CONTENT`: The content of an inline document.\n" } }, "type": "object", "required": [ "data", "objectLocations", "pageRanges", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobInputLocationObjectLocation:getProcessorJobInputLocationObjectLocation": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "The Object Storage namespace.\n" }, "object": { "type": "string", "description": "The Object Storage object name.\n" }, "pageRanges": { "type": "array", "items": { "type": "string" }, "description": "The page ranges to be analysed.\n" } }, "type": "object", "required": [ "bucket", "namespace", "object", "pageRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobOutputLocation:getProcessorJobOutputLocation": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "The Object Storage namespace.\n" }, "prefix": { "type": "string", "description": "The Object Storage folder name.\n" } }, "type": "object", "required": [ "bucket", "namespace", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobProcessorConfig:getProcessorJobProcessorConfig": { "properties": { "documentType": { "type": "string", "description": "The document type.\n" }, "features": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getProcessorJobProcessorConfigFeature:getProcessorJobProcessorConfigFeature" }, "description": "The types of document analysis requested.\n" }, "isZipOutputEnabled": { "type": "boolean", "description": "Whether or not to generate a ZIP file containing the results.\n" }, "language": { "type": "string", "description": "The document language, abbreviated according to the BCP 47 Language-Tag syntax.\n" }, "modelId": { "type": "string", "description": "Unique identifier custom model OCID that should be used for inference.\n" }, "normalizationFields": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getProcessorJobProcessorConfigNormalizationField:getProcessorJobProcessorConfigNormalizationField" }, "description": "A string-to-object map where the key is the normalization field and the object contains information about the field.\n" }, "processorType": { "type": "string", "description": "The type of the processor.\n" } }, "type": "object", "required": [ "documentType", "features", "isZipOutputEnabled", "language", "modelId", "normalizationFields", "processorType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobProcessorConfigFeature:getProcessorJobProcessorConfigFeature": { "properties": { "featureType": { "type": "string", "description": "The type of document analysis requested. The allowed values are:\n* `LANGUAGE_CLASSIFICATION`: Detect the language.\n* `TEXT_EXTRACTION`: Recognize text.\n* `TABLE_EXTRACTION`: Detect and extract data in tables.\n* `KEY_VALUE_EXTRACTION`: Extract form fields.\n* `DOCUMENT_CLASSIFICATION`: Identify the type of document.\n* `DOCUMENT_ELEMENTS_EXTRACTION`: Extract information from bar code\n" }, "generateSearchablePdf": { "type": "boolean", "description": "Whether or not to generate a searchable PDF file.\n" }, "maxResults": { "type": "integer", "description": "The maximum number of results to return.\n" }, "modelId": { "type": "string", "description": "Unique identifier custom model OCID that should be used for inference.\n" }, "selectionMarkDetection": { "type": "boolean", "description": "Whether checkbox detection feature is enabled or disabled.\n" }, "tenancyId": { "type": "string", "description": "The custom model tenancy ID when modelId represents aliasName.\n" } }, "type": "object", "required": [ "featureType", "generateSearchablePdf", "maxResults", "modelId", "selectionMarkDetection", "tenancyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobProcessorConfigNormalizationField:getProcessorJobProcessorConfigNormalizationField": { "properties": { "maps": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getProcessorJobProcessorConfigNormalizationFieldMap:getProcessorJobProcessorConfigNormalizationFieldMap" }, "description": "A wrapped map.\n" } }, "type": "object", "required": [ "maps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProcessorJobProcessorConfigNormalizationFieldMap:getProcessorJobProcessorConfigNormalizationFieldMap": { "properties": { "normalizationType": { "type": "string", "description": "A string mapping to the normalization type.\n" } }, "type": "object", "required": [ "normalizationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProjectLock:getProjectLock": { "properties": { "compartmentId": { "type": "string", "description": "The lock compartment ID.\n" }, "message": { "type": "string", "description": "A message added by the lock creator. The message typically gives an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.\n" }, "timeCreated": { "type": "string", "description": "When the project was created, as an RFC3339 datetime string.\n" }, "type": { "type": "string", "description": "Lock type.\n" } }, "type": "object", "required": [ "compartmentId", "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProjectsFilter:getProjectsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiDocument/getProjectsProjectCollection:getProjectsProjectCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getProjectsProjectCollectionItem:getProjectsProjectCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProjectsProjectCollectionItem:getProjectsProjectCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "description": { "type": "string", "description": "An optional description of the project.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the project with the given identifier.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail, that can provide actionable information if creation failed.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:AiDocument/getProjectsProjectCollectionItemLock:getProjectsProjectCollectionItemLock" }, "description": "Locks associated with this resource.\n" }, "state": { "type": "string", "description": "The filter to match projects with the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "timeCreated": { "type": "string", "description": "When the project was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the project was updated, as an RFC3339 datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "locks", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiDocument/getProjectsProjectCollectionItemLock:getProjectsProjectCollectionItemLock": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "message": { "type": "string", "description": "A message added by the lock creator. The message typically gives an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The resource ID that is locking this resource. Indicates that deleting this resource removes the lock.\n" }, "timeCreated": { "type": "string", "description": "When the project was created, as an RFC3339 datetime string.\n" }, "type": { "type": "string", "description": "Lock type.\n" } }, "type": "object", "required": [ "compartmentId", "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/JobInputConfiguration:JobInputConfiguration": { "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "meta data about documents For CSV valid JSON format is {\"CSV\" :{inputColumn: \"reviewDetails\", rowId: \"reviewId\", copyColumnsToOutput: [\"reviewId\" \"userId\"] , delimiter: \",\"} Note: In future if new file types added we will update here in documentation about input file meta data\n", "willReplaceOnChanges": true }, "documentTypes": { "type": "array", "items": { "type": "string" }, "description": "Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "documentTypes" ] } } }, "oci:AiLanguage/JobInputLocation:JobInputLocation": { "properties": { "bucket": { "type": "string", "description": "Object Storage bucket name.\n", "willReplaceOnChanges": true }, "locationType": { "type": "string", "description": "locationType\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "Object Storage namespace name.\n", "willReplaceOnChanges": true }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "List of objects to be processed\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "locationType", "namespace" ] }, "oci:AiLanguage/JobModelMetadataDetail:JobModelMetadataDetail": { "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "model configuration details For PII : \u003c ENTITY_TYPE , ConfigurationDetails\u003e ex.\"ORACLE\":{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"\u0026\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true } For language translation : { \"targetLanguageCodes\" : ConfigurationDetails}\n", "willReplaceOnChanges": true }, "endpointId": { "type": "string", "description": "Unique identifier endpoint OCID that should be used for inference\n", "willReplaceOnChanges": true }, "languageCode": { "type": "string", "description": "Language code supported\n* auto : Automatically detect language\n* ar : Arabic\n* pt-BR : Brazilian Portuguese\n* cs : Czech\n* da : Danish\n* nl : Dutch\n* en : English\n* fi : Finnish\n* fr : French\n* fr-CA : Canadian French\n* de : German\n* it : Italian\n* ja : Japanese\n* ko : Korean\n* no : Norwegian\n* pl : Polish\n* ro : Romanian\n* zh-CN : Simplified Chinese\n* es : Spanish\n* sv : Swedish\n* zh-TW : Traditional Chinese\n* tr : Turkish\n* el : Greek\n* he : Hebrew\n", "willReplaceOnChanges": true }, "modelId": { "type": "string", "description": "Unique identifier model OCID that should be used for inference\n", "willReplaceOnChanges": true }, "modelType": { "type": "string", "description": "model type to used for inference allowed values are\n* LANGUAGE_SENTIMENT_ANALYSIS\n* LANGUAGE_DETECTION\n* TEXT_CLASSIFICATION\n* NAMED_ENTITY_RECOGNITION\n* KEY_PHRASE_EXTRACTION\n* LANGUAGE_PII_ENTITIES\n* LANGUAGE_TRANSLATION\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "endpointId", "languageCode", "modelId", "modelType" ] } } }, "oci:AiLanguage/JobOutputLocation:JobOutputLocation": { "properties": { "bucket": { "type": "string", "description": "Object Storage bucket name.\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "Object Storage namespace name.\n", "willReplaceOnChanges": true }, "prefix": { "type": "string", "description": "The prefix (directory) in an Object Storage bucket.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "namespace" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "namespace", "prefix" ] } } }, "oci:AiLanguage/ModelEvaluationResult:ModelEvaluationResult": { "properties": { "classMetrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/ModelEvaluationResultClassMetric:ModelEvaluationResultClassMetric" }, "description": "List of text classification metrics\n" }, "confusionMatrix": { "type": "string", "description": "class level confusion matrix\n" }, "entityMetrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/ModelEvaluationResultEntityMetric:ModelEvaluationResultEntityMetric" }, "description": "List of entity metrics\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "labels\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/ModelEvaluationResultMetric:ModelEvaluationResultMetric" }, "description": "Model level named entity recognition metrics\n" }, "modelType": { "type": "string", "description": "Model type\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "classMetrics", "confusionMatrix", "entityMetrics", "labels", "metrics", "modelType" ] } } }, "oci:AiLanguage/ModelEvaluationResultClassMetric:ModelEvaluationResultClassMetric": { "properties": { "f1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "label": { "type": "string", "description": "Entity label\n" }, "precision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "recall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "support": { "type": "number", "description": "number of samples in the test set\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "f1", "label", "precision", "recall", "support" ] } } }, "oci:AiLanguage/ModelEvaluationResultEntityMetric:ModelEvaluationResultEntityMetric": { "properties": { "f1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "label": { "type": "string", "description": "Entity label\n" }, "precision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "recall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "f1", "label", "precision", "recall" ] } } }, "oci:AiLanguage/ModelEvaluationResultMetric:ModelEvaluationResultMetric": { "properties": { "accuracy": { "type": "number", "description": "The fraction of the labels that were correctly recognised .\n" }, "macroF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "macroPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "macroRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "microF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "microPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "microRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "weightedF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "weightedPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "weightedRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accuracy", "macroF1", "macroPrecision", "macroRecall", "microF1", "microPrecision", "microRecall", "weightedF1", "weightedPrecision", "weightedRecall" ] } } }, "oci:AiLanguage/ModelModelDetails:ModelModelDetails": { "properties": { "classificationMode": { "$ref": "#/types/oci:AiLanguage/ModelModelDetailsClassificationMode:ModelModelDetailsClassificationMode", "description": "possible text classification modes\n", "willReplaceOnChanges": true }, "languageCode": { "type": "string", "description": "supported language default value is en\n", "willReplaceOnChanges": true }, "modelType": { "type": "string", "description": "Model type\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "Optional pre trained model version. if nothing specified latest pre trained model will be used. Supported versions can be found at /modelTypes/{modelType}\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "modelType" ], "language": { "nodejs": { "requiredOutputs": [ "classificationMode", "languageCode", "modelType", "version" ] } } }, "oci:AiLanguage/ModelModelDetailsClassificationMode:ModelModelDetailsClassificationMode": { "properties": { "classificationMode": { "type": "string", "description": "classification Modes\n", "willReplaceOnChanges": true }, "version": { "type": "string", "description": "Optional if nothing specified latest base model will be used for training. Supported versions can be found at /modelTypes/{modelType}\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "classificationMode" ], "language": { "nodejs": { "requiredOutputs": [ "classificationMode", "version" ] } } }, "oci:AiLanguage/ModelTestStrategy:ModelTestStrategy": { "properties": { "strategyType": { "type": "string", "description": "This information will define the test strategy different datasets for test and validation(optional) dataset.\n", "willReplaceOnChanges": true }, "testingDataset": { "$ref": "#/types/oci:AiLanguage/ModelTestStrategyTestingDataset:ModelTestStrategyTestingDataset", "description": "Possible data set type\n", "willReplaceOnChanges": true }, "validationDataset": { "$ref": "#/types/oci:AiLanguage/ModelTestStrategyValidationDataset:ModelTestStrategyValidationDataset", "description": "Possible data set type\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "strategyType", "testingDataset" ], "language": { "nodejs": { "requiredOutputs": [ "strategyType", "testingDataset", "validationDataset" ] } } }, "oci:AiLanguage/ModelTestStrategyTestingDataset:ModelTestStrategyTestingDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "Possible data sets\n", "willReplaceOnChanges": true }, "locationDetails": { "$ref": "#/types/oci:AiLanguage/ModelTestStrategyTestingDatasetLocationDetails:ModelTestStrategyTestingDatasetLocationDetails", "description": "Possible object storage location types\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "datasetId", "datasetType", "locationDetails" ] } } }, "oci:AiLanguage/ModelTestStrategyTestingDatasetLocationDetails:ModelTestStrategyTestingDatasetLocationDetails": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n", "willReplaceOnChanges": true }, "locationType": { "type": "string", "description": "Possible object storage location types\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "Object storage namespace\n", "willReplaceOnChanges": true }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ] }, "oci:AiLanguage/ModelTestStrategyValidationDataset:ModelTestStrategyValidationDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "Possible data sets\n", "willReplaceOnChanges": true }, "locationDetails": { "$ref": "#/types/oci:AiLanguage/ModelTestStrategyValidationDatasetLocationDetails:ModelTestStrategyValidationDatasetLocationDetails", "description": "Possible object storage location types\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "datasetId", "datasetType", "locationDetails" ] } } }, "oci:AiLanguage/ModelTestStrategyValidationDatasetLocationDetails:ModelTestStrategyValidationDatasetLocationDetails": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n", "willReplaceOnChanges": true }, "locationType": { "type": "string", "description": "Possible object storage location types\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "Object storage namespace\n", "willReplaceOnChanges": true }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ] }, "oci:AiLanguage/ModelTrainingDataset:ModelTrainingDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "Possible data sets\n", "willReplaceOnChanges": true }, "locationDetails": { "$ref": "#/types/oci:AiLanguage/ModelTrainingDatasetLocationDetails:ModelTrainingDatasetLocationDetails", "description": "Possible object storage location types\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "datasetId", "datasetType", "locationDetails" ] } } }, "oci:AiLanguage/ModelTrainingDatasetLocationDetails:ModelTrainingDatasetLocationDetails": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n", "willReplaceOnChanges": true }, "locationType": { "type": "string", "description": "Possible object storage location types\n", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "Object storage namespace\n", "willReplaceOnChanges": true }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ] }, "oci:AiLanguage/getEndpointsEndpointCollection:getEndpointsEndpointCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getEndpointsEndpointCollectionItem:getEndpointsEndpointCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getEndpointsEndpointCollectionItem:getEndpointsEndpointCollectionItem": { "properties": { "alias": { "type": "string", "description": "Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A short description of the endpoint.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier endpoint OCID of an endpoint that is immutable on creation.\n" }, "inferenceUnits": { "type": "integer", "description": "Number of replicas required for this endpoint.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.\n" }, "modelId": { "type": "string", "description": "The ID of the trained model for which to list the endpoints.\n" }, "projectId": { "type": "string", "description": "The ID of the project for which to list the objects.\n" }, "state": { "type": "string", "description": "\u003cb\u003eFilter\u003c/b\u003e results by the specified lifecycle state. Must be a valid state for the resource type.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time the the endpoint was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the endpoint was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "alias", "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "inferenceUnits", "lifecycleDetails", "modelId", "projectId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getEndpointsFilter:getEndpointsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiLanguage/getJobInputConfiguration:getJobInputConfiguration": { "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "model configuration details For PII : \u003c ENTITY_TYPE , ConfigurationDetails\u003e ex.\"ORACLE\":{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"\u0026\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true } For language translation : { \"targetLanguageCodes\" : ConfigurationDetails}\n" }, "documentTypes": { "type": "array", "items": { "type": "string" }, "description": "Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list\n" } }, "type": "object", "required": [ "configuration", "documentTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobInputLocation:getJobInputLocation": { "properties": { "bucket": { "type": "string", "description": "Object Storage bucket name.\n" }, "locationType": { "type": "string", "description": "locationType\n" }, "namespace": { "type": "string", "description": "Object Storage namespace name.\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "List of objects to be processed\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobModelMetadataDetail:getJobModelMetadataDetail": { "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "model configuration details For PII : \u003c ENTITY_TYPE , ConfigurationDetails\u003e ex.\"ORACLE\":{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"\u0026\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true } For language translation : { \"targetLanguageCodes\" : ConfigurationDetails}\n" }, "endpointId": { "type": "string", "description": "Unique identifier endpoint OCID that should be used for inference\n" }, "languageCode": { "type": "string", "description": "Language code supported\n* auto : Automatically detect language\n* ar : Arabic\n* pt-BR : Brazilian Portuguese\n* cs : Czech\n* da : Danish\n* nl : Dutch\n* en : English\n* fi : Finnish\n* fr : French\n* fr-CA : Canadian French\n* de : German\n* it : Italian\n* ja : Japanese\n* ko : Korean\n* no : Norwegian\n* pl : Polish\n* ro : Romanian\n* zh-CN : Simplified Chinese\n* es : Spanish\n* sv : Swedish\n* zh-TW : Traditional Chinese\n* tr : Turkish\n* el : Greek\n* he : Hebrew\n" }, "modelId": { "type": "string", "description": "Unique identifier model OCID that should be used for inference\n" }, "modelType": { "type": "string", "description": "model type to used for inference allowed values are\n* LANGUAGE_SENTIMENT_ANALYSIS\n* LANGUAGE_DETECTION\n* TEXT_CLASSIFICATION\n* NAMED_ENTITY_RECOGNITION\n* KEY_PHRASE_EXTRACTION\n* LANGUAGE_PII_ENTITIES\n* LANGUAGE_TRANSLATION\n" } }, "type": "object", "required": [ "configuration", "endpointId", "languageCode", "modelId", "modelType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobOutputLocation:getJobOutputLocation": { "properties": { "bucket": { "type": "string", "description": "Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "Object Storage namespace name.\n" }, "prefix": { "type": "string", "description": "The prefix (directory) in an Object Storage bucket.\n" } }, "type": "object", "required": [ "bucket", "namespace", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobsFilter:getJobsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiLanguage/getJobsJobCollection:getJobsJobCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getJobsJobCollectionItem:getJobsJobCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobsJobCollectionItem:getJobsJobCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "completedDocuments": { "type": "integer", "description": "Number of documents processed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.\n" }, "createdBy": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the job.\n" }, "description": { "type": "string", "description": "A short description of the job.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "failedDocuments": { "type": "integer", "description": "Number of documents failed for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.\n" }, "id": { "type": "string", "description": "Unique identifier(OCID).\n" }, "inputConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getJobsJobCollectionItemInputConfiguration:getJobsJobCollectionItemInputConfiguration" }, "description": "input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types\n" }, "inputLocations": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getJobsJobCollectionItemInputLocation:getJobsJobCollectionItemInputLocation" }, "description": "document location and other meta data about documents For TXT only ObjectStoragePrefixLocation supported For CSV only ObjectStorageFileNameLocation is supported For this release only one file is supported for ObjectStorageFileNameLocation i.e CSV file type\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "modelMetadataDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getJobsJobCollectionItemModelMetadataDetail:getJobsJobCollectionItemModelMetadataDetail" }, "description": "training model details For this release only one model is allowed to be input here. One of the three modelType, ModelId, endpointId should be given other wise error will be thrown from API\n" }, "outputLocations": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getJobsJobCollectionItemOutputLocation:getJobsJobCollectionItemOutputLocation" }, "description": "Object storage output location to write inference results\n" }, "pendingDocuments": { "type": "integer", "description": "Number of documents still to process. For CSV this signifies number of rows and for TXT this signifies number of files.\n" }, "percentComplete": { "type": "integer", "description": "How much progress the operation has made, vs the total amount of work that must be performed.\n" }, "state": { "type": "string", "description": "A filter to return only resources whose lifecycleState matches the given lifecycleState.\n" }, "timeAccepted": { "type": "string", "description": "Job accepted time.\n" }, "timeCompleted": { "type": "string", "description": "Job finished time.\n" }, "timeStarted": { "type": "string", "description": "Job started time.\n" }, "totalDocuments": { "type": "integer", "description": "Total number of documents given as input for prediction. For CSV this signifies number of rows and for TXT this signifies number of files.\n" }, "ttlInDays": { "type": "integer", "description": "Time to live duration in days for Job. Job will be available till max 90 days.\n" }, "warningsCount": { "type": "integer", "description": "warnings count\n" } }, "type": "object", "required": [ "compartmentId", "completedDocuments", "createdBy", "description", "displayName", "failedDocuments", "id", "inputConfigurations", "inputLocations", "lifecycleDetails", "modelMetadataDetails", "outputLocations", "pendingDocuments", "percentComplete", "state", "timeAccepted", "timeCompleted", "timeStarted", "totalDocuments", "ttlInDays", "warningsCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobsJobCollectionItemInputConfiguration:getJobsJobCollectionItemInputConfiguration": { "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "model configuration details For PII : \u003c ENTITY_TYPE , ConfigurationDetails\u003e ex.\"ORACLE\":{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"\u0026\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true } For language translation : { \"targetLanguageCodes\" : ConfigurationDetails}\n" }, "documentTypes": { "type": "array", "items": { "type": "string" }, "description": "Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list\n" } }, "type": "object", "required": [ "configuration", "documentTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobsJobCollectionItemInputLocation:getJobsJobCollectionItemInputLocation": { "properties": { "bucket": { "type": "string", "description": "Object Storage bucket name.\n" }, "locationType": { "type": "string", "description": "locationType\n" }, "namespace": { "type": "string", "description": "Object Storage namespace name.\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "List of objects to be processed\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobsJobCollectionItemModelMetadataDetail:getJobsJobCollectionItemModelMetadataDetail": { "properties": { "configuration": { "type": "object", "additionalProperties": { "type": "object", "additionalProperties": { "type": "string" } }, "description": "model configuration details For PII : \u003c ENTITY_TYPE , ConfigurationDetails\u003e ex.\"ORACLE\":{ \"mode\" : \"MASK\",\"maskingCharacter\" : \"\u0026\",\"leaveCharactersUnmasked\": 3,\"isUnmaskedFromEnd\" : true } For language translation : { \"targetLanguageCodes\" : ConfigurationDetails}\n" }, "endpointId": { "type": "string", "description": "Unique identifier endpoint OCID that should be used for inference\n" }, "languageCode": { "type": "string", "description": "Language code supported\n* auto : Automatically detect language\n* ar : Arabic\n* pt-BR : Brazilian Portuguese\n* cs : Czech\n* da : Danish\n* nl : Dutch\n* en : English\n* fi : Finnish\n* fr : French\n* fr-CA : Canadian French\n* de : German\n* it : Italian\n* ja : Japanese\n* ko : Korean\n* no : Norwegian\n* pl : Polish\n* ro : Romanian\n* zh-CN : Simplified Chinese\n* es : Spanish\n* sv : Swedish\n* zh-TW : Traditional Chinese\n* tr : Turkish\n* el : Greek\n* he : Hebrew\n" }, "modelId": { "type": "string", "description": "Unique identifier model OCID that should be used for inference\n" }, "modelType": { "type": "string", "description": "model type to used for inference allowed values are\n* LANGUAGE_SENTIMENT_ANALYSIS\n* LANGUAGE_DETECTION\n* TEXT_CLASSIFICATION\n* NAMED_ENTITY_RECOGNITION\n* KEY_PHRASE_EXTRACTION\n* LANGUAGE_PII_ENTITIES\n* LANGUAGE_TRANSLATION\n" } }, "type": "object", "required": [ "configuration", "endpointId", "languageCode", "modelId", "modelType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getJobsJobCollectionItemOutputLocation:getJobsJobCollectionItemOutputLocation": { "properties": { "bucket": { "type": "string", "description": "Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "Object Storage namespace name.\n" }, "prefix": { "type": "string", "description": "The prefix (directory) in an Object Storage bucket.\n" } }, "type": "object", "required": [ "bucket", "namespace", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResult:getModelEvaluationResult": { "properties": { "classMetrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelEvaluationResultClassMetric:getModelEvaluationResultClassMetric" }, "description": "List of text classification metrics\n" }, "confusionMatrix": { "type": "string", "description": "class level confusion matrix\n" }, "entityMetrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelEvaluationResultEntityMetric:getModelEvaluationResultEntityMetric" }, "description": "List of entity metrics\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "labels\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelEvaluationResultMetric:getModelEvaluationResultMetric" }, "description": "Model level named entity recognition metrics\n" }, "modelType": { "type": "string", "description": "Model type\n" } }, "type": "object", "required": [ "classMetrics", "confusionMatrix", "entityMetrics", "labels", "metrics", "modelType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultClassMetric:getModelEvaluationResultClassMetric": { "properties": { "f1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "label": { "type": "string", "description": "Entity label\n" }, "precision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "recall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "support": { "type": "number", "description": "number of samples in the test set\n" } }, "type": "object", "required": [ "f1", "label", "precision", "recall", "support" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultEntityMetric:getModelEvaluationResultEntityMetric": { "properties": { "f1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "label": { "type": "string", "description": "Entity label\n" }, "precision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "recall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" } }, "type": "object", "required": [ "f1", "label", "precision", "recall" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultMetric:getModelEvaluationResultMetric": { "properties": { "accuracy": { "type": "number", "description": "The fraction of the labels that were correctly recognised .\n" }, "macroF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "macroPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "macroRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "microF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "microPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "microRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "weightedF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "weightedPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "weightedRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" } }, "type": "object", "required": [ "accuracy", "macroF1", "macroPrecision", "macroRecall", "microF1", "microPrecision", "microRecall", "weightedF1", "weightedPrecision", "weightedRecall" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollection:getModelEvaluationResultsEvaluationResultCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollectionItem:getModelEvaluationResultsEvaluationResultCollectionItem" }, "description": "List of model evaluation analysis\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollectionItem:getModelEvaluationResultsEvaluationResultCollectionItem": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "location": { "type": "string", "description": "For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata)\n" }, "modelType": { "type": "string", "description": "Model type\n" }, "predictedEntities": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollectionItemPredictedEntity:getModelEvaluationResultsEvaluationResultCollectionItemPredictedEntity" }, "description": "List of true(actual) entities in test data for NER model\n" }, "predictedLabels": { "type": "array", "items": { "type": "string" }, "description": "List of predicted labels by custom multi class or multi label TextClassification model\n" }, "record": { "type": "string", "description": "For CSV format location is rowId(1 is header) and for JSONL location is jsonL line sequence(1 is metadata)\n" }, "trueEntities": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollectionItemTrueEntity:getModelEvaluationResultsEvaluationResultCollectionItemTrueEntity" }, "description": "List of true(actual) entities in test data for NER model\n" }, "trueLabels": { "type": "array", "items": { "type": "string" }, "description": "List of true(actual) labels in test data for multi class or multi label TextClassification\n" } }, "type": "object", "required": [ "definedTags", "freeformTags", "location", "modelType", "predictedEntities", "predictedLabels", "record", "trueEntities", "trueLabels" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollectionItemPredictedEntity:getModelEvaluationResultsEvaluationResultCollectionItemPredictedEntity": { "properties": { "length": { "type": "integer", "description": "Length of text\n" }, "offset": { "type": "integer", "description": "Starting index on text.\n" }, "type": { "type": "string", "description": "Type of entity text like PER, LOC, GPE, NOPE etc.\n" } }, "type": "object", "required": [ "length", "offset", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultsEvaluationResultCollectionItemTrueEntity:getModelEvaluationResultsEvaluationResultCollectionItemTrueEntity": { "properties": { "length": { "type": "integer", "description": "Length of text\n" }, "offset": { "type": "integer", "description": "Starting index on text.\n" }, "type": { "type": "string", "description": "Type of entity text like PER, LOC, GPE, NOPE etc.\n" } }, "type": "object", "required": [ "length", "offset", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelEvaluationResultsFilter:getModelEvaluationResultsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiLanguage/getModelModelDetail:getModelModelDetail": { "properties": { "classificationModes": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelModelDetailClassificationMode:getModelModelDetailClassificationMode" }, "description": "classification Modes\n" }, "languageCode": { "type": "string", "description": "supported language default value is en\n" }, "modelType": { "type": "string", "description": "Model type\n" }, "version": { "type": "string", "description": "For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done \u003c\u003cservice\u003e\u003e::\u003c\u003cservice-name\u003e\u003e_\u003c\u003cmodel-type-version\u003e\u003e::\u003c\u003ccustom model on which this training has to be done\u003e\u003e ex: ai-lang::NER_V1::CUSTOM-V0\n" } }, "type": "object", "required": [ "classificationModes", "languageCode", "modelType", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelModelDetailClassificationMode:getModelModelDetailClassificationMode": { "properties": { "classificationMode": { "type": "string", "description": "classification Modes\n" }, "version": { "type": "string", "description": "For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done \u003c\u003cservice\u003e\u003e::\u003c\u003cservice-name\u003e\u003e_\u003c\u003cmodel-type-version\u003e\u003e::\u003c\u003ccustom model on which this training has to be done\u003e\u003e ex: ai-lang::NER_V1::CUSTOM-V0\n" } }, "type": "object", "required": [ "classificationMode", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTestStrategy:getModelTestStrategy": { "properties": { "strategyType": { "type": "string", "description": "This information will define the test strategy different datasets for test and validation(optional) dataset.\n" }, "testingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelTestStrategyTestingDataset:getModelTestStrategyTestingDataset" }, "description": "Possible data set type\n" }, "validationDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelTestStrategyValidationDataset:getModelTestStrategyValidationDataset" }, "description": "Possible data set type\n" } }, "type": "object", "required": [ "strategyType", "testingDatasets", "validationDatasets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTestStrategyTestingDataset:getModelTestStrategyTestingDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n" }, "datasetType": { "type": "string", "description": "Possible data sets\n" }, "locationDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelTestStrategyTestingDatasetLocationDetail:getModelTestStrategyTestingDatasetLocationDetail" }, "description": "Possible object storage location types\n" } }, "type": "object", "required": [ "datasetId", "datasetType", "locationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTestStrategyTestingDatasetLocationDetail:getModelTestStrategyTestingDatasetLocationDetail": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n" }, "locationType": { "type": "string", "description": "Possible object storage location types\n" }, "namespace": { "type": "string", "description": "Object storage namespace\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTestStrategyValidationDataset:getModelTestStrategyValidationDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n" }, "datasetType": { "type": "string", "description": "Possible data sets\n" }, "locationDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelTestStrategyValidationDatasetLocationDetail:getModelTestStrategyValidationDatasetLocationDetail" }, "description": "Possible object storage location types\n" } }, "type": "object", "required": [ "datasetId", "datasetType", "locationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTestStrategyValidationDatasetLocationDetail:getModelTestStrategyValidationDatasetLocationDetail": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n" }, "locationType": { "type": "string", "description": "Possible object storage location types\n" }, "namespace": { "type": "string", "description": "Object storage namespace\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTrainingDataset:getModelTrainingDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n" }, "datasetType": { "type": "string", "description": "Possible data sets\n" }, "locationDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelTrainingDatasetLocationDetail:getModelTrainingDatasetLocationDetail" }, "description": "Possible object storage location types\n" } }, "type": "object", "required": [ "datasetId", "datasetType", "locationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelTrainingDatasetLocationDetail:getModelTrainingDatasetLocationDetail": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n" }, "locationType": { "type": "string", "description": "Possible object storage location types\n" }, "namespace": { "type": "string", "description": "Object storage namespace\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsFilter:getModelsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiLanguage/getModelsModelCollection:getModelsModelCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItem:getModelsModelCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItem:getModelsModelCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A short description of the Model.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "evaluationResults": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemEvaluationResult:getModelsModelCollectionItemEvaluationResult" }, "description": "model training results of different models\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier model OCID of a model that is immutable on creation\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.\n" }, "modelDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemModelDetail:getModelsModelCollectionItemModelDetail" }, "description": "Possible model types\n" }, "projectId": { "type": "string", "description": "The ID of the project for which to list the objects.\n" }, "state": { "type": "string", "description": "\u003cb\u003eFilter\u003c/b\u003e results by the specified lifecycle state. Must be a valid state for the resource type.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "testStrategies": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTestStrategy:getModelsModelCollectionItemTestStrategy" }, "description": "Possible strategy as testing and validation(optional) dataset.\n" }, "timeCreated": { "type": "string", "description": "The time the the model was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the model was updated. An RFC3339 formatted datetime string.\n" }, "trainingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTrainingDataset:getModelsModelCollectionItemTrainingDataset" }, "description": "Possible data set type\n" }, "version": { "type": "string", "description": "For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done \u003c\u003cservice\u003e\u003e::\u003c\u003cservice-name\u003e\u003e_\u003c\u003cmodel-type-version\u003e\u003e::\u003c\u003ccustom model on which this training has to be done\u003e\u003e ex: ai-lang::NER_V1::CUSTOM-V0\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "evaluationResults", "freeformTags", "id", "lifecycleDetails", "modelDetails", "projectId", "state", "systemTags", "testStrategies", "timeCreated", "timeUpdated", "trainingDatasets", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemEvaluationResult:getModelsModelCollectionItemEvaluationResult": { "properties": { "classMetrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemEvaluationResultClassMetric:getModelsModelCollectionItemEvaluationResultClassMetric" }, "description": "List of text classification metrics\n" }, "confusionMatrix": { "type": "string", "description": "class level confusion matrix\n" }, "entityMetrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemEvaluationResultEntityMetric:getModelsModelCollectionItemEvaluationResultEntityMetric" }, "description": "List of entity metrics\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "labels\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemEvaluationResultMetric:getModelsModelCollectionItemEvaluationResultMetric" }, "description": "Model level named entity recognition metrics\n" }, "modelType": { "type": "string", "description": "Model type\n" } }, "type": "object", "required": [ "classMetrics", "confusionMatrix", "entityMetrics", "labels", "metrics", "modelType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemEvaluationResultClassMetric:getModelsModelCollectionItemEvaluationResultClassMetric": { "properties": { "f1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "label": { "type": "string", "description": "Entity label\n" }, "precision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "recall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "support": { "type": "number", "description": "number of samples in the test set\n" } }, "type": "object", "required": [ "f1", "label", "precision", "recall", "support" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemEvaluationResultEntityMetric:getModelsModelCollectionItemEvaluationResultEntityMetric": { "properties": { "f1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "label": { "type": "string", "description": "Entity label\n" }, "precision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "recall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" } }, "type": "object", "required": [ "f1", "label", "precision", "recall" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemEvaluationResultMetric:getModelsModelCollectionItemEvaluationResultMetric": { "properties": { "accuracy": { "type": "number", "description": "The fraction of the labels that were correctly recognised .\n" }, "macroF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "macroPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "macroRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "microF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "microPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "microRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" }, "weightedF1": { "type": "number", "description": "F1-score, is a measure of a model’s accuracy on a dataset\n" }, "weightedPrecision": { "type": "number", "description": "Precision refers to the number of true positives divided by the total number of positive predictions (i.e., the number of true positives plus the number of false positives)\n" }, "weightedRecall": { "type": "number", "description": "Measures the model's ability to predict actual positive classes. It is the ratio between the predicted true positives and what was actually tagged. The recall metric reveals how many of the predicted classes are correct.\n" } }, "type": "object", "required": [ "accuracy", "macroF1", "macroPrecision", "macroRecall", "microF1", "microPrecision", "microRecall", "weightedF1", "weightedPrecision", "weightedRecall" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemModelDetail:getModelsModelCollectionItemModelDetail": { "properties": { "classificationModes": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemModelDetailClassificationMode:getModelsModelCollectionItemModelDetailClassificationMode" }, "description": "classification Modes\n" }, "languageCode": { "type": "string", "description": "supported language default value is en\n" }, "modelType": { "type": "string", "description": "Model type\n" }, "version": { "type": "string", "description": "For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done \u003c\u003cservice\u003e\u003e::\u003c\u003cservice-name\u003e\u003e_\u003c\u003cmodel-type-version\u003e\u003e::\u003c\u003ccustom model on which this training has to be done\u003e\u003e ex: ai-lang::NER_V1::CUSTOM-V0\n" } }, "type": "object", "required": [ "classificationModes", "languageCode", "modelType", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemModelDetailClassificationMode:getModelsModelCollectionItemModelDetailClassificationMode": { "properties": { "classificationMode": { "type": "string", "description": "classification Modes\n" }, "version": { "type": "string", "description": "For pre trained models this will identify model type version used for model creation For custom this will identify model type version used for model creation and custom model on which training has to be done \u003c\u003cservice\u003e\u003e::\u003c\u003cservice-name\u003e\u003e_\u003c\u003cmodel-type-version\u003e\u003e::\u003c\u003ccustom model on which this training has to be done\u003e\u003e ex: ai-lang::NER_V1::CUSTOM-V0\n" } }, "type": "object", "required": [ "classificationMode", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTestStrategy:getModelsModelCollectionItemTestStrategy": { "properties": { "strategyType": { "type": "string", "description": "This information will define the test strategy different datasets for test and validation(optional) dataset.\n" }, "testingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTestStrategyTestingDataset:getModelsModelCollectionItemTestStrategyTestingDataset" }, "description": "Possible data set type\n" }, "validationDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTestStrategyValidationDataset:getModelsModelCollectionItemTestStrategyValidationDataset" }, "description": "Possible data set type\n" } }, "type": "object", "required": [ "strategyType", "testingDatasets", "validationDatasets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTestStrategyTestingDataset:getModelsModelCollectionItemTestStrategyTestingDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n" }, "datasetType": { "type": "string", "description": "Possible data sets\n" }, "locationDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTestStrategyTestingDatasetLocationDetail:getModelsModelCollectionItemTestStrategyTestingDatasetLocationDetail" }, "description": "Possible object storage location types\n" } }, "type": "object", "required": [ "datasetId", "datasetType", "locationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTestStrategyTestingDatasetLocationDetail:getModelsModelCollectionItemTestStrategyTestingDatasetLocationDetail": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n" }, "locationType": { "type": "string", "description": "Possible object storage location types\n" }, "namespace": { "type": "string", "description": "Object storage namespace\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTestStrategyValidationDataset:getModelsModelCollectionItemTestStrategyValidationDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n" }, "datasetType": { "type": "string", "description": "Possible data sets\n" }, "locationDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTestStrategyValidationDatasetLocationDetail:getModelsModelCollectionItemTestStrategyValidationDatasetLocationDetail" }, "description": "Possible object storage location types\n" } }, "type": "object", "required": [ "datasetId", "datasetType", "locationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTestStrategyValidationDatasetLocationDetail:getModelsModelCollectionItemTestStrategyValidationDatasetLocationDetail": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n" }, "locationType": { "type": "string", "description": "Possible object storage location types\n" }, "namespace": { "type": "string", "description": "Object storage namespace\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTrainingDataset:getModelsModelCollectionItemTrainingDataset": { "properties": { "datasetId": { "type": "string", "description": "Data Science Labelling Service OCID\n" }, "datasetType": { "type": "string", "description": "Possible data sets\n" }, "locationDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getModelsModelCollectionItemTrainingDatasetLocationDetail:getModelsModelCollectionItemTrainingDatasetLocationDetail" }, "description": "Possible object storage location types\n" } }, "type": "object", "required": [ "datasetId", "datasetType", "locationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getModelsModelCollectionItemTrainingDatasetLocationDetail:getModelsModelCollectionItemTrainingDatasetLocationDetail": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket name\n" }, "locationType": { "type": "string", "description": "Possible object storage location types\n" }, "namespace": { "type": "string", "description": "Object storage namespace\n" }, "objectNames": { "type": "array", "items": { "type": "string" }, "description": "Array of files which need to be processed in the bucket\n" } }, "type": "object", "required": [ "bucket", "locationType", "namespace", "objectNames" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getProjectsFilter:getProjectsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiLanguage/getProjectsProjectCollection:getProjectsProjectCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiLanguage/getProjectsProjectCollectionItem:getProjectsProjectCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiLanguage/getProjectsProjectCollectionItem:getProjectsProjectCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A short description of a project.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier OCID of the project\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail.\n" }, "state": { "type": "string", "description": "\u003cb\u003eFilter\u003c/b\u003e results by the specified lifecycle state. Must be a valid state for the resource type.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the resource was created in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "timeUpdated": { "type": "string", "description": "The date and time the resource was updated in the timestamp format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/ModelTestingDataset:ModelTestingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n", "willReplaceOnChanges": true }, "namespaceName": { "type": "string", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The object name of the input data file.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ] } } }, "oci:AiVision/ModelTrainingDataset:ModelTrainingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n", "willReplaceOnChanges": true }, "namespaceName": { "type": "string", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The object name of the input data file.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ] } } }, "oci:AiVision/ModelValidationDataset:ModelValidationDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n", "willReplaceOnChanges": true }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n", "willReplaceOnChanges": true }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n", "willReplaceOnChanges": true }, "namespaceName": { "type": "string", "willReplaceOnChanges": true }, "object": { "type": "string", "description": "The object name of the input data file.\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "datasetType" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ] } } }, "oci:AiVision/StreamGroupStreamOverlap:StreamGroupStreamOverlap": { "properties": { "overlappingStreams": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of streamSource OCIDs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "overlappingStreams" ] } } }, "oci:AiVision/StreamJobFeature:StreamJobFeature": { "properties": { "featureType": { "type": "string", "description": "(Updatable) The feature of video analysis. Allowed values are:\n* OBJECT_TRACKING: Object tracking feature(OT).\n* FACE_DETECTION: Face detection feature(FD).\n" }, "maxResults": { "type": "integer", "description": "(Updatable) The maximum number of results to return.\n" }, "shouldReturnLandmarks": { "type": "boolean", "description": "(Updatable) Whether or not return face landmarks.\n" }, "trackingTypes": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/StreamJobFeatureTrackingType:StreamJobFeatureTrackingType" }, "description": "(Updatable) List of details of what to track.\n" } }, "type": "object", "required": [ "featureType" ], "language": { "nodejs": { "requiredOutputs": [ "featureType", "maxResults", "shouldReturnLandmarks", "trackingTypes" ] } } }, "oci:AiVision/StreamJobFeatureTrackingType:StreamJobFeatureTrackingType": { "properties": { "biometricStoreCompartmentId": { "type": "string", "description": "(Updatable) compartment Id of biometric compartment.\n" }, "biometricStoreId": { "type": "string", "description": "(Updatable) Which biometric store user wants to do face recognition\n" }, "detectionModelId": { "type": "string", "description": "(Updatable) The detection model OCID.\n" }, "maxResults": { "type": "integer", "description": "(Updatable) The maximum number of results to return.\n" }, "objects": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of the objects to be tracked.\n" }, "shouldReturnLandmarks": { "type": "boolean", "description": "(Updatable) Whether or not return face landmarks.\n" }, "trackingModelId": { "type": "string", "description": "(Updatable) The tracking model OCID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "biometricStoreCompartmentId", "biometricStoreId", "detectionModelId", "maxResults", "objects", "shouldReturnLandmarks", "trackingModelId" ] } } }, "oci:AiVision/StreamJobStreamOutputLocation:StreamJobStreamOutputLocation": { "properties": { "bucket": { "type": "string", "description": "(Updatable) The Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "(Updatable) The Object Storage namespace.\n" }, "oboToken": { "type": "string", "description": "(Updatable) Object storage output location\n" }, "outputLocationType": { "type": "string", "description": "(Updatable) Type of device Allowed values are:\n* OBJECT_STORAGE\n* LIVEKIT_WEBRTC_AGENT\n" }, "prefix": { "type": "string", "description": "(Updatable) The Object Storage folder name.\n" } }, "type": "object", "required": [ "bucket", "namespace", "outputLocationType", "prefix" ], "language": { "nodejs": { "requiredOutputs": [ "bucket", "namespace", "oboToken", "outputLocationType", "prefix" ] } } }, "oci:AiVision/StreamSourceStreamSourceDetails:StreamSourceStreamSourceDetails": { "properties": { "cameraUrl": { "type": "string", "description": "(Updatable) url of camera\n" }, "secretId": { "type": "string", "description": "(Updatable) [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret where credentials are stored in username:password format.\n" }, "sourceType": { "type": "string", "description": "(Updatable) Type of source Allowed values are:\n* RTSP\n" }, "streamNetworkAccessDetails": { "$ref": "#/types/oci:AiVision/StreamSourceStreamSourceDetailsStreamNetworkAccessDetails:StreamSourceStreamSourceDetailsStreamNetworkAccessDetails", "description": "(Updatable) Details about a stream Connection type\n" } }, "type": "object", "required": [ "cameraUrl", "sourceType", "streamNetworkAccessDetails" ], "language": { "nodejs": { "requiredOutputs": [ "cameraUrl", "secretId", "sourceType", "streamNetworkAccessDetails" ] } } }, "oci:AiVision/StreamSourceStreamSourceDetailsStreamNetworkAccessDetails:StreamSourceStreamSourceDetailsStreamNetworkAccessDetails": { "properties": { "privateEndpointId": { "type": "string", "description": "(Updatable) [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private Endpoint\n" }, "streamAccessType": { "type": "string", "description": "(Updatable) Type of access Allowed values are:\n* PRIVATE\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "privateEndpointId", "streamAccessType" ] }, "oci:AiVision/getModelTestingDataset:getModelTestingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the ObjectStorage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "The OCID of the Data Science Labeling Dataset.\n" }, "datasetType": { "type": "string", "description": "Type of the Dataset.\n" }, "namespaceName": { "type": "string", "description": "The namespace name of the ObjectStorage bucket that contains the input data file.\n\u003e\u003e\u003e\u003e\u003e\u003e\u003e theirs\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelTrainingDataset:getModelTrainingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the ObjectStorage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "The OCID of the Data Science Labeling Dataset.\n" }, "datasetType": { "type": "string", "description": "Type of the Dataset.\n" }, "namespaceName": { "type": "string", "description": "The namespace name of the ObjectStorage bucket that contains the input data file.\n\u003e\u003e\u003e\u003e\u003e\u003e\u003e theirs\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelValidationDataset:getModelValidationDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the ObjectStorage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "The OCID of the Data Science Labeling Dataset.\n" }, "datasetType": { "type": "string", "description": "Type of the Dataset.\n" }, "namespaceName": { "type": "string", "description": "The namespace name of the ObjectStorage bucket that contains the input data file.\n\u003e\u003e\u003e\u003e\u003e\u003e\u003e theirs\n" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelsFilter:getModelsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiVision/getModelsModelCollection:getModelsModelCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getModelsModelCollectionItem:getModelsModelCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelsModelCollectionItem:getModelsModelCollectionItem": { "properties": { "averagePrecision": { "type": "number", "description": "The mean average precision of the trained model.\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "confidenceThreshold": { "type": "number", "description": "The intersection over the union threshold used for calculating precision and recall.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "description": { "type": "string", "description": "An optional description of the model.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the model with the given identifier.\n" }, "isQuickMode": { "type": "boolean", "description": "Set to true when experimenting with a new model type or dataset, so model training is quick, with a predefined low number of passes through the training data.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail, that can provide actionable information if training failed.\n" }, "maxTrainingDurationInHours": { "type": "number", "description": "The maximum model training duration in hours, expressed as a decimal fraction.\n" }, "metrics": { "type": "string", "description": "The complete set of per-label metrics for successfully trained models.\n" }, "modelType": { "type": "string", "description": "What type of Vision model this is.\n" }, "modelVersion": { "type": "string", "description": "The version of the model.\n" }, "precision": { "type": "number", "description": "The precision of the trained model.\n" }, "projectId": { "type": "string", "description": "The ID of the project for which to list the objects.\n" }, "recall": { "type": "number", "description": "Recall of the trained model.\n" }, "state": { "type": "string", "description": "The filter to match models with the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "testImageCount": { "type": "integer", "description": "The number of images set aside for evaluating model performance metrics after training.\n" }, "testingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getModelsModelCollectionItemTestingDataset:getModelsModelCollectionItemTestingDataset" }, "description": "The base entity which is the input for creating and training a model.\n" }, "timeCreated": { "type": "string", "description": "When the model was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the model was updated, as an RFC3339 datetime string.\n" }, "totalImageCount": { "type": "integer", "description": "The number of images in the dataset used to train, validate, and test the model.\n" }, "trainedDurationInHours": { "type": "number", "description": "The total hours actually used for model training.\n" }, "trainingDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getModelsModelCollectionItemTrainingDataset:getModelsModelCollectionItemTrainingDataset" }, "description": "The base entity which is the input for creating and training a model.\n" }, "validationDatasets": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getModelsModelCollectionItemValidationDataset:getModelsModelCollectionItemValidationDataset" }, "description": "The base entity which is the input for creating and training a model.\n" } }, "type": "object", "required": [ "averagePrecision", "compartmentId", "confidenceThreshold", "definedTags", "description", "displayName", "freeformTags", "id", "isQuickMode", "lifecycleDetails", "maxTrainingDurationInHours", "metrics", "modelType", "modelVersion", "precision", "projectId", "recall", "state", "systemTags", "testImageCount", "testingDatasets", "timeCreated", "timeUpdated", "totalImageCount", "trainedDurationInHours", "trainingDatasets", "validationDatasets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelsModelCollectionItemTestingDataset:getModelsModelCollectionItemTestingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespaceName": { "type": "string" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelsModelCollectionItemTrainingDataset:getModelsModelCollectionItemTrainingDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespaceName": { "type": "string" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getModelsModelCollectionItemValidationDataset:getModelsModelCollectionItemValidationDataset": { "properties": { "bucket": { "type": "string", "description": "The name of the Object Storage bucket that contains the input data file.\n" }, "datasetId": { "type": "string", "description": "OCID of the Data Labeling dataset.\n" }, "datasetType": { "type": "string", "description": "The dataset type, based on where it is stored.\n" }, "namespaceName": { "type": "string" }, "object": { "type": "string", "description": "The object name of the input data file.\n" } }, "type": "object", "required": [ "bucket", "datasetId", "datasetType", "namespaceName", "object" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getProjectsFilter:getProjectsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiVision/getProjectsProjectCollection:getProjectsProjectCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getProjectsProjectCollectionItem:getProjectsProjectCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getProjectsProjectCollectionItem:getProjectsProjectCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "description": { "type": "string", "description": "An optional description of the project.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the project with the given identifier.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail, that can provide actionable information if creation failed.\n" }, "state": { "type": "string", "description": "The filter to match projects with the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "timeCreated": { "type": "string", "description": "When the project was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the project was updated, as an RFC3339 datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamGroupStreamOverlap:getStreamGroupStreamOverlap": { "properties": { "overlappingStreams": { "type": "array", "items": { "type": "string" }, "description": "List of streamSource OCIDs.\n" } }, "type": "object", "required": [ "overlappingStreams" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamGroupsFilter:getStreamGroupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiVision/getStreamGroupsStreamGroupCollection:getStreamGroupsStreamGroupCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamGroupsStreamGroupCollectionItem:getStreamGroupsStreamGroupCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamGroupsStreamGroupCollectionItem:getStreamGroupsStreamGroupCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the device with the given identifier.\n" }, "isEnabled": { "type": "boolean", "description": "Stream\n" }, "state": { "type": "string", "description": "The current state of the streamGroup.\n" }, "streamOverlaps": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamGroupsStreamGroupCollectionItemStreamOverlap:getStreamGroupsStreamGroupCollectionItemStreamOverlap" }, "description": "List of streamSource OCIDs where the streamSource overlaps in field of view.\n" }, "streamSourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of streamSource OCIDs associated with the stream group\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "timeCreated": { "type": "string", "description": "When the streamGroup was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the streamGroup was updated, as an RFC3339 datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "isEnabled", "state", "streamOverlaps", "streamSourceIds", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamGroupsStreamGroupCollectionItemStreamOverlap:getStreamGroupsStreamGroupCollectionItemStreamOverlap": { "properties": { "overlappingStreams": { "type": "array", "items": { "type": "string" }, "description": "List of streamSource OCIDs.\n" } }, "type": "object", "required": [ "overlappingStreams" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobFeature:getStreamJobFeature": { "properties": { "featureType": { "type": "string", "description": "The feature of video analysis. Allowed values are:\n* OBJECT_TRACKING: Object tracking feature(OT).\n* FACE_DETECTION: Face detection feature(FD).\n" }, "maxResults": { "type": "integer", "description": "The maximum number of results to return.\n" }, "shouldReturnLandmarks": { "type": "boolean", "description": "Whether or not return face landmarks.\n" }, "trackingTypes": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamJobFeatureTrackingType:getStreamJobFeatureTrackingType" }, "description": "List of details of what to track.\n" } }, "type": "object", "required": [ "featureType", "maxResults", "shouldReturnLandmarks", "trackingTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobFeatureTrackingType:getStreamJobFeatureTrackingType": { "properties": { "biometricStoreCompartmentId": { "type": "string", "description": "compartment Id of biometric compartment.\n" }, "biometricStoreId": { "type": "string", "description": "Which biometric store user wants to do face recognition\n" }, "detectionModelId": { "type": "string", "description": "The detection model OCID.\n" }, "maxResults": { "type": "integer", "description": "The maximum number of results to return.\n" }, "objects": { "type": "array", "items": { "type": "string" }, "description": "List of the objects to be tracked.\n" }, "shouldReturnLandmarks": { "type": "boolean", "description": "Whether or not return face landmarks.\n" }, "trackingModelId": { "type": "string", "description": "The tracking model OCID.\n" } }, "type": "object", "required": [ "biometricStoreCompartmentId", "biometricStoreId", "detectionModelId", "maxResults", "objects", "shouldReturnLandmarks", "trackingModelId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobStreamOutputLocation:getStreamJobStreamOutputLocation": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "The Object Storage namespace.\n" }, "oboToken": { "type": "string", "description": "Object storage output location\n" }, "outputLocationType": { "type": "string", "description": "Type of device Allowed values are:\n* OBJECT_STORAGE\n* LIVEKIT_WEBRTC_AGENT\n" }, "prefix": { "type": "string", "description": "The Object Storage folder name.\n" } }, "type": "object", "required": [ "bucket", "namespace", "oboToken", "outputLocationType", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobsFilter:getStreamJobsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiVision/getStreamJobsStreamJobCollection:getStreamJobsStreamJobCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamJobsStreamJobCollectionItem:getStreamJobsStreamJobCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobsStreamJobCollectionItem:getStreamJobsStreamJobCollectionItem": { "properties": { "agentParticipantId": { "type": "string", "description": "participant id of agent where results need to be sent\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "features": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamJobsStreamJobCollectionItemFeature:getStreamJobsStreamJobCollectionItemFeature" }, "description": "a list of document analysis features.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the streamjob with the given identifier.\n" }, "lifecycleDetails": { "type": "string", "description": "Additional details about current state of streamJob\n" }, "state": { "type": "string", "description": "The filter to match projects with the given lifecycleState.\n" }, "streamOutputLocations": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamJobsStreamJobCollectionItemStreamOutputLocation:getStreamJobsStreamJobCollectionItemStreamOutputLocation" }, "description": "Details about a where results will be Sent\n" }, "streamSourceId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the streamSource\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "timeCreated": { "type": "string", "description": "When the streamJob was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the stream job was updated, as an RFC3339 datetime string.\n" } }, "type": "object", "required": [ "agentParticipantId", "compartmentId", "definedTags", "displayName", "features", "freeformTags", "id", "lifecycleDetails", "state", "streamOutputLocations", "streamSourceId", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobsStreamJobCollectionItemFeature:getStreamJobsStreamJobCollectionItemFeature": { "properties": { "featureType": { "type": "string", "description": "The feature of video analysis. Allowed values are:\n* OBJECT_TRACKING: Object tracking feature(OT).\n* FACE_DETECTION: Face detection feature(FD).\n" }, "maxResults": { "type": "integer", "description": "The maximum number of results to return.\n" }, "shouldReturnLandmarks": { "type": "boolean", "description": "Whether or not return face landmarks.\n" }, "trackingTypes": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamJobsStreamJobCollectionItemFeatureTrackingType:getStreamJobsStreamJobCollectionItemFeatureTrackingType" }, "description": "List of details of what to track.\n" } }, "type": "object", "required": [ "featureType", "maxResults", "shouldReturnLandmarks", "trackingTypes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobsStreamJobCollectionItemFeatureTrackingType:getStreamJobsStreamJobCollectionItemFeatureTrackingType": { "properties": { "biometricStoreCompartmentId": { "type": "string", "description": "compartment Id of biometric compartment.\n" }, "biometricStoreId": { "type": "string", "description": "Which biometric store user wants to do face recognition\n" }, "detectionModelId": { "type": "string", "description": "The detection model OCID.\n" }, "maxResults": { "type": "integer", "description": "The maximum number of results to return.\n" }, "objects": { "type": "array", "items": { "type": "string" }, "description": "List of the objects to be tracked.\n" }, "shouldReturnLandmarks": { "type": "boolean", "description": "Whether or not return face landmarks.\n" }, "trackingModelId": { "type": "string", "description": "The tracking model OCID.\n" } }, "type": "object", "required": [ "biometricStoreCompartmentId", "biometricStoreId", "detectionModelId", "maxResults", "objects", "shouldReturnLandmarks", "trackingModelId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamJobsStreamJobCollectionItemStreamOutputLocation:getStreamJobsStreamJobCollectionItemStreamOutputLocation": { "properties": { "bucket": { "type": "string", "description": "The Object Storage bucket name.\n" }, "namespace": { "type": "string", "description": "The Object Storage namespace.\n" }, "oboToken": { "type": "string", "description": "Object storage output location\n" }, "outputLocationType": { "type": "string", "description": "Type of device Allowed values are:\n* OBJECT_STORAGE\n* LIVEKIT_WEBRTC_AGENT\n" }, "prefix": { "type": "string", "description": "The Object Storage folder name.\n" } }, "type": "object", "required": [ "bucket", "namespace", "oboToken", "outputLocationType", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamSourceStreamSourceDetail:getStreamSourceStreamSourceDetail": { "properties": { "cameraUrl": { "type": "string", "description": "url of camera\n" }, "secretId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret where credentials are stored in username:password format.\n" }, "sourceType": { "type": "string", "description": "Type of source Allowed values are:\n* RTSP\n" }, "streamNetworkAccessDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamSourceStreamSourceDetailStreamNetworkAccessDetail:getStreamSourceStreamSourceDetailStreamNetworkAccessDetail" }, "description": "Details about a stream Connection type\n" } }, "type": "object", "required": [ "cameraUrl", "secretId", "sourceType", "streamNetworkAccessDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamSourceStreamSourceDetailStreamNetworkAccessDetail:getStreamSourceStreamSourceDetailStreamNetworkAccessDetail": { "properties": { "privateEndpointId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private Endpoint\n" }, "streamAccessType": { "type": "string", "description": "Type of access Allowed values are:\n* PRIVATE\n" } }, "type": "object", "required": [ "privateEndpointId", "streamAccessType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamSourcesFilter:getStreamSourcesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiVision/getStreamSourcesStreamSourceCollection:getStreamSourcesStreamSourceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamSourcesStreamSourceCollectionItem:getStreamSourcesStreamSourceCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamSourcesStreamSourceCollectionItem:getStreamSourcesStreamSourceCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the device with the given identifier.\n" }, "state": { "type": "string", "description": "The filter to match projects with the given lifecycleState.\n" }, "streamSourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamSourcesStreamSourceCollectionItemStreamSourceDetail:getStreamSourcesStreamSourceCollectionItemStreamSourceDetail" }, "description": "Details about a stream source\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "timeCreated": { "type": "string", "description": "When the streamSource was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the streamSource was updated, as an RFC3339 datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "state", "streamSourceDetails", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamSourcesStreamSourceCollectionItemStreamSourceDetail:getStreamSourcesStreamSourceCollectionItemStreamSourceDetail": { "properties": { "cameraUrl": { "type": "string", "description": "url of camera\n" }, "secretId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of secret where credentials are stored in username:password format.\n" }, "sourceType": { "type": "string", "description": "Type of source Allowed values are:\n* RTSP\n" }, "streamNetworkAccessDetails": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getStreamSourcesStreamSourceCollectionItemStreamSourceDetailStreamNetworkAccessDetail:getStreamSourcesStreamSourceCollectionItemStreamSourceDetailStreamNetworkAccessDetail" }, "description": "Details about a stream Connection type\n" } }, "type": "object", "required": [ "cameraUrl", "secretId", "sourceType", "streamNetworkAccessDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getStreamSourcesStreamSourceCollectionItemStreamSourceDetailStreamNetworkAccessDetail:getStreamSourcesStreamSourceCollectionItemStreamSourceDetailStreamNetworkAccessDetail": { "properties": { "privateEndpointId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the private Endpoint\n" }, "streamAccessType": { "type": "string", "description": "Type of access Allowed values are:\n* PRIVATE\n" } }, "type": "object", "required": [ "privateEndpointId", "streamAccessType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getVisionPrivateEndpointsFilter:getVisionPrivateEndpointsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AiVision/getVisionPrivateEndpointsVisionPrivateEndpointCollection:getVisionPrivateEndpointsVisionPrivateEndpointCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AiVision/getVisionPrivateEndpointsVisionPrivateEndpointCollectionItem:getVisionPrivateEndpointsVisionPrivateEndpointCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AiVision/getVisionPrivateEndpointsVisionPrivateEndpointCollectionItem:getVisionPrivateEndpointsVisionPrivateEndpointCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "description": { "type": "string", "description": "An optional description of the visionPrivateEndpoint.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The filter to find the device with the given identifier.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail, that can provide actionable information if creation failed.\n" }, "state": { "type": "string", "description": "The filter to match projects with the given lifecycleState.\n" }, "subnetId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of subnet\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" }, "timeCreated": { "type": "string", "description": "When the visionPrivateEndpoint was created, as an RFC3339 datetime string.\n" }, "timeUpdated": { "type": "string", "description": "When the visionPrivateEndpoint was updated, as an RFC3339 datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "subnetId", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/AnalyticsInstanceCapacity:AnalyticsInstanceCapacity": { "properties": { "capacityType": { "type": "string", "description": "The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT\n", "willReplaceOnChanges": true }, "capacityValue": { "type": "integer", "description": "(Updatable) The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.\n" } }, "type": "object", "required": [ "capacityType", "capacityValue" ] }, "oci:Analytics/AnalyticsInstanceNetworkEndpointDetails:AnalyticsInstanceNetworkEndpointDetails": { "properties": { "networkEndpointType": { "type": "string", "description": "The type of network endpoint.\n", "willReplaceOnChanges": true }, "networkSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Network Security Group OCIDs for an Analytics instance.\n" }, "subnetId": { "type": "string", "description": "The subnet OCID for the private endpoint.\n" }, "vcnId": { "type": "string", "description": "The VCN OCID for the private endpoint.\n" }, "whitelistedIps": { "type": "array", "items": { "type": "string" }, "description": "Source IP addresses or IP address ranges in ingress rules.\n" }, "whitelistedServices": { "type": "array", "items": { "type": "string" }, "description": "Oracle Cloud Services that are allowed to access this Analytics instance.\n" }, "whitelistedVcns": { "type": "array", "items": { "$ref": "#/types/oci:Analytics/AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn:AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn" }, "description": "Virtual Cloud Networks allowed to access this network endpoint.\n" } }, "type": "object", "required": [ "networkEndpointType" ], "language": { "nodejs": { "requiredOutputs": [ "networkEndpointType", "networkSecurityGroupIds", "subnetId", "vcnId", "whitelistedIps", "whitelistedServices", "whitelistedVcns" ] } } }, "oci:Analytics/AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn:AnalyticsInstanceNetworkEndpointDetailsWhitelistedVcn": { "properties": { "id": { "type": "string", "description": "The Virtual Cloud Network OCID.\n" }, "whitelistedIps": { "type": "array", "items": { "type": "string" }, "description": "Source IP addresses or IP address ranges in ingress rules.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id", "whitelistedIps" ] } } }, "oci:Analytics/AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone:AnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone": { "properties": { "description": { "type": "string", "description": "(Updatable) Description of private source dns zone.\n" }, "dnsZone": { "type": "string", "description": "(Updatable) Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.\n" } }, "type": "object", "required": [ "dnsZone" ], "language": { "nodejs": { "requiredOutputs": [ "description", "dnsZone" ] } } }, "oci:Analytics/AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost:AnalyticsInstancePrivateAccessChannelPrivateSourceScanHost": { "properties": { "description": { "type": "string", "description": "(Updatable) Description of private source scan host zone.\n" }, "scanHostname": { "type": "string", "description": "(Updatable) Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.\n" }, "scanPort": { "type": "integer", "description": "(Updatable) Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).\n" } }, "type": "object", "required": [ "scanHostname", "scanPort" ], "language": { "nodejs": { "requiredOutputs": [ "description", "scanHostname", "scanPort" ] } } }, "oci:Analytics/getAnalyticsInstanceCapacity:getAnalyticsInstanceCapacity": { "properties": { "capacityType": { "type": "string", "description": "The capacity model to use. Accepted values are: OLPU_COUNT, USER_COUNT\n" }, "capacityValue": { "type": "integer", "description": "The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.\n" } }, "type": "object", "required": [ "capacityType", "capacityValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstanceNetworkEndpointDetail:getAnalyticsInstanceNetworkEndpointDetail": { "properties": { "networkEndpointType": { "type": "string", "description": "The type of network endpoint.\n" }, "networkSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Network Security Group OCIDs for an Analytics instance.\n" }, "subnetId": { "type": "string", "description": "OCID of the customer subnet connected to private access channel.\n" }, "vcnId": { "type": "string", "description": "OCID of the customer VCN peered with private access channel.\n" }, "whitelistedIps": { "type": "array", "items": { "type": "string" }, "description": "Source IP addresses or IP address ranges in ingress rules.\n" }, "whitelistedServices": { "type": "array", "items": { "type": "string" }, "description": "Oracle Cloud Services that are allowed to access this Analytics instance.\n" }, "whitelistedVcns": { "type": "array", "items": { "$ref": "#/types/oci:Analytics/getAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn:getAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn" }, "description": "Virtual Cloud Networks allowed to access this network endpoint.\n" } }, "type": "object", "required": [ "networkEndpointType", "networkSecurityGroupIds", "subnetId", "vcnId", "whitelistedIps", "whitelistedServices", "whitelistedVcns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn:getAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn": { "properties": { "id": { "type": "string", "description": "The Virtual Cloud Network OCID.\n" }, "whitelistedIps": { "type": "array", "items": { "type": "string" }, "description": "Source IP addresses or IP address ranges in ingress rules.\n" } }, "type": "object", "required": [ "id", "whitelistedIps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone:getAnalyticsInstancePrivateAccessChannelPrivateSourceDnsZone": { "properties": { "description": { "type": "string", "description": "Description of private source scan host zone.\n" }, "dnsZone": { "type": "string", "description": "Private Source DNS Zone. Ex: example-vcn.oraclevcn.com, corp.example.com.\n" } }, "type": "object", "required": [ "description", "dnsZone" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost:getAnalyticsInstancePrivateAccessChannelPrivateSourceScanHost": { "properties": { "description": { "type": "string", "description": "Description of private source scan host zone.\n" }, "scanHostname": { "type": "string", "description": "Private Source Scan hostname. Ex: db01-scan.corp.example.com, prd-db01-scan.mycompany.com.\n" }, "scanPort": { "type": "integer", "description": "Private Source Scan host port. This is the source port where SCAN protocol will get connected (e.g. 1521).\n" } }, "type": "object", "required": [ "description", "scanHostname", "scanPort" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancesAnalyticsInstance:getAnalyticsInstancesAnalyticsInstance": { "properties": { "adminUser": { "type": "string" }, "capacities": { "type": "array", "items": { "$ref": "#/types/oci:Analytics/getAnalyticsInstancesAnalyticsInstanceCapacity:getAnalyticsInstancesAnalyticsInstanceCapacity" }, "description": "Service instance capacity metadata (e.g.: OLPU count, number of users, ...etc...).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "Description of the vanity url.\n" }, "domainId": { "type": "string", "description": "Identity domain OCID.\n" }, "emailNotification": { "type": "string", "description": "Email address receiving notifications.\n" }, "featureBundle": { "type": "string", "description": "The feature set of an Analytics instance.\n" }, "featureSet": { "type": "string", "description": "A filter to only return resources matching the feature set. Values are case-insensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The Virtual Cloud Network OCID.\n" }, "idcsAccessToken": { "type": "string", "secret": true }, "kmsKeyId": { "type": "string", "description": "OCID of the Oracle Cloud Infrastructure Vault Key encrypting the customer data stored in this Analytics instance. A null value indicates Oracle managed default encryption.\n" }, "licenseType": { "type": "string", "description": "The license used for the service.\n" }, "name": { "type": "string", "description": "A filter to return only resources that match the given name exactly.\n" }, "networkEndpointDetails": { "type": "array", "items": { "$ref": "#/types/oci:Analytics/getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetail:getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetail" }, "description": "Base representation of a network endpoint.\n" }, "serviceUrl": { "type": "string", "description": "URL of the Analytics service.\n" }, "state": { "type": "string", "description": "A filter to only return resources matching the lifecycle state. The state value is case-insensitive.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.key\": \"value\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the instance was last updated (in the format defined by RFC3339). This timestamp represents updates made through this API. External events do not influence it.\n" }, "updateChannel": { "type": "string", "description": "Analytics instance update channel.\n" } }, "type": "object", "required": [ "adminUser", "capacities", "compartmentId", "definedTags", "description", "domainId", "emailNotification", "featureBundle", "featureSet", "freeformTags", "id", "idcsAccessToken", "kmsKeyId", "licenseType", "name", "networkEndpointDetails", "serviceUrl", "state", "systemTags", "timeCreated", "timeUpdated", "updateChannel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancesAnalyticsInstanceCapacity:getAnalyticsInstancesAnalyticsInstanceCapacity": { "properties": { "capacityType": { "type": "string", "description": "A filter to only return resources matching the capacity type enum. Values are case-insensitive.\n" }, "capacityValue": { "type": "integer", "description": "The capacity value selected, either the number of OCPUs (OLPU_COUNT) or the number of users (USER_COUNT). This parameter affects the number of OCPUs, amount of memory, and other resources allocated to the instance.\n" } }, "type": "object", "required": [ "capacityType", "capacityValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetail:getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetail": { "properties": { "networkEndpointType": { "type": "string", "description": "The type of network endpoint.\n" }, "networkSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "Network Security Group OCIDs for an Analytics instance.\n" }, "subnetId": { "type": "string", "description": "OCID of the customer subnet connected to private access channel.\n" }, "vcnId": { "type": "string", "description": "OCID of the customer VCN peered with private access channel.\n" }, "whitelistedIps": { "type": "array", "items": { "type": "string" }, "description": "Source IP addresses or IP address ranges in ingress rules.\n" }, "whitelistedServices": { "type": "array", "items": { "type": "string" }, "description": "Oracle Cloud Services that are allowed to access this Analytics instance.\n" }, "whitelistedVcns": { "type": "array", "items": { "$ref": "#/types/oci:Analytics/getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn:getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn" }, "description": "Virtual Cloud Networks allowed to access this network endpoint.\n" } }, "type": "object", "required": [ "networkEndpointType", "networkSecurityGroupIds", "subnetId", "vcnId", "whitelistedIps", "whitelistedServices", "whitelistedVcns" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn:getAnalyticsInstancesAnalyticsInstanceNetworkEndpointDetailWhitelistedVcn": { "properties": { "id": { "type": "string", "description": "The Virtual Cloud Network OCID.\n" }, "whitelistedIps": { "type": "array", "items": { "type": "string" }, "description": "Source IP addresses or IP address ranges in ingress rules.\n" } }, "type": "object", "required": [ "id", "whitelistedIps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Analytics/getAnalyticsInstancesFilter:getAnalyticsInstancesFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only resources that match the given name exactly.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AnnouncementsService/AnnouncementSubscriptionFilterGroups:AnnouncementSubscriptionFilterGroups": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/oci:AnnouncementsService/AnnouncementSubscriptionFilterGroupsFilter:AnnouncementSubscriptionFilterGroupsFilter" }, "description": "A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "filters" ], "language": { "nodejs": { "requiredOutputs": [ "filters", "name" ] } } }, "oci:AnnouncementsService/AnnouncementSubscriptionFilterGroupsFilter:AnnouncementSubscriptionFilterGroupsFilter": { "properties": { "type": { "type": "string", "description": "The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The value of the filter.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type", "value" ] }, "oci:AnnouncementsService/AnnouncementSubscriptionsFilterGroupFilter:AnnouncementSubscriptionsFilterGroupFilter": { "properties": { "type": { "type": "string", "description": "(Updatable) The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the filter.\n" } }, "type": "object", "required": [ "type", "value" ] }, "oci:AnnouncementsService/getAnnouncementSubscriptionFilterGroup:getAnnouncementSubscriptionFilterGroup": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/oci:AnnouncementsService/getAnnouncementSubscriptionFilterGroupFilter:getAnnouncementSubscriptionFilterGroupFilter" }, "description": "A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n" }, "name": { "type": "string", "description": "The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "filters", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getAnnouncementSubscriptionFilterGroupFilter:getAnnouncementSubscriptionFilterGroupFilter": { "properties": { "type": { "type": "string", "description": "The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n" }, "value": { "type": "string", "description": "The value of the filter.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollection:getAnnouncementSubscriptionsAnnouncementSubscriptionCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItem:getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItem:getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A description of the announcement subscription. Avoid entering confidential information.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "filterGroups": { "type": "array", "items": { "$ref": "#/types/oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroup:getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroup" }, "description": "A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the announcement subscription.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.\n" }, "onsTopicId": { "type": "string", "description": "The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.\n" }, "preferredLanguage": { "type": "string", "description": "(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.\n" }, "preferredTimeZone": { "type": "string", "description": "The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles\n" }, "state": { "type": "string", "description": "A filter to return only announcement subscriptions that match the given lifecycle state.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time that the announcement subscription was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n" }, "timeUpdated": { "type": "string", "description": "The date and time that the announcement subscription was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "filterGroups", "freeformTags", "id", "lifecycleDetails", "onsTopicId", "preferredLanguage", "preferredTimeZone", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroup:getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroup": { "properties": { "filters": { "type": "array", "items": { "$ref": "#/types/oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroupFilter:getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroupFilter" }, "description": "A list of filters against which the Announcements service matches announcements. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n" }, "name": { "type": "string", "description": "The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "filters", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroupFilter:getAnnouncementSubscriptionsAnnouncementSubscriptionCollectionItemFilterGroupFilter": { "properties": { "type": { "type": "string", "description": "The type of filter. You cannot combine the RESOURCE_ID filter with any other type of filter within a given filter group. For filter types that support multiple values, specify the values individually.\n" }, "value": { "type": "string", "description": "The value of the filter.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getAnnouncementSubscriptionsFilter:getAnnouncementSubscriptionsFilter": { "properties": { "name": { "type": "string", "description": "The name of the group. The name must be unique and it cannot be changed. Avoid entering confidential information.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AnnouncementsService/getServicesFilter:getServicesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AnnouncementsService/getServicesServicesCollection:getServicesServicesCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AnnouncementsService/getServicesServicesCollectionItem:getServicesServicesCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AnnouncementsService/getServicesServicesCollectionItem:getServicesServicesCollectionItem": { "properties": { "commsManagerName": { "type": "string", "description": "Filter by comms manager name\n" }, "excludedRealms": { "type": "array", "items": { "type": "string" }, "description": "The list of realms where this service is not available to be used.\n" }, "id": { "type": "string", "description": "ID of the service object.\n" }, "platformType": { "type": "string", "description": "A filter to return only services underlying a specific platform.\n" }, "previousServiceNames": { "type": "array", "items": { "type": "string" }, "description": "The list of previously used names for this service object.\n" }, "serviceName": { "type": "string", "description": "Name of the service represented by this object.\n" }, "shortName": { "type": "string", "description": "Short name of the team to whom this service object is related.\n" }, "state": { "type": "string", "description": "Current state of the service object.\n" }, "teamName": { "type": "string", "description": "Team name to which this service object is related.\n" }, "timeCreated": { "type": "string", "description": "The date and time when the service object was created.\n" }, "timeUpdated": { "type": "string", "description": "The date and time when the service object was updated.\n" }, "type": { "type": "string" } }, "type": "object", "required": [ "commsManagerName", "excludedRealms", "id", "platformType", "previousServiceNames", "serviceName", "shortName", "state", "teamName", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/ApiLock:ApiLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:ApiGateway/ApiValidationResult:ApiValidationResult": { "properties": { "name": { "type": "string", "description": "Name of the validation.\n" }, "result": { "type": "string", "description": "Result of the validation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "result" ] } } }, "oci:ApiGateway/CertificateLock:CertificateLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:ApiGateway/DeploymentLock:DeploymentLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:ApiGateway/DeploymentSpecification:DeploymentSpecification": { "properties": { "loggingPolicies": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationLoggingPolicies:DeploymentSpecificationLoggingPolicies", "description": "(Updatable) Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "requestPolicies": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPolicies:DeploymentSpecificationRequestPolicies", "description": "(Updatable) Global behavior applied to all requests received by the API.\n" }, "routes": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRoute:DeploymentSpecificationRoute" }, "description": "(Updatable) A list of routes that this API exposes.\n" } }, "type": "object", "required": [ "routes" ], "language": { "nodejs": { "requiredOutputs": [ "loggingPolicies", "requestPolicies", "routes" ] } } }, "oci:ApiGateway/DeploymentSpecificationLoggingPolicies:DeploymentSpecificationLoggingPolicies": { "properties": { "accessLog": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationLoggingPoliciesAccessLog:DeploymentSpecificationLoggingPoliciesAccessLog", "description": "(Updatable) Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLog": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationLoggingPoliciesExecutionLog:DeploymentSpecificationLoggingPoliciesExecutionLog", "description": "(Updatable) Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessLog", "executionLog" ] } } }, "oci:ApiGateway/DeploymentSpecificationLoggingPoliciesAccessLog:DeploymentSpecificationLoggingPoliciesAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "(Updatable) Enables pushing of access logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nOracle recommends using the Oracle Cloud Infrastructure Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in Oracle Cloud Infrastructure Logging service, the logs will not be uploaded to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nPlease note that the functionality to push to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket has been deprecated and will be removed in the future.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isEnabled" ] } } }, "oci:ApiGateway/DeploymentSpecificationLoggingPoliciesExecutionLog:DeploymentSpecificationLoggingPoliciesExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "(Updatable) Enables pushing of execution logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nOracle recommends using the Oracle Cloud Infrastructure Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in Oracle Cloud Infrastructure Logging service, the logs will not be uploaded to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nPlease note that the functionality to push to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket has been deprecated and will be removed in the future.\n" }, "logLevel": { "type": "string", "description": "(Updatable) Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isEnabled", "logLevel" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPolicies:DeploymentSpecificationRequestPolicies": { "properties": { "authentication": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthentication:DeploymentSpecificationRequestPoliciesAuthentication", "description": "(Updatable) Information on how to authenticate incoming requests.\n" }, "cors": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesCors:DeploymentSpecificationRequestPoliciesCors", "description": "(Updatable) Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "dynamicAuthentication": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthentication:DeploymentSpecificationRequestPoliciesDynamicAuthentication", "description": "(Updatable) Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.\n" }, "mutualTls": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesMutualTls:DeploymentSpecificationRequestPoliciesMutualTls", "description": "(Updatable) Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.\n" }, "rateLimiting": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesRateLimiting:DeploymentSpecificationRequestPoliciesRateLimiting", "description": "(Updatable) Limit the number of requests that should be handled for the specified window using a specfic key.\n" }, "usagePlans": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesUsagePlans:DeploymentSpecificationRequestPoliciesUsagePlans", "description": "(Updatable) Usage plan policies for this deployment\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authentication", "cors", "dynamicAuthentication", "mutualTls", "rateLimiting", "usagePlans" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthentication:DeploymentSpecificationRequestPoliciesAuthentication": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "(Updatable) Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "(Updatable) The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: `{\"foo\": \"request.header[abc]\"}`\n" }, "publicKeys": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys:DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys", "description": "(Updatable) A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "(Updatable) The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "(Updatable) The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "(Updatable) The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the authentication policy to use.\n" }, "validationFailurePolicy": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy", "description": "(Updatable) Policy for defining behaviour on validation failure.\n" }, "validationPolicy": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy", "description": "(Updatable) Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim:DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim" }, "description": "(Updatable) A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicy", "validationPolicy", "verifyClaims" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys:DeploymentSpecificationRequestPoliciesAuthenticationPublicKeys": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "(Updatable) Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey:DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey" }, "description": "(Updatable) The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "(Updatable) The duration for which the JWKS should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the public key set.\n" }, "uri": { "type": "string", "description": "(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey:DeploymentSpecificationRequestPoliciesAuthenticationPublicKeysKey": { "properties": { "alg": { "type": "string", "description": "(Updatable) The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "(Updatable) The format of the public key.\n" }, "key": { "type": "string", "description": "(Updatable) The content of the PEM-encoded public key.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "(Updatable) The key type.\n" }, "n": { "type": "string", "description": "(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "(Updatable) The intended use of the public key.\n" } }, "type": "object", "required": [ "format" ], "language": { "nodejs": { "requiredOutputs": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicy": { "properties": { "clientDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails", "description": "(Updatable) Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "(Updatable) The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "(Updatable) The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "(Updatable) The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "(Updatable) The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "(Updatable) HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations", "description": "(Updatable) A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "(Updatable) HTTP response message.\n" }, "responseType": { "type": "string", "description": "(Updatable) Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of scopes.\n" }, "sourceUriDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails", "description": "(Updatable) Auth endpoint details.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Validation failure Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "(Updatable) Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "(Updatable) Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "(Updatable) Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyClientDetails": { "properties": { "clientId": { "type": "string", "description": "(Updatable) Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "(Updatable) The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "(Updatable) To specify where the Client App details should be taken from.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformations": { "properties": { "filterHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders", "description": "(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders", "description": "(Updatable) Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders", "description": "(Updatable) Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "filterHeaders", "renameHeaders", "setHeaders" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem" }, "description": "(Updatable) The list of headers.\n" }, "type": { "type": "string", "description": "(Updatable) BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "items", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem": { "properties": { "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "items" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem": { "properties": { "from": { "type": "string", "description": "(Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "(Updatable) The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "items" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem": { "properties": { "ifExists": { "type": "string", "description": "(Updatable) If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ifExists", "name", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationFailurePolicySourceUriDetails": { "properties": { "type": { "type": "string", "description": "(Updatable) Type of the Uri detail.\n" }, "uri": { "type": "string", "description": "(Updatable) The discovery URI for the auth server.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicy": { "properties": { "additionalValidationPolicy": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy", "description": "(Updatable) Additional JWT validation checks.\n" }, "clientDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails", "description": "(Updatable) Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "(Updatable) Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey" }, "description": "(Updatable) The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "(Updatable) The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails", "description": "(Updatable) Auth endpoint details.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the token validation policy.\n" }, "uri": { "type": "string", "description": "(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "additionalValidationPolicy", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "(Updatable) A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "audiences", "issuers", "verifyClaims" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "(Updatable) Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "(Updatable) Name of the claim.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of acceptable values for a given claim. If this value is \"null\" or empty and \"isRequired\" set to \"true\", then the presence of this claim in the JWT is validated.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isRequired", "key", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyClientDetails": { "properties": { "clientId": { "type": "string", "description": "(Updatable) Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "(Updatable) The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "(Updatable) To specify where the Client App details should be taken from.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "(Updatable) The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "(Updatable) The format of the public key.\n" }, "key": { "type": "string", "description": "(Updatable) The content of the PEM-encoded public key.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "(Updatable) The key type.\n" }, "n": { "type": "string", "description": "(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "(Updatable) The intended use of the public key.\n" } }, "type": "object", "required": [ "format" ], "language": { "nodejs": { "requiredOutputs": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails:DeploymentSpecificationRequestPoliciesAuthenticationValidationPolicySourceUriDetails": { "properties": { "type": { "type": "string", "description": "(Updatable) Type of the Uri detail.\n" }, "uri": { "type": "string", "description": "(Updatable) The discovery URI for the auth server.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim:DeploymentSpecificationRequestPoliciesAuthenticationVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "(Updatable) Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "(Updatable) Name of the claim.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of acceptable values for a given claim. If this value is \"null\" or empty and \"isRequired\" set to \"true\", then the presence of this claim in the JWT is validated.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isRequired", "key", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesCors:DeploymentSpecificationRequestPoliciesCors": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "(Updatable) Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "(Updatable) The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedOrigins" ], "language": { "nodejs": { "requiredOutputs": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthentication:DeploymentSpecificationRequestPoliciesDynamicAuthentication": { "properties": { "authenticationServers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer" }, "description": "(Updatable) List of authentication servers to choose from during dynamic authentication.\n" }, "selectionSource": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource:DeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource", "description": "(Updatable) The type of selector to use when dynamically routing and dynamically authenticating requests.\n" } }, "type": "object", "required": [ "authenticationServers", "selectionSource" ] }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServer": { "properties": { "authenticationServerDetail": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail", "description": "(Updatable) Information on how to authenticate incoming requests.\n" }, "key": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey", "description": "(Updatable) Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating requests.\n" } }, "type": "object", "required": [ "authenticationServerDetail", "key" ] }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetail": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "(Updatable) Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "(Updatable) The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) A map where key is a user defined string and value is a context expressions whose values will be sent to the custom auth function. Values should contain an expression. Example: `{\"foo\": \"request.header[abc]\"}`\n" }, "publicKeys": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys", "description": "(Updatable) A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "(Updatable) The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "(Updatable) The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "(Updatable) The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the authentication policy to use.\n" }, "validationFailurePolicy": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy", "description": "(Updatable) Policy for defining behaviour on validation failure.\n" }, "validationPolicy": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy", "description": "(Updatable) Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim" }, "description": "(Updatable) A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicy", "validationPolicy", "verifyClaims" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeys": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "(Updatable) Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey" }, "description": "(Updatable) The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "(Updatable) The duration for which the JWKS should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the public key set.\n" }, "uri": { "type": "string", "description": "(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeysKey": { "properties": { "alg": { "type": "string", "description": "(Updatable) The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "(Updatable) The format of the public key.\n" }, "key": { "type": "string", "description": "(Updatable) The content of the PEM-encoded public key.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "(Updatable) The key type.\n" }, "n": { "type": "string", "description": "(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "(Updatable) The intended use of the public key.\n" } }, "type": "object", "required": [ "format" ], "language": { "nodejs": { "requiredOutputs": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy": { "properties": { "clientDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails", "description": "(Updatable) Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "(Updatable) The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "(Updatable) The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "(Updatable) The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "(Updatable) The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "(Updatable) HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations", "description": "(Updatable) A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "(Updatable) HTTP response message.\n" }, "responseType": { "type": "string", "description": "(Updatable) Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of scopes.\n" }, "sourceUriDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails", "description": "(Updatable) Auth endpoint details.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Validation failure Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "(Updatable) Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "(Updatable) Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "(Updatable) Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetails": { "properties": { "clientId": { "type": "string", "description": "(Updatable) Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "(Updatable) The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "(Updatable) To specify where the Client App details should be taken from.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformations": { "properties": { "filterHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders", "description": "(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders", "description": "(Updatable) Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders", "description": "(Updatable) Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "filterHeaders", "renameHeaders", "setHeaders" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem" }, "description": "(Updatable) The list of headers.\n" }, "type": { "type": "string", "description": "(Updatable) BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "items", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsFilterHeadersItem": { "properties": { "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "items" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsRenameHeadersItem": { "properties": { "from": { "type": "string", "description": "(Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "(Updatable) The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "from", "to" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "items" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationsSetHeadersItem": { "properties": { "ifExists": { "type": "string", "description": "(Updatable) If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ifExists", "name", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetails": { "properties": { "type": { "type": "string", "description": "(Updatable) Type of the Uri detail.\n" }, "uri": { "type": "string", "description": "(Updatable) The discovery URI for the auth server.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy": { "properties": { "additionalValidationPolicy": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy", "description": "(Updatable) Additional JWT validation checks.\n" }, "clientDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails", "description": "(Updatable) Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "(Updatable) Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey" }, "description": "(Updatable) The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "(Updatable) The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails", "description": "(Updatable) Auth endpoint details.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the token validation policy.\n" }, "uri": { "type": "string", "description": "(Updatable) The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "additionalValidationPolicy", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "(Updatable) A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "audiences", "issuers", "verifyClaims" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "(Updatable) Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "(Updatable) Name of the claim.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of acceptable values for a given claim. If this value is \"null\" or empty and \"isRequired\" set to \"true\", then the presence of this claim in the JWT is validated.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isRequired", "key", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetails": { "properties": { "clientId": { "type": "string", "description": "(Updatable) Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "(Updatable) The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "(Updatable) To specify where the Client App details should be taken from.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "(Updatable) The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "(Updatable) The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "(Updatable) The format of the public key.\n" }, "key": { "type": "string", "description": "(Updatable) The content of the PEM-encoded public key.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "(Updatable) A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "(Updatable) The key type.\n" }, "n": { "type": "string", "description": "(Updatable) The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "(Updatable) The intended use of the public key.\n" } }, "type": "object", "required": [ "format" ], "language": { "nodejs": { "requiredOutputs": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetails": { "properties": { "type": { "type": "string", "description": "(Updatable) Type of the Uri detail.\n" }, "uri": { "type": "string", "description": "(Updatable) The discovery URI for the auth server.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "type", "uri" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "(Updatable) Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "(Updatable) Name of the claim.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of acceptable values for a given claim. If this value is \"null\" or empty and \"isRequired\" set to \"true\", then the presence of this claim in the JWT is validated.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isRequired", "key", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey:DeploymentSpecificationRequestPoliciesDynamicAuthenticationAuthenticationServerKey": { "properties": { "expression": { "type": "string", "description": "(Updatable) A selection key string containing a wildcard to match with the context variable in an incoming request. If the context variable matches the string, the request is sent to the route or authentication server associated with the selection key. Valid wildcards are '*' (zero or more characters) and '+' (one or more characters). The string can only contain one wildcard, and the wildcard must be at the start or the end of the string.\n" }, "isDefault": { "type": "boolean", "description": "(Updatable) Specifies whether to use the route or authentication server associated with this selection key as the default. The default is used if the value of a context variable in an incoming request does not match any of the other selection key values when dynamically routing and dynamically authenticating requests.\n" }, "name": { "type": "string", "description": "(Updatable) Name assigned to the branch.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the selection key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The set of selection keys to match with the context variable in an incoming request. If the context variable exactly matches one of the keys in the set, the request is sent to the route or authentication server associated with the set.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "expression", "isDefault", "name", "type", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource:DeploymentSpecificationRequestPoliciesDynamicAuthenticationSelectionSource": { "properties": { "selector": { "type": "string", "description": "(Updatable) String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Selection source to use.\n" } }, "type": "object", "required": [ "selector", "type" ] }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesMutualTls:DeploymentSpecificationRequestPoliciesMutualTls": { "properties": { "allowedSans": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) Allowed list of CN or SAN which will be used for verification of certificate.\n" }, "isVerifiedCertificateRequired": { "type": "boolean", "description": "(Updatable) Determines whether to enable client verification when API Consumer makes connection to the gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowedSans", "isVerifiedCertificateRequired" ] } } }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesRateLimiting:DeploymentSpecificationRequestPoliciesRateLimiting": { "properties": { "rateInRequestsPerSecond": { "type": "integer", "description": "(Updatable) The maximum number of requests per second to allow.\n" }, "rateKey": { "type": "string", "description": "(Updatable) The key used to group requests together.\n" } }, "type": "object", "required": [ "rateInRequestsPerSecond", "rateKey" ] }, "oci:ApiGateway/DeploymentSpecificationRequestPoliciesUsagePlans:DeploymentSpecificationRequestPoliciesUsagePlans": { "properties": { "tokenLocations": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of context variables specifying where API tokens may be located in a request. Example locations:\n* \"request.headers[token]\"\n* \"request.query[token]\"\n* \"request.auth[Token]\"\n* \"request.path[TOKEN]\"\n" } }, "type": "object", "required": [ "tokenLocations" ] }, "oci:ApiGateway/DeploymentSpecificationRoute:DeploymentSpecificationRoute": { "properties": { "backend": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackend:DeploymentSpecificationRouteBackend", "description": "(Updatable) The backend to forward requests to.\n" }, "loggingPolicies": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteLoggingPolicies:DeploymentSpecificationRouteLoggingPolicies", "description": "(Updatable) Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "methods": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of allowed methods on this route.\n" }, "path": { "type": "string", "description": "(Updatable) A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.\n" }, "requestPolicies": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPolicies:DeploymentSpecificationRouteRequestPolicies", "description": "(Updatable) Behavior applied to any requests received by the API on this route.\n" }, "responsePolicies": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePolicies:DeploymentSpecificationRouteResponsePolicies", "description": "(Updatable) Behavior applied to any responses sent by the API for requests on this route.\n" } }, "type": "object", "required": [ "backend", "path" ], "language": { "nodejs": { "requiredOutputs": [ "backend", "loggingPolicies", "methods", "path", "requestPolicies", "responsePolicies" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackend:DeploymentSpecificationRouteBackend": { "properties": { "allowedPostLogoutUris": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of allowed post-logout URLs to which a request can be redirected after revoke access\n" }, "body": { "type": "string", "description": "(Updatable) The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "(Updatable) Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackendHeader:DeploymentSpecificationRouteBackendHeader" }, "description": "(Updatable) The headers of the stock response from the mock backend.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "(Updatable) Defines whether or not to uphold SSL verification.\n" }, "postLogoutState": { "type": "string", "description": "(Updatable) Defines a state that should be shared on redirecting to postLogout URL.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "(Updatable) Defines a timeout for reading a response from the proxied server.\n" }, "routingBackends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackend:DeploymentSpecificationRouteBackendRoutingBackend" }, "description": "(Updatable) List of backends to chose from for Dynamic Routing.\n" }, "selectionSource": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackendSelectionSource:DeploymentSpecificationRouteBackendSelectionSource", "description": "(Updatable) Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "(Updatable) Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "(Updatable) The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the API backend.\n" }, "url": { "type": "string", "description": "(Updatable) The url of the HTTP Backend\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "allowedPostLogoutUris", "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "postLogoutState", "readTimeoutInSeconds", "routingBackends", "selectionSource", "sendTimeoutInSeconds", "status", "type", "url" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackendHeader:DeploymentSpecificationRouteBackendHeader": { "properties": { "name": { "type": "string", "description": "(Updatable) Name of the header.\n" }, "value": { "type": "string", "description": "(Updatable) Value of the header.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "value" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackend:DeploymentSpecificationRouteBackendRoutingBackend": { "properties": { "backend": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackendBackend:DeploymentSpecificationRouteBackendRoutingBackendBackend", "description": "(Updatable) The backend to forward requests to.\n" }, "key": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackendKey:DeploymentSpecificationRouteBackendRoutingBackendKey", "description": "(Updatable) Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "backend", "key" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackendBackend:DeploymentSpecificationRouteBackendRoutingBackendBackend": { "properties": { "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackendBackendHeader:DeploymentSpecificationRouteBackendRoutingBackendBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "readTimeoutInSeconds", "sendTimeoutInSeconds", "status", "type", "url" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackendBackendHeader:DeploymentSpecificationRouteBackendRoutingBackendBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "value" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackendRoutingBackendKey:DeploymentSpecificationRouteBackendRoutingBackendKey": { "properties": { "expression": { "type": "string", "description": "(Updatable) String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "(Updatable) Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "(Updatable) Name assigned to the branch.\n" }, "type": { "type": "string", "description": "(Updatable) Information regarding type of the selection key.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) Information regarding the set of values of selector for which this branch should be selected.\n" } }, "type": "object", "required": [ "name", "type" ], "language": { "nodejs": { "requiredOutputs": [ "expression", "isDefault", "name", "type", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteBackendSelectionSource:DeploymentSpecificationRouteBackendSelectionSource": { "properties": { "selector": { "type": "string", "description": "(Updatable) String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Selection source to use.\n" } }, "type": "object", "required": [ "selector", "type" ] }, "oci:ApiGateway/DeploymentSpecificationRouteLoggingPolicies:DeploymentSpecificationRouteLoggingPolicies": { "properties": { "accessLog": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteLoggingPoliciesAccessLog:DeploymentSpecificationRouteLoggingPoliciesAccessLog", "description": "(Updatable) Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLog": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteLoggingPoliciesExecutionLog:DeploymentSpecificationRouteLoggingPoliciesExecutionLog", "description": "(Updatable) Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "accessLog", "executionLog" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteLoggingPoliciesAccessLog:DeploymentSpecificationRouteLoggingPoliciesAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "(Updatable) Enables pushing of access logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nOracle recommends using the Oracle Cloud Infrastructure Logging service to enable, retrieve, and query access logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'access' in Oracle Cloud Infrastructure Logging service, the logs will not be uploaded to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nPlease note that the functionality to push to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket has been deprecated and will be removed in the future.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isEnabled" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteLoggingPoliciesExecutionLog:DeploymentSpecificationRouteLoggingPoliciesExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "(Updatable) Enables pushing of execution logs to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nOracle recommends using the Oracle Cloud Infrastructure Logging service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in Oracle Cloud Infrastructure Logging service, the logs will not be uploaded to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket.\n\nPlease note that the functionality to push to the legacy Oracle Cloud Infrastructure Object Storage log archival bucket has been deprecated and will be removed in the future.\n" }, "logLevel": { "type": "string", "description": "(Updatable) Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isEnabled", "logLevel" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPolicies:DeploymentSpecificationRouteRequestPolicies": { "properties": { "authorization": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesAuthorization:DeploymentSpecificationRouteRequestPoliciesAuthorization", "description": "(Updatable) If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.\n" }, "bodyValidation": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesBodyValidation:DeploymentSpecificationRouteRequestPoliciesBodyValidation", "description": "(Updatable) Validate the payload body of the incoming API requests on a specific route.\n" }, "cors": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesCors:DeploymentSpecificationRouteRequestPoliciesCors", "description": "(Updatable) Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "headerTransformations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformations:DeploymentSpecificationRouteRequestPoliciesHeaderTransformations", "description": "(Updatable) A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "headerValidations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderValidations:DeploymentSpecificationRouteRequestPoliciesHeaderValidations", "description": "(Updatable) Validate the HTTP headers on the incoming API requests on a specific route.\n" }, "queryParameterTransformations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations", "description": "(Updatable) A set of transformations to apply to query parameters that pass through the gateway.\n" }, "queryParameterValidations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations:DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations", "description": "(Updatable) Validate the URL query parameters on the incoming API requests on a specific route.\n" }, "responseCacheLookup": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup:DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup", "description": "(Updatable) Base policy for Response Cache lookup.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authorization", "bodyValidation", "cors", "headerTransformations", "headerValidations", "queryParameterTransformations", "queryParameterValidations", "responseCacheLookup" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesAuthorization:DeploymentSpecificationRouteRequestPoliciesAuthorization": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.\n" }, "type": { "type": "string", "description": "(Updatable) Indicates how authorization should be applied. For a type of ANY_OF, an \"allowedScope\" property must also be specified. Otherwise, only a type is required. For a type of ANONYMOUS, an authenticated API must have the \"isAnonymousAccessAllowed\" property set to \"true\" in the authentication policy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "allowedScopes", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesBodyValidation:DeploymentSpecificationRouteRequestPoliciesBodyValidation": { "properties": { "contents": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesBodyValidationContent:DeploymentSpecificationRouteRequestPoliciesBodyValidationContent" }, "description": "(Updatable) The content of the request body.\n" }, "required": { "type": "boolean", "description": "(Updatable) Determines if the request body is required in the request.\n" }, "validationMode": { "type": "string", "description": "(Updatable) Validation behavior mode.\n\nIn `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend.\n\nIn `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path.\n\n`DISABLED` type turns the validation off.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "contents", "required", "validationMode" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesBodyValidationContent:DeploymentSpecificationRouteRequestPoliciesBodyValidationContent": { "properties": { "mediaType": { "type": "string", "description": "(Updatable) The\u003cspan pulumi-lang-nodejs=\" mediaType \" pulumi-lang-dotnet=\" MediaType \" pulumi-lang-go=\" mediaType \" pulumi-lang-python=\" media_type \" pulumi-lang-yaml=\" mediaType \" pulumi-lang-java=\" mediaType \" pulumi-lang-hcl=\" media_type \"\u003e mediaType \u003c/span\u003eis a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema\n\u003cspan pulumi-lang-nodejs=\"\nmediaType \" pulumi-lang-dotnet=\"\nMediaType \" pulumi-lang-go=\"\nmediaType \" pulumi-lang-python=\"\nmedia_type \" pulumi-lang-yaml=\"\nmediaType \" pulumi-lang-java=\"\nmediaType \" pulumi-lang-hcl=\"\nmedia_type \"\u003e\nmediaType \u003c/span\u003e::= ( / ( \"*\" \"/\" \"*\" ) / ( type \"/\" \"*\" ) / ( type \"/\" subtype ) )\n\nFor requests that match multiple media types, only the most specific media type is applicable. e.g. `text/plain` overrides `text/*`\n" }, "validationType": { "type": "string", "description": "(Updatable) Validation type defines the content validation method.\n\nMake the validation to first parse the body as the respective format.\n" } }, "type": "object", "required": [ "mediaType", "validationType" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesCors:DeploymentSpecificationRouteRequestPoliciesCors": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "(Updatable) Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "(Updatable) The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedOrigins" ], "language": { "nodejs": { "requiredOutputs": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformations:DeploymentSpecificationRouteRequestPoliciesHeaderTransformations": { "properties": { "filterHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders", "description": "(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders", "description": "(Updatable) Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders", "description": "(Updatable) Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "filterHeaders", "renameHeaders", "setHeaders" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem" }, "description": "(Updatable) The list of headers.\n" }, "type": { "type": "string", "description": "(Updatable) BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list.\n" } }, "type": "object", "required": [ "items", "type" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsFilterHeadersItem": { "properties": { "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "required": [ "items" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsRenameHeadersItem": { "properties": { "from": { "type": "string", "description": "(Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "(Updatable) The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "required": [ "items" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem:DeploymentSpecificationRouteRequestPoliciesHeaderTransformationsSetHeadersItem": { "properties": { "ifExists": { "type": "string", "description": "(Updatable) If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "name", "values" ], "language": { "nodejs": { "requiredOutputs": [ "ifExists", "name", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderValidations:DeploymentSpecificationRouteRequestPoliciesHeaderValidations": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader:DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader" }, "description": "(Updatable) The List of Headers\n" }, "validationMode": { "type": "string", "description": "(Updatable) Validation behavior mode.\n\nIn `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend.\n\nIn `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path.\n\n`DISABLED` type turns the validation off.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "headers", "validationMode" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader:DeploymentSpecificationRouteRequestPoliciesHeaderValidationsHeader": { "properties": { "name": { "type": "string", "description": "(Updatable) Parameter name.\n" }, "required": { "type": "boolean", "description": "(Updatable) Determines if the header is required in the request.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "name", "required" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformations": { "properties": { "filterQueryParameters": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters", "description": "(Updatable) Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameQueryParameters": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters", "description": "(Updatable) Rename parameters on the query string as they pass through the gateway.\n" }, "setQueryParameters": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters", "description": "(Updatable) Set parameters on the query string as they pass through the gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "filterQueryParameters", "renameQueryParameters", "setQueryParameters" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParameters": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem" }, "description": "(Updatable) The list of query parameters.\n" }, "type": { "type": "string", "description": "(Updatable) BLOCK drops any query parameters that are in the list of items, so it acts as an exclusion list. ALLOW permits only the parameters in the list and removes all others, so it acts as an inclusion list.\n" } }, "type": "object", "required": [ "items", "type" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsFilterQueryParametersItem": { "properties": { "name": { "type": "string", "description": "(Updatable) The case-sensitive name of the query parameter.\n" } }, "type": "object", "required": [ "name" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParameters": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem" }, "description": "(Updatable) The list of query parameters.\n" } }, "type": "object", "required": [ "items" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsRenameQueryParametersItem": { "properties": { "from": { "type": "string", "description": "(Updatable) The original case-sensitive name of the query parameter. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "(Updatable) The new name of the query parameter. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParameters": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem" }, "description": "(Updatable) The list of query parameters.\n" } }, "type": "object", "required": [ "items" ] }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem:DeploymentSpecificationRouteRequestPoliciesQueryParameterTransformationsSetQueryParametersItem": { "properties": { "ifExists": { "type": "string", "description": "(Updatable) If a query parameter with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "(Updatable) The case-sensitive name of the query parameter. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "name", "values" ], "language": { "nodejs": { "requiredOutputs": [ "ifExists", "name", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations:DeploymentSpecificationRouteRequestPoliciesQueryParameterValidations": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter:DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter" }, "description": "(Updatable) The List of Query Parameters\n" }, "validationMode": { "type": "string", "description": "(Updatable) Validation behavior mode.\n\nIn `ENFORCING` mode, upon a validation failure, the request will be rejected with a 4xx response and not sent to the backend.\n\nIn `PERMISSIVE` mode, the result of the validation will be exposed as metrics while the request will follow the normal path.\n\n`DISABLED` type turns the validation off.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "parameters", "validationMode" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter:DeploymentSpecificationRouteRequestPoliciesQueryParameterValidationsParameter": { "properties": { "name": { "type": "string", "description": "(Updatable) Parameter name.\n" }, "required": { "type": "boolean", "description": "(Updatable) Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "name", "required" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup:DeploymentSpecificationRouteRequestPoliciesResponseCacheLookup": { "properties": { "cacheKeyAdditions": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.\n" }, "isEnabled": { "type": "boolean", "description": "(Updatable) Whether this policy is currently enabled.\n" }, "isPrivateCachingEnabled": { "type": "boolean", "description": "(Updatable) Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.\n\nWhen false, any request with an Authorization header will not be stored in the Response Cache.\n\nIf using the CustomAuthenticationPolicy then the tokenHeader/tokenQueryParam are also subject to this check.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "cacheKeyAdditions", "isEnabled", "isPrivateCachingEnabled", "type" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePolicies:DeploymentSpecificationRouteResponsePolicies": { "properties": { "headerTransformations": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformations:DeploymentSpecificationRouteResponsePoliciesHeaderTransformations", "description": "(Updatable) A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseCacheStore": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesResponseCacheStore:DeploymentSpecificationRouteResponsePoliciesResponseCacheStore", "description": "(Updatable) Base policy for how a response from a backend is cached in the Response Cache.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "headerTransformations", "responseCacheStore" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformations:DeploymentSpecificationRouteResponsePoliciesHeaderTransformations": { "properties": { "filterHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders", "description": "(Updatable) Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders", "description": "(Updatable) Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders", "description": "(Updatable) Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "filterHeaders", "renameHeaders", "setHeaders" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem" }, "description": "(Updatable) The list of headers.\n" }, "type": { "type": "string", "description": "(Updatable) BLOCK drops any headers that are in the list of items, so it acts as an exclusion list. ALLOW permits only the headers in the list and removes all others, so it acts as an inclusion list.\n" } }, "type": "object", "required": [ "items", "type" ] }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsFilterHeadersItem": { "properties": { "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ] }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "required": [ "items" ] }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsRenameHeadersItem": { "properties": { "from": { "type": "string", "description": "(Updatable) The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "(Updatable) The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ] }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeaders": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem" }, "description": "(Updatable) The list of headers.\n" } }, "type": "object", "required": [ "items" ] }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem:DeploymentSpecificationRouteResponsePoliciesHeaderTransformationsSetHeadersItem": { "properties": { "ifExists": { "type": "string", "description": "(Updatable) If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "(Updatable) The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "name", "values" ], "language": { "nodejs": { "requiredOutputs": [ "ifExists", "name", "values" ] } } }, "oci:ApiGateway/DeploymentSpecificationRouteResponsePoliciesResponseCacheStore:DeploymentSpecificationRouteResponsePoliciesResponseCacheStore": { "properties": { "timeToLiveInSeconds": { "type": "integer", "description": "(Updatable) Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Response Cache Store Policy.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "timeToLiveInSeconds", "type" ] }, "oci:ApiGateway/GatewayCaBundle:GatewayCaBundle": { "properties": { "caBundleId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "certificateAuthorityId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the CA bundle\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "caBundleId", "certificateAuthorityId", "type" ] } } }, "oci:ApiGateway/GatewayIpAddress:GatewayIpAddress": { "properties": { "ipAddress": { "type": "string", "description": "An IP address.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipAddress" ] } } }, "oci:ApiGateway/GatewayIpv4addressConfiguration:GatewayIpv4addressConfiguration": { "properties": { "reservedIpIds": { "type": "array", "items": { "type": "string" }, "description": "List of Reserved IP OCIDs created in VCN service.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "reservedIpIds" ] } } }, "oci:ApiGateway/GatewayIpv6addressConfiguration:GatewayIpv6addressConfiguration": { "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 addresses that will be assigned to the gateway during creation.\n", "willReplaceOnChanges": true }, "subnetCidrs": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addresses", "subnetCidrs" ] } } }, "oci:ApiGateway/GatewayLock:GatewayLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:ApiGateway/GatewayResponseCacheDetails:GatewayResponseCacheDetails": { "properties": { "authenticationSecretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "authenticationSecretVersionNumber": { "type": "string", "description": "(Updatable) The version number of the authentication secret to use.\n" }, "connectTimeoutInMs": { "type": "integer", "description": "(Updatable) Defines the timeout for establishing a connection with the Response Cache.\n" }, "isSslEnabled": { "type": "boolean", "description": "(Updatable) Defines if the connection should be over SSL.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "(Updatable) Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInMs": { "type": "integer", "description": "(Updatable) Defines the timeout for reading data from the Response Cache.\n" }, "sendTimeoutInMs": { "type": "integer", "description": "(Updatable) Defines the timeout for transmitting data to the Response Cache.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/GatewayResponseCacheDetailsServer:GatewayResponseCacheDetailsServer" }, "description": "(Updatable) The set of cache store members to connect to. At present only a single server is supported.\n" }, "type": { "type": "string", "description": "(Updatable) Type of the Response Cache.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "authenticationSecretId", "authenticationSecretVersionNumber", "connectTimeoutInMs", "isSslEnabled", "isSslVerifyDisabled", "readTimeoutInMs", "sendTimeoutInMs", "servers", "type" ] } } }, "oci:ApiGateway/GatewayResponseCacheDetailsServer:GatewayResponseCacheDetailsServer": { "properties": { "host": { "type": "string", "description": "(Updatable) Hostname or IP address (IPv4 only) where the cache store is running.\n" }, "port": { "type": "integer", "description": "(Updatable) The port the cache store is exposed on.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "host", "port" ] } } }, "oci:ApiGateway/SubscriberClient:SubscriberClient": { "properties": { "name": { "type": "string", "description": "(Updatable) The name of the client. Must be unique within a subscriber.\n" }, "token": { "type": "string", "description": "(Updatable) The token for the client. Must be unique within a tenancy.\n" } }, "type": "object", "required": [ "name", "token" ] }, "oci:ApiGateway/SubscriberLock:SubscriberLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:ApiGateway/UsagePlanEntitlement:UsagePlanEntitlement": { "properties": { "description": { "type": "string", "description": "(Updatable) A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.\n" }, "name": { "type": "string", "description": "(Updatable) An entitlement name, unique within a usage plan.\n" }, "quota": { "$ref": "#/types/oci:ApiGateway/UsagePlanEntitlementQuota:UsagePlanEntitlementQuota", "description": "(Updatable) Quota policy for a usage plan.\n" }, "rateLimit": { "$ref": "#/types/oci:ApiGateway/UsagePlanEntitlementRateLimit:UsagePlanEntitlementRateLimit", "description": "(Updatable) Rate-limiting policy for a usage plan.\n" }, "targets": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/UsagePlanEntitlementTarget:UsagePlanEntitlementTarget" }, "description": "(Updatable) A collection of targeted deployments that the entitlement will be applied to.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "description", "name", "quota", "rateLimit", "targets" ] } } }, "oci:ApiGateway/UsagePlanEntitlementQuota:UsagePlanEntitlementQuota": { "properties": { "operationOnBreach": { "type": "string", "description": "(Updatable) What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests\n" }, "resetPolicy": { "type": "string", "description": "(Updatable) The policy that controls when quotas will reset. Example: `CALENDAR`\n" }, "unit": { "type": "string", "description": "(Updatable) The unit of time over which quotas are calculated. Example: `MINUTE` or `MONTH`\n" }, "value": { "type": "integer", "description": "(Updatable) The number of requests that can be made per time period.\n" } }, "type": "object", "required": [ "operationOnBreach", "resetPolicy", "unit", "value" ] }, "oci:ApiGateway/UsagePlanEntitlementRateLimit:UsagePlanEntitlementRateLimit": { "properties": { "unit": { "type": "string", "description": "(Updatable) The unit of time over which rate limits are calculated. Example: `SECOND`\n" }, "value": { "type": "integer", "description": "(Updatable) The number of requests that can be made per time period.\n" } }, "type": "object", "required": [ "unit", "value" ] }, "oci:ApiGateway/UsagePlanEntitlementTarget:UsagePlanEntitlementTarget": { "properties": { "deploymentId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a deployment resource.\n" } }, "type": "object", "required": [ "deploymentId" ] }, "oci:ApiGateway/UsagePlanLock:UsagePlanLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "message", "relatedResourceId", "timeCreated", "type" ] } } }, "oci:ApiGateway/getApiDeploymentSpecificationLoggingPolicy:getApiDeploymentSpecificationLoggingPolicy": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationLoggingPolicyAccessLog:getApiDeploymentSpecificationLoggingPolicyAccessLog" }, "description": "Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationLoggingPolicyExecutionLog:getApiDeploymentSpecificationLoggingPolicyExecutionLog" }, "description": "Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "required": [ "accessLogs", "executionLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationLoggingPolicyAccessLog:getApiDeploymentSpecificationLoggingPolicyAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationLoggingPolicyExecutionLog:getApiDeploymentSpecificationLoggingPolicyExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "logLevel": { "type": "string", "description": "Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "required": [ "isEnabled", "logLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicy:getApiDeploymentSpecificationRequestPolicy": { "properties": { "authentications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthentication:getApiDeploymentSpecificationRequestPolicyAuthentication" }, "description": "Information on how to authenticate incoming requests.\n" }, "cors": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyCor:getApiDeploymentSpecificationRequestPolicyCor" }, "description": "Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "dynamicAuthentications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthentication:getApiDeploymentSpecificationRequestPolicyDynamicAuthentication" }, "description": "Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.\n" }, "mutualTls": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyMutualTl:getApiDeploymentSpecificationRequestPolicyMutualTl" }, "description": "Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.\n" }, "rateLimitings": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyRateLimiting:getApiDeploymentSpecificationRequestPolicyRateLimiting" }, "description": "Limit the number of requests that should be handled for the specified window using a specfic key.\n" }, "usagePlans": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyUsagePlan:getApiDeploymentSpecificationRequestPolicyUsagePlan" }, "description": "Usage plan policies for this deployment\n" } }, "type": "object", "required": [ "authentications", "cors", "dynamicAuthentications", "mutualTls", "rateLimitings", "usagePlans" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthentication:getApiDeploymentSpecificationRequestPolicyAuthentication": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The List of Query Parameters\n" }, "publicKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey:getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey" }, "description": "A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "validationFailurePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy" }, "description": "Policy for defining behaviour on validation failure.\n" }, "validationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy" }, "description": "Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim:getApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicies", "validationPolicies", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey:getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKey": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey:getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey:getApiDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy": { "properties": { "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail" }, "description": "Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "HTTP response message.\n" }, "responseType": { "type": "string", "description": "Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of scopes.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy": { "properties": { "additionalValidationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy" }, "description": "Additional JWT validation checks.\n" }, "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail" }, "description": "Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "additionalValidationPolicies", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "issuers", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim:getApiDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyCor:getApiDeploymentSpecificationRequestPolicyCor": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthentication:getApiDeploymentSpecificationRequestPolicyDynamicAuthentication": { "properties": { "authenticationServers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer" }, "description": "List of authentication servers to choose from during dynamic authentication.\n" }, "selectionSources": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource" }, "description": "Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" } }, "type": "object", "required": [ "authenticationServers", "selectionSources" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer": { "properties": { "authenticationServerDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail" }, "description": "Information on how to authenticate incoming requests.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey" }, "description": "Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "required": [ "authenticationServerDetails", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The List of Query Parameters\n" }, "publicKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey" }, "description": "A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "validationFailurePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy" }, "description": "Policy for defining behaviour on validation failure.\n" }, "validationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy" }, "description": "Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicies", "validationPolicies", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy": { "properties": { "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail" }, "description": "Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "HTTP response message.\n" }, "responseType": { "type": "string", "description": "Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of scopes.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy": { "properties": { "additionalValidationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy" }, "description": "Additional JWT validation checks.\n" }, "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail" }, "description": "Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "additionalValidationPolicies", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "issuers", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey": { "properties": { "expression": { "type": "string", "description": "String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "expression", "isDefault", "name", "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource:getApiDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource": { "properties": { "selector": { "type": "string", "description": "String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "selector", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyMutualTl:getApiDeploymentSpecificationRequestPolicyMutualTl": { "properties": { "allowedSans": { "type": "array", "items": { "type": "string" }, "description": "Allowed list of CN or SAN which will be used for verification of certificate.\n" }, "isVerifiedCertificateRequired": { "type": "boolean", "description": "Determines whether to enable client verification when API Consumer makes connection to the gateway.\n" } }, "type": "object", "required": [ "allowedSans", "isVerifiedCertificateRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyRateLimiting:getApiDeploymentSpecificationRequestPolicyRateLimiting": { "properties": { "rateInRequestsPerSecond": { "type": "integer", "description": "The maximum number of requests per second to allow.\n" }, "rateKey": { "type": "string", "description": "The key used to group requests together.\n" } }, "type": "object", "required": [ "rateInRequestsPerSecond", "rateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRequestPolicyUsagePlan:getApiDeploymentSpecificationRequestPolicyUsagePlan": { "properties": { "tokenLocations": { "type": "array", "items": { "type": "string" }, "description": "A list of context variables specifying where API tokens may be located in a request. Example locations:\n* \"request.headers[token]\"\n* \"request.query[token]\"\n* \"request.auth[Token]\"\n* \"request.path[TOKEN]\"\n" } }, "type": "object", "required": [ "tokenLocations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRoute:getApiDeploymentSpecificationRoute": { "properties": { "backends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackend:getApiDeploymentSpecificationRouteBackend" }, "description": "The backend to forward requests to.\n" }, "loggingPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteLoggingPolicy:getApiDeploymentSpecificationRouteLoggingPolicy" }, "description": "Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "methods": { "type": "array", "items": { "type": "string" }, "description": "A list of allowed methods on this route.\n" }, "path": { "type": "string", "description": "A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.\n" }, "requestPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicy:getApiDeploymentSpecificationRouteRequestPolicy" }, "description": "Behavior applied to any requests received by the API on this route.\n" }, "responsePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicy:getApiDeploymentSpecificationRouteResponsePolicy" }, "description": "Behavior applied to any responses sent by the API for requests on this route.\n" } }, "type": "object", "required": [ "backends", "loggingPolicies", "methods", "path", "requestPolicies", "responsePolicies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackend:getApiDeploymentSpecificationRouteBackend": { "properties": { "allowedPostLogoutUris": { "type": "array", "items": { "type": "string" }, "description": "A list of allowed post-logout URLs to which a request can be redirected after revoke access\n" }, "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackendHeader:getApiDeploymentSpecificationRouteBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "postLogoutState": { "type": "string", "description": "Defines a state that should be shared on redirecting to postLogout URL.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "routingBackends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackend:getApiDeploymentSpecificationRouteBackendRoutingBackend" }, "description": "List of backends to chose from for Dynamic Routing.\n" }, "selectionSources": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackendSelectionSource:getApiDeploymentSpecificationRouteBackendSelectionSource" }, "description": "Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "allowedPostLogoutUris", "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "postLogoutState", "readTimeoutInSeconds", "routingBackends", "selectionSources", "sendTimeoutInSeconds", "status", "type", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackendHeader:getApiDeploymentSpecificationRouteBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackend:getApiDeploymentSpecificationRouteBackendRoutingBackend": { "properties": { "backends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackendBackend:getApiDeploymentSpecificationRouteBackendRoutingBackendBackend" }, "description": "The backend to forward requests to.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackendKey:getApiDeploymentSpecificationRouteBackendRoutingBackendKey" }, "description": "Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "required": [ "backends", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackendBackend:getApiDeploymentSpecificationRouteBackendRoutingBackendBackend": { "properties": { "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackendBackendHeader:getApiDeploymentSpecificationRouteBackendRoutingBackendBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "readTimeoutInSeconds", "sendTimeoutInSeconds", "status", "type", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackendBackendHeader:getApiDeploymentSpecificationRouteBackendRoutingBackendBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackendRoutingBackendKey:getApiDeploymentSpecificationRouteBackendRoutingBackendKey": { "properties": { "expression": { "type": "string", "description": "String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "expression", "isDefault", "name", "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteBackendSelectionSource:getApiDeploymentSpecificationRouteBackendSelectionSource": { "properties": { "selector": { "type": "string", "description": "String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "selector", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteLoggingPolicy:getApiDeploymentSpecificationRouteLoggingPolicy": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteLoggingPolicyAccessLog:getApiDeploymentSpecificationRouteLoggingPolicyAccessLog" }, "description": "Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteLoggingPolicyExecutionLog:getApiDeploymentSpecificationRouteLoggingPolicyExecutionLog" }, "description": "Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "required": [ "accessLogs", "executionLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteLoggingPolicyAccessLog:getApiDeploymentSpecificationRouteLoggingPolicyAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteLoggingPolicyExecutionLog:getApiDeploymentSpecificationRouteLoggingPolicyExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "logLevel": { "type": "string", "description": "Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "required": [ "isEnabled", "logLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicy:getApiDeploymentSpecificationRouteRequestPolicy": { "properties": { "authorizations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyAuthorization:getApiDeploymentSpecificationRouteRequestPolicyAuthorization" }, "description": "If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.\n" }, "bodyValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyBodyValidation:getApiDeploymentSpecificationRouteRequestPolicyBodyValidation" }, "description": "Validate the payload body of the incoming API requests on a specific route.\n" }, "cors": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyCor:getApiDeploymentSpecificationRouteRequestPolicyCor" }, "description": "Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "headerTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "headerValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderValidation:getApiDeploymentSpecificationRouteRequestPolicyHeaderValidation" }, "description": "Validate the HTTP headers on the incoming API requests on a specific route.\n" }, "queryParameterTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation" }, "description": "A set of transformations to apply to query parameters that pass through the gateway.\n" }, "queryParameterValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation" }, "description": "Validate the URL query parameters on the incoming API requests on a specific route.\n" }, "responseCacheLookups": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup:getApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup" }, "description": "Base policy for Response Cache lookup.\n" } }, "type": "object", "required": [ "authorizations", "bodyValidations", "cors", "headerTransformations", "headerValidations", "queryParameterTransformations", "queryParameterValidations", "responseCacheLookups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyAuthorization:getApiDeploymentSpecificationRouteRequestPolicyAuthorization": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "allowedScopes", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyBodyValidation:getApiDeploymentSpecificationRouteRequestPolicyBodyValidation": { "properties": { "contents": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent:getApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent" }, "description": "The content of the request body.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "contents", "required", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent:getApiDeploymentSpecificationRouteRequestPolicyBodyValidationContent": { "properties": { "mediaType": { "type": "string", "description": "The media type is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema\n" }, "validationType": { "type": "string", "description": "Validation type defines the content validation method.\n" } }, "type": "object", "required": [ "mediaType", "validationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyCor:getApiDeploymentSpecificationRouteRequestPolicyCor": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderValidation:getApiDeploymentSpecificationRouteRequestPolicyHeaderValidation": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader" }, "description": "The List of Headers\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "headers", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader:getApiDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name", "required" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation": { "properties": { "filterQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter" }, "description": "Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter" }, "description": "Rename parameters on the query string as they pass through the gateway.\n" }, "setQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter" }, "description": "Set parameters on the query string as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterQueryParameters", "renameQueryParameters", "setQueryParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidation": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter" }, "description": "The List of Query Parameters\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "parameters", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter:getApiDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name", "required" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup:getApiDeploymentSpecificationRouteRequestPolicyResponseCacheLookup": { "properties": { "cacheKeyAdditions": { "type": "array", "items": { "type": "string" }, "description": "A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.\n" }, "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "isPrivateCachingEnabled": { "type": "boolean", "description": "Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "cacheKeyAdditions", "isEnabled", "isPrivateCachingEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicy:getApiDeploymentSpecificationRouteResponsePolicy": { "properties": { "headerTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseCacheStores": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore:getApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore" }, "description": "Base policy for how a response from a backend is cached in the Response Cache.\n" } }, "type": "object", "required": [ "headerTransformations", "responseCacheStores" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem:getApiDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore:getApiDeploymentSpecificationRouteResponsePolicyResponseCacheStore": { "properties": { "timeToLiveInSeconds": { "type": "integer", "description": "Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "timeToLiveInSeconds", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiLock:getApiLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiValidationResult:getApiValidationResult": { "properties": { "name": { "type": "string", "description": "Name of the validation.\n" }, "result": { "type": "string", "description": "Result of the validation.\n" } }, "type": "object", "required": [ "name", "result" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiValidationValidation:getApiValidationValidation": { "properties": { "details": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiValidationValidationDetail:getApiValidationValidationDetail" }, "description": "Details of validation.\n" }, "name": { "type": "string", "description": "Name of the validation.\n" }, "result": { "type": "string", "description": "Result of the validation.\n" } }, "type": "object", "required": [ "details", "name", "result" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiValidationValidationDetail:getApiValidationValidationDetail": { "properties": { "msg": { "type": "string", "description": "Description of the warning/error.\n" }, "severity": { "type": "string", "description": "Severity of the issue.\n" }, "srcs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApiValidationValidationDetailSrc:getApiValidationValidationDetailSrc" }, "description": "Position of the issue in the specification file (line, column).\n" } }, "type": "object", "required": [ "msg", "severity", "srcs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApiValidationValidationDetailSrc:getApiValidationValidationDetailSrc": { "properties": { "items": { "type": "array", "items": { "$ref": "pulumi.json#/Any" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApisApiCollection:getApisApiCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApisApiCollectionItem:getApisApiCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApisApiCollectionItem:getApisApiCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment in which to list resources.\n" }, "content": { "type": "string" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "isLockOverride": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:\n* 'New' for just updated API Specifications\n* 'Validating' for a document which is being validated.\n* 'Valid' the document has been validated without any errors or warnings\n* 'Warning' the document has been validated and contains warnings\n* 'Error' the document has been validated and contains errors\n* 'Failed' the document validation failed\n* 'Canceled' the document validation was canceled\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApisApiCollectionItemLock:getApisApiCollectionItemLock" }, "description": "Locks associated with this resource.\n" }, "specificationType": { "type": "string", "description": "Type of API Specification file.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state. Example: `ACTIVE`\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time this resource was last updated. An RFC3339 formatted datetime string.\n" }, "validationResults": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getApisApiCollectionItemValidationResult:getApisApiCollectionItemValidationResult" }, "description": "Status of each feature available from the API.\n" } }, "type": "object", "required": [ "compartmentId", "content", "definedTags", "displayName", "freeformTags", "id", "isLockOverride", "lifecycleDetails", "locks", "specificationType", "state", "systemTags", "timeCreated", "timeUpdated", "validationResults" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApisApiCollectionItemLock:getApisApiCollectionItemLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApisApiCollectionItemValidationResult:getApisApiCollectionItemValidationResult": { "properties": { "name": { "type": "string", "description": "Name of the validation.\n" }, "result": { "type": "string", "description": "Result of the validation.\n" } }, "type": "object", "required": [ "name", "result" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getApisFilter:getApisFilter": { "properties": { "name": { "type": "string", "description": "Name of the validation.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApiGateway/getCertificateLock:getCertificateLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getCertificatesCertificateCollection:getCertificatesCertificateCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getCertificatesCertificateCollectionItem:getCertificatesCertificateCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getCertificatesCertificateCollectionItem:getCertificatesCertificateCollectionItem": { "properties": { "certificate": { "type": "string", "description": "The data of the leaf certificate in pem format.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "intermediateCertificates": { "type": "string", "description": "The intermediate certificate data associated with the certificate in pem format.\n" }, "isLockOverride": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getCertificatesCertificateCollectionItemLock:getCertificatesCertificateCollectionItemLock" }, "description": "Locks associated with this resource.\n" }, "privateKey": { "type": "string", "secret": true }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state. Example: `ACTIVE` or `DELETED`\n" }, "subjectNames": { "type": "array", "items": { "type": "string" }, "description": "The entity to be secured by the certificate and additional host names.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "timeNotValidAfter": { "type": "string", "description": "The date and time the certificate will expire.\n" }, "timeUpdated": { "type": "string", "description": "The time this resource was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "certificate", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "intermediateCertificates", "isLockOverride", "lifecycleDetails", "locks", "privateKey", "state", "subjectNames", "systemTags", "timeCreated", "timeNotValidAfter", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getCertificatesCertificateCollectionItemLock:getCertificatesCertificateCollectionItemLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getCertificatesFilter:getCertificatesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApiGateway/getDeploymentLock:getDeploymentLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecification:getDeploymentSpecification": { "properties": { "loggingPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationLoggingPolicy:getDeploymentSpecificationLoggingPolicy" }, "description": "Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "requestPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicy:getDeploymentSpecificationRequestPolicy" }, "description": "Behavior applied to any requests received by the API on this route.\n" }, "routes": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRoute:getDeploymentSpecificationRoute" }, "description": "A list of routes that this API exposes.\n" } }, "type": "object", "required": [ "loggingPolicies", "requestPolicies", "routes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationLoggingPolicy:getDeploymentSpecificationLoggingPolicy": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationLoggingPolicyAccessLog:getDeploymentSpecificationLoggingPolicyAccessLog" }, "description": "Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationLoggingPolicyExecutionLog:getDeploymentSpecificationLoggingPolicyExecutionLog" }, "description": "Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "required": [ "accessLogs", "executionLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationLoggingPolicyAccessLog:getDeploymentSpecificationLoggingPolicyAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationLoggingPolicyExecutionLog:getDeploymentSpecificationLoggingPolicyExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "logLevel": { "type": "string", "description": "Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "required": [ "isEnabled", "logLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicy:getDeploymentSpecificationRequestPolicy": { "properties": { "authentications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthentication:getDeploymentSpecificationRequestPolicyAuthentication" }, "description": "Information on how to authenticate incoming requests.\n" }, "cors": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyCor:getDeploymentSpecificationRequestPolicyCor" }, "description": "Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "dynamicAuthentications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthentication:getDeploymentSpecificationRequestPolicyDynamicAuthentication" }, "description": "Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.\n" }, "mutualTls": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyMutualTl:getDeploymentSpecificationRequestPolicyMutualTl" }, "description": "Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.\n" }, "rateLimitings": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyRateLimiting:getDeploymentSpecificationRequestPolicyRateLimiting" }, "description": "Limit the number of requests that should be handled for the specified window using a specfic key.\n" }, "usagePlans": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyUsagePlan:getDeploymentSpecificationRequestPolicyUsagePlan" }, "description": "Usage plan policies for this deployment\n" } }, "type": "object", "required": [ "authentications", "cors", "dynamicAuthentications", "mutualTls", "rateLimitings", "usagePlans" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthentication:getDeploymentSpecificationRequestPolicyAuthentication": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The List of Query Parameters\n" }, "publicKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationPublicKey:getDeploymentSpecificationRequestPolicyAuthenticationPublicKey" }, "description": "A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "validationFailurePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy" }, "description": "Policy for defining behaviour on validation failure.\n" }, "validationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy" }, "description": "Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim:getDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicies", "validationPolicies", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationPublicKey:getDeploymentSpecificationRequestPolicyAuthenticationPublicKey": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey:getDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey:getDeploymentSpecificationRequestPolicyAuthenticationPublicKeyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicy": { "properties": { "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail" }, "description": "Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "HTTP response message.\n" }, "responseType": { "type": "string", "description": "Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of scopes.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicy": { "properties": { "additionalValidationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy" }, "description": "Additional JWT validation checks.\n" }, "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail" }, "description": "Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "additionalValidationPolicies", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "issuers", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail:getDeploymentSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim:getDeploymentSpecificationRequestPolicyAuthenticationVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyCor:getDeploymentSpecificationRequestPolicyCor": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthentication:getDeploymentSpecificationRequestPolicyDynamicAuthentication": { "properties": { "authenticationServers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer" }, "description": "List of authentication servers to choose from during dynamic authentication.\n" }, "selectionSources": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource:getDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource" }, "description": "Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" } }, "type": "object", "required": [ "authenticationServers", "selectionSources" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer": { "properties": { "authenticationServerDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail" }, "description": "Information on how to authenticate incoming requests.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey" }, "description": "Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "required": [ "authenticationServerDetails", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The List of Query Parameters\n" }, "publicKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey" }, "description": "A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "validationFailurePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy" }, "description": "Policy for defining behaviour on validation failure.\n" }, "validationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy" }, "description": "Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicies", "validationPolicies", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy": { "properties": { "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail" }, "description": "Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "HTTP response message.\n" }, "responseType": { "type": "string", "description": "Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of scopes.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy": { "properties": { "additionalValidationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy" }, "description": "Additional JWT validation checks.\n" }, "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail" }, "description": "Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "additionalValidationPolicies", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "issuers", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey:getDeploymentSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey": { "properties": { "expression": { "type": "string", "description": "String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "expression", "isDefault", "name", "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource:getDeploymentSpecificationRequestPolicyDynamicAuthenticationSelectionSource": { "properties": { "selector": { "type": "string", "description": "String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "selector", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyMutualTl:getDeploymentSpecificationRequestPolicyMutualTl": { "properties": { "allowedSans": { "type": "array", "items": { "type": "string" }, "description": "Allowed list of CN or SAN which will be used for verification of certificate.\n" }, "isVerifiedCertificateRequired": { "type": "boolean", "description": "Determines whether to enable client verification when API Consumer makes connection to the gateway.\n" } }, "type": "object", "required": [ "allowedSans", "isVerifiedCertificateRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyRateLimiting:getDeploymentSpecificationRequestPolicyRateLimiting": { "properties": { "rateInRequestsPerSecond": { "type": "integer", "description": "The maximum number of requests per second to allow.\n" }, "rateKey": { "type": "string", "description": "The key used to group requests together.\n" } }, "type": "object", "required": [ "rateInRequestsPerSecond", "rateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRequestPolicyUsagePlan:getDeploymentSpecificationRequestPolicyUsagePlan": { "properties": { "tokenLocations": { "type": "array", "items": { "type": "string" }, "description": "A list of context variables specifying where API tokens may be located in a request. Example locations:\n* \"request.headers[token]\"\n* \"request.query[token]\"\n* \"request.auth[Token]\"\n* \"request.path[TOKEN]\"\n" } }, "type": "object", "required": [ "tokenLocations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRoute:getDeploymentSpecificationRoute": { "properties": { "backends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackend:getDeploymentSpecificationRouteBackend" }, "description": "The backend to forward requests to.\n" }, "loggingPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteLoggingPolicy:getDeploymentSpecificationRouteLoggingPolicy" }, "description": "Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "methods": { "type": "array", "items": { "type": "string" }, "description": "A list of allowed methods on this route.\n" }, "path": { "type": "string", "description": "A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.\n" }, "requestPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicy:getDeploymentSpecificationRouteRequestPolicy" }, "description": "Behavior applied to any requests received by the API on this route.\n" }, "responsePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicy:getDeploymentSpecificationRouteResponsePolicy" }, "description": "Behavior applied to any responses sent by the API for requests on this route.\n" } }, "type": "object", "required": [ "backends", "loggingPolicies", "methods", "path", "requestPolicies", "responsePolicies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackend:getDeploymentSpecificationRouteBackend": { "properties": { "allowedPostLogoutUris": { "type": "array", "items": { "type": "string" }, "description": "A list of allowed post-logout URLs to which a request can be redirected after revoke access\n" }, "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackendHeader:getDeploymentSpecificationRouteBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "postLogoutState": { "type": "string", "description": "Defines a state that should be shared on redirecting to postLogout URL.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "routingBackends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackend:getDeploymentSpecificationRouteBackendRoutingBackend" }, "description": "List of backends to chose from for Dynamic Routing.\n" }, "selectionSources": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackendSelectionSource:getDeploymentSpecificationRouteBackendSelectionSource" }, "description": "Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "allowedPostLogoutUris", "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "postLogoutState", "readTimeoutInSeconds", "routingBackends", "selectionSources", "sendTimeoutInSeconds", "status", "type", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackendHeader:getDeploymentSpecificationRouteBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackend:getDeploymentSpecificationRouteBackendRoutingBackend": { "properties": { "backends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackendBackend:getDeploymentSpecificationRouteBackendRoutingBackendBackend" }, "description": "The backend to forward requests to.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackendKey:getDeploymentSpecificationRouteBackendRoutingBackendKey" }, "description": "Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "required": [ "backends", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackendBackend:getDeploymentSpecificationRouteBackendRoutingBackendBackend": { "properties": { "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackendBackendHeader:getDeploymentSpecificationRouteBackendRoutingBackendBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "readTimeoutInSeconds", "sendTimeoutInSeconds", "status", "type", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackendBackendHeader:getDeploymentSpecificationRouteBackendRoutingBackendBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackendRoutingBackendKey:getDeploymentSpecificationRouteBackendRoutingBackendKey": { "properties": { "expression": { "type": "string", "description": "String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "expression", "isDefault", "name", "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteBackendSelectionSource:getDeploymentSpecificationRouteBackendSelectionSource": { "properties": { "selector": { "type": "string", "description": "String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "selector", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteLoggingPolicy:getDeploymentSpecificationRouteLoggingPolicy": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteLoggingPolicyAccessLog:getDeploymentSpecificationRouteLoggingPolicyAccessLog" }, "description": "Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteLoggingPolicyExecutionLog:getDeploymentSpecificationRouteLoggingPolicyExecutionLog" }, "description": "Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "required": [ "accessLogs", "executionLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteLoggingPolicyAccessLog:getDeploymentSpecificationRouteLoggingPolicyAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteLoggingPolicyExecutionLog:getDeploymentSpecificationRouteLoggingPolicyExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "logLevel": { "type": "string", "description": "Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "required": [ "isEnabled", "logLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicy:getDeploymentSpecificationRouteRequestPolicy": { "properties": { "authorizations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyAuthorization:getDeploymentSpecificationRouteRequestPolicyAuthorization" }, "description": "If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.\n" }, "bodyValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyBodyValidation:getDeploymentSpecificationRouteRequestPolicyBodyValidation" }, "description": "Validate the payload body of the incoming API requests on a specific route.\n" }, "cors": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyCor:getDeploymentSpecificationRouteRequestPolicyCor" }, "description": "Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "headerTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformation:getDeploymentSpecificationRouteRequestPolicyHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "headerValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderValidation:getDeploymentSpecificationRouteRequestPolicyHeaderValidation" }, "description": "Validate the HTTP headers on the incoming API requests on a specific route.\n" }, "queryParameterTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation" }, "description": "A set of transformations to apply to query parameters that pass through the gateway.\n" }, "queryParameterValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterValidation:getDeploymentSpecificationRouteRequestPolicyQueryParameterValidation" }, "description": "Validate the URL query parameters on the incoming API requests on a specific route.\n" }, "responseCacheLookups": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyResponseCacheLookup:getDeploymentSpecificationRouteRequestPolicyResponseCacheLookup" }, "description": "Base policy for Response Cache lookup.\n" } }, "type": "object", "required": [ "authorizations", "bodyValidations", "cors", "headerTransformations", "headerValidations", "queryParameterTransformations", "queryParameterValidations", "responseCacheLookups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyAuthorization:getDeploymentSpecificationRouteRequestPolicyAuthorization": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "allowedScopes", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyBodyValidation:getDeploymentSpecificationRouteRequestPolicyBodyValidation": { "properties": { "contents": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyBodyValidationContent:getDeploymentSpecificationRouteRequestPolicyBodyValidationContent" }, "description": "The content of the request body.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "contents", "required", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyBodyValidationContent:getDeploymentSpecificationRouteRequestPolicyBodyValidationContent": { "properties": { "mediaType": { "type": "string", "description": "The media type is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema\n" }, "validationType": { "type": "string", "description": "Validation type defines the content validation method.\n" } }, "type": "object", "required": [ "mediaType", "validationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyCor:getDeploymentSpecificationRouteRequestPolicyCor": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformation:getDeploymentSpecificationRouteRequestPolicyHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem:getDeploymentSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderValidation:getDeploymentSpecificationRouteRequestPolicyHeaderValidation": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader:getDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader" }, "description": "The List of Headers\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "headers", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader:getDeploymentSpecificationRouteRequestPolicyHeaderValidationHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name", "required" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformation": { "properties": { "filterQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter" }, "description": "Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter" }, "description": "Rename parameters on the query string as they pass through the gateway.\n" }, "setQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter" }, "description": "Set parameters on the query string as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterQueryParameters", "renameQueryParameters", "setQueryParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem:getDeploymentSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterValidation:getDeploymentSpecificationRouteRequestPolicyQueryParameterValidation": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter" }, "description": "The List of Query Parameters\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "parameters", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter:getDeploymentSpecificationRouteRequestPolicyQueryParameterValidationParameter": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name", "required" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteRequestPolicyResponseCacheLookup:getDeploymentSpecificationRouteRequestPolicyResponseCacheLookup": { "properties": { "cacheKeyAdditions": { "type": "array", "items": { "type": "string" }, "description": "A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.\n" }, "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "isPrivateCachingEnabled": { "type": "boolean", "description": "Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "cacheKeyAdditions", "isEnabled", "isPrivateCachingEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicy:getDeploymentSpecificationRouteResponsePolicy": { "properties": { "headerTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformation:getDeploymentSpecificationRouteResponsePolicyHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseCacheStores": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyResponseCacheStore:getDeploymentSpecificationRouteResponsePolicyResponseCacheStore" }, "description": "Base policy for how a response from a backend is cached in the Response Cache.\n" } }, "type": "object", "required": [ "headerTransformations", "responseCacheStores" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformation:getDeploymentSpecificationRouteResponsePolicyHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem:getDeploymentSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentSpecificationRouteResponsePolicyResponseCacheStore:getDeploymentSpecificationRouteResponsePolicyResponseCacheStore": { "properties": { "timeToLiveInSeconds": { "type": "integer", "description": "Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "timeToLiveInSeconds", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollection:getDeploymentsDeploymentCollection": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "endpoint": { "type": "string", "description": "The endpoint to access this deployment on the gateway.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "gatewayId": { "type": "string", "description": "Filter deployments by the gateway ocid.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "isLockOverride": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionLock:getDeploymentsDeploymentCollectionLock" }, "description": "Locks associated with this resource.\n" }, "pathPrefix": { "type": "string", "description": "A path on which to deploy all routes contained in the API deployment specification. For more information, see [Deploying an API on an API Gateway by Creating an API Deployment](https://docs.cloud.oracle.com/iaas/Content/APIGateway/Tasks/apigatewaycreatingdeployment.htm).\n" }, "specifications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecification:getDeploymentsDeploymentCollectionSpecification" }, "description": "The logical configuration of the API exposed by a deployment.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED`\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time this resource was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "endpoint", "freeformTags", "gatewayId", "id", "isLockOverride", "lifecycleDetails", "locks", "pathPrefix", "specifications", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionLock:getDeploymentsDeploymentCollectionLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecification:getDeploymentsDeploymentCollectionSpecification": { "properties": { "loggingPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationLoggingPolicy:getDeploymentsDeploymentCollectionSpecificationLoggingPolicy" }, "description": "Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "requestPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicy" }, "description": "Behavior applied to any requests received by the API on this route.\n" }, "routes": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRoute:getDeploymentsDeploymentCollectionSpecificationRoute" }, "description": "A list of routes that this API exposes.\n" } }, "type": "object", "required": [ "loggingPolicies", "requestPolicies", "routes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationLoggingPolicy:getDeploymentsDeploymentCollectionSpecificationLoggingPolicy": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationLoggingPolicyAccessLog:getDeploymentsDeploymentCollectionSpecificationLoggingPolicyAccessLog" }, "description": "Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationLoggingPolicyExecutionLog:getDeploymentsDeploymentCollectionSpecificationLoggingPolicyExecutionLog" }, "description": "Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "required": [ "accessLogs", "executionLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationLoggingPolicyAccessLog:getDeploymentsDeploymentCollectionSpecificationLoggingPolicyAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationLoggingPolicyExecutionLog:getDeploymentsDeploymentCollectionSpecificationLoggingPolicyExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "logLevel": { "type": "string", "description": "Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "required": [ "isEnabled", "logLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicy": { "properties": { "authentications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthentication:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthentication" }, "description": "Information on how to authenticate incoming requests.\n" }, "cors": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyCor:getDeploymentsDeploymentCollectionSpecificationRequestPolicyCor" }, "description": "Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "dynamicAuthentications": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthentication:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthentication" }, "description": "Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector specified under selectionSource will be matched against the keys specified for each authentication server. The authentication server whose key matches the value of selector will be used for authentication.\n" }, "mutualTls": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyMutualTl:getDeploymentsDeploymentCollectionSpecificationRequestPolicyMutualTl" }, "description": "Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.\n" }, "rateLimitings": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyRateLimiting:getDeploymentsDeploymentCollectionSpecificationRequestPolicyRateLimiting" }, "description": "Limit the number of requests that should be handled for the specified window using a specfic key.\n" }, "usagePlans": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyUsagePlan:getDeploymentsDeploymentCollectionSpecificationRequestPolicyUsagePlan" }, "description": "Usage plan policies for this deployment\n" } }, "type": "object", "required": [ "authentications", "cors", "dynamicAuthentications", "mutualTls", "rateLimitings", "usagePlans" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthentication:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthentication": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The List of Query Parameters\n" }, "publicKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKey" }, "description": "A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "validationFailurePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicy" }, "description": "Policy for defining behaviour on validation failure.\n" }, "validationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicy" }, "description": "Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicies", "validationPolicies", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKey": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKeyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKeyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKeyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationPublicKeyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicy": { "properties": { "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail" }, "description": "Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "HTTP response message.\n" }, "responseType": { "type": "string", "description": "Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of scopes.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicyResponseHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationFailurePolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicy": { "properties": { "additionalValidationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy" }, "description": "Additional JWT validation checks.\n" }, "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail" }, "description": "Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "additionalValidationPolicies", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "issuers", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationValidationPolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyAuthenticationVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyCor:getDeploymentsDeploymentCollectionSpecificationRequestPolicyCor": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthentication:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthentication": { "properties": { "authenticationServers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer" }, "description": "List of authentication servers to choose from during dynamic authentication.\n" }, "selectionSources": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationSelectionSource:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationSelectionSource" }, "description": "Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" } }, "type": "object", "required": [ "authenticationServers", "selectionSources" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServer": { "properties": { "authenticationServerDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail" }, "description": "Information on how to authenticate incoming requests.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey" }, "description": "Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "required": [ "authenticationServerDetails", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetail": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "cacheKeys": { "type": "array", "items": { "type": "string" }, "description": "A list of keys from \"parameters\" attribute value whose values will be added to the cache key.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "isAnonymousAccessAllowed": { "type": "boolean", "description": "Whether an unauthenticated user may access the API. Must be \"true\" to enable ANONYMOUS route authorization.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "maxClockSkewInSeconds": { "type": "number", "description": "The maximum expected time difference between the system clocks of the token issuer and the API Gateway.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The List of Query Parameters\n" }, "publicKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey" }, "description": "A set of Public Keys that will be used to verify the JWT signature.\n" }, "tokenAuthScheme": { "type": "string", "description": "The authentication scheme that is to be used when authenticating the token. This must to be provided if \"tokenHeader\" is specified.\n" }, "tokenHeader": { "type": "string", "description": "The name of the header containing the authentication token.\n" }, "tokenQueryParam": { "type": "string", "description": "The name of the query parameter containing the authentication token.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "validationFailurePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy" }, "description": "Policy for defining behaviour on validation failure.\n" }, "validationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy" }, "description": "Authentication Policies for the Token Authentication types.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "cacheKeys", "functionId", "isAnonymousAccessAllowed", "issuers", "maxClockSkewInSeconds", "parameters", "publicKeys", "tokenAuthScheme", "tokenHeader", "tokenQueryParam", "type", "validationFailurePolicies", "validationPolicies", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKey": { "properties": { "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailPublicKeyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicy": { "properties": { "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail" }, "description": "Client App Credential details.\n" }, "fallbackRedirectPath": { "type": "string", "description": "The path to be used as fallback after OAuth2.\n" }, "loginPath": { "type": "string", "description": "The path (relative to the deployment) where the Identity Provider will redirect the user after authentication. This path must match a route in the specification that uses the OAUTH2_LOGIN_BACKEND.\n" }, "logoutPath": { "type": "string", "description": "The path to be used as logout.\n" }, "maxExpiryDurationInHours": { "type": "integer", "description": "The duration for which the OAuth2 success token should be cached before it is fetched again.\n" }, "responseCode": { "type": "string", "description": "HTTP response code, can include context variables.\n" }, "responseHeaderTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseMessage": { "type": "string", "description": "HTTP response message.\n" }, "responseType": { "type": "string", "description": "Response Type.\n" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of scopes.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "useCookiesForIntermediateSteps": { "type": "boolean", "description": "Defines whether or not to use cookies for OAuth2 intermediate steps.\n" }, "useCookiesForSession": { "type": "boolean", "description": "Defines whether or not to use cookies for session maintenance.\n" }, "usePkce": { "type": "boolean", "description": "Defines whether or not to support PKCE.\n" } }, "type": "object", "required": [ "clientDetails", "fallbackRedirectPath", "loginPath", "logoutPath", "maxExpiryDurationInHours", "responseCode", "responseHeaderTransformations", "responseMessage", "responseType", "scopes", "sourceUriDetails", "type", "useCookiesForIntermediateSteps", "useCookiesForSession", "usePkce" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicyResponseHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationFailurePolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicy": { "properties": { "additionalValidationPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy" }, "description": "Additional JWT validation checks.\n" }, "clientDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail" }, "description": "Client App Credential details.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey" }, "description": "The set of static public keys.\n" }, "maxCacheDurationInHours": { "type": "integer", "description": "The duration for which the introspect URL response should be cached before it is fetched again.\n" }, "sourceUriDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail" }, "description": "Auth endpoint details.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "additionalValidationPolicies", "clientDetails", "isSslVerifyDisabled", "keys", "maxCacheDurationInHours", "sourceUriDetails", "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicy": { "properties": { "audiences": { "type": "array", "items": { "type": "string" }, "description": "The list of intended recipients for the token.\n" }, "issuers": { "type": "array", "items": { "type": "string" }, "description": "A list of parties that could have issued the token.\n" }, "verifyClaims": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim" }, "description": "A list of claims which should be validated to consider the token valid.\n" } }, "type": "object", "required": [ "audiences", "issuers", "verifyClaims" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyAdditionalValidationPolicyVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyClientDetail": { "properties": { "clientId": { "type": "string", "description": "Client ID for the OAuth2/OIDC app.\n" }, "clientSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "clientSecretVersionNumber": { "type": "string", "description": "The version number of the client secret to use.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "clientId", "clientSecretId", "clientSecretVersionNumber", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicyKey": { "properties": { "alg": { "type": "string", "description": "The algorithm intended for use with this key.\n" }, "e": { "type": "string", "description": "The base64 url encoded exponent of the RSA public key represented by this key.\n" }, "format": { "type": "string", "description": "The format of the public key.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "keyOps": { "type": "array", "items": { "type": "string" }, "description": "The operations for which this key is to be used.\n" }, "kid": { "type": "string", "description": "A unique key ID. This key will be used to verify the signature of a JWT with matching \"kid\".\n" }, "kty": { "type": "string", "description": "The key type.\n" }, "n": { "type": "string", "description": "The base64 url encoded modulus of the RSA public key represented by this key.\n" }, "use": { "type": "string", "description": "The intended use of the public key.\n" } }, "type": "object", "required": [ "alg", "e", "format", "key", "keyOps", "kid", "kty", "n", "use" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailValidationPolicySourceUriDetail": { "properties": { "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "uri": { "type": "string", "description": "The uri from which to retrieve the key. It must be accessible without authentication.\n" } }, "type": "object", "required": [ "type", "uri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerAuthenticationServerDetailVerifyClaim": { "properties": { "isRequired": { "type": "boolean", "description": "Whether the claim is required to be present in the JWT or not. If set to \"false\", the claim values will be matched only if the claim is present in the JWT.\n" }, "key": { "type": "string", "description": "Information around the values for selector of an authentication/ routing branch.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "isRequired", "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationAuthenticationServerKey": { "properties": { "expression": { "type": "string", "description": "String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "expression", "isDefault", "name", "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationSelectionSource:getDeploymentsDeploymentCollectionSpecificationRequestPolicyDynamicAuthenticationSelectionSource": { "properties": { "selector": { "type": "string", "description": "String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "selector", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyMutualTl:getDeploymentsDeploymentCollectionSpecificationRequestPolicyMutualTl": { "properties": { "allowedSans": { "type": "array", "items": { "type": "string" }, "description": "Allowed list of CN or SAN which will be used for verification of certificate.\n" }, "isVerifiedCertificateRequired": { "type": "boolean", "description": "Determines whether to enable client verification when API Consumer makes connection to the gateway.\n" } }, "type": "object", "required": [ "allowedSans", "isVerifiedCertificateRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyRateLimiting:getDeploymentsDeploymentCollectionSpecificationRequestPolicyRateLimiting": { "properties": { "rateInRequestsPerSecond": { "type": "integer", "description": "The maximum number of requests per second to allow.\n" }, "rateKey": { "type": "string", "description": "The key used to group requests together.\n" } }, "type": "object", "required": [ "rateInRequestsPerSecond", "rateKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRequestPolicyUsagePlan:getDeploymentsDeploymentCollectionSpecificationRequestPolicyUsagePlan": { "properties": { "tokenLocations": { "type": "array", "items": { "type": "string" }, "description": "A list of context variables specifying where API tokens may be located in a request. Example locations:\n* \"request.headers[token]\"\n* \"request.query[token]\"\n* \"request.auth[Token]\"\n* \"request.path[TOKEN]\"\n" } }, "type": "object", "required": [ "tokenLocations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRoute:getDeploymentsDeploymentCollectionSpecificationRoute": { "properties": { "backends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackend:getDeploymentsDeploymentCollectionSpecificationRouteBackend" }, "description": "The backend to forward requests to.\n" }, "loggingPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicy:getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicy" }, "description": "Policies controlling the pushing of logs to Oracle Cloud Infrastructure Public Logging.\n" }, "methods": { "type": "array", "items": { "type": "string" }, "description": "A list of allowed methods on this route.\n" }, "path": { "type": "string", "description": "A URL path pattern that must be matched on this route. The path pattern may contain a subset of RFC 6570 identifiers to allow wildcard and parameterized matching.\n" }, "requestPolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicy:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicy" }, "description": "Behavior applied to any requests received by the API on this route.\n" }, "responsePolicies": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicy:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicy" }, "description": "Behavior applied to any responses sent by the API for requests on this route.\n" } }, "type": "object", "required": [ "backends", "loggingPolicies", "methods", "path", "requestPolicies", "responsePolicies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackend:getDeploymentsDeploymentCollectionSpecificationRouteBackend": { "properties": { "allowedPostLogoutUris": { "type": "array", "items": { "type": "string" }, "description": "A list of allowed post-logout URLs to which a request can be redirected after revoke access\n" }, "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendHeader:getDeploymentsDeploymentCollectionSpecificationRouteBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "postLogoutState": { "type": "string", "description": "Defines a state that should be shared on redirecting to postLogout URL.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "routingBackends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackend:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackend" }, "description": "List of backends to chose from for Dynamic Routing.\n" }, "selectionSources": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendSelectionSource:getDeploymentsDeploymentCollectionSpecificationRouteBackendSelectionSource" }, "description": "Information around selector used for branching among routes/ authentication servers while dynamic routing/ authentication.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "allowedPostLogoutUris", "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "postLogoutState", "readTimeoutInSeconds", "routingBackends", "selectionSources", "sendTimeoutInSeconds", "status", "type", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendHeader:getDeploymentsDeploymentCollectionSpecificationRouteBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackend:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackend": { "properties": { "backends": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackend:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackend" }, "description": "The backend to forward requests to.\n" }, "keys": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendKey:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendKey" }, "description": "Information around the values for selector of an authentication/ routing branch.\n" } }, "type": "object", "required": [ "backends", "keys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackend:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackend": { "properties": { "body": { "type": "string", "description": "The body of the stock response from the mock backend.\n" }, "connectTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for establishing a connection with a proxied server.\n" }, "functionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Functions function resource.\n" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackendHeader:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackendHeader" }, "description": "The List of Headers\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for reading a response from the proxied server.\n" }, "sendTimeoutInSeconds": { "type": "number", "description": "Defines a timeout for transmitting a request to the proxied server.\n" }, "status": { "type": "integer", "description": "The status code of the stock response from the mock backend.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "url": { "type": "string", "description": "The url of the HTTP Backend\n" } }, "type": "object", "required": [ "body", "connectTimeoutInSeconds", "functionId", "headers", "isSslVerifyDisabled", "readTimeoutInSeconds", "sendTimeoutInSeconds", "status", "type", "url" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackendHeader:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendBackendHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "value": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendKey:getDeploymentsDeploymentCollectionSpecificationRouteBackendRoutingBackendKey": { "properties": { "expression": { "type": "string", "description": "String describing the expression with wildcards.\n" }, "isDefault": { "type": "boolean", "description": "Information regarding whether this is the default branch.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "expression", "isDefault", "name", "type", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteBackendSelectionSource:getDeploymentsDeploymentCollectionSpecificationRouteBackendSelectionSource": { "properties": { "selector": { "type": "string", "description": "String describing the context variable used as selector.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "selector", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicy:getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicy": { "properties": { "accessLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyAccessLog:getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyAccessLog" }, "description": "Configures the logging policies for the access logs of an API Deployment.\n" }, "executionLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyExecutionLog:getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyExecutionLog" }, "description": "Configures the logging policies for the execution logs of an API Deployment.\n" } }, "type": "object", "required": [ "accessLogs", "executionLogs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyAccessLog:getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyAccessLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyExecutionLog:getDeploymentsDeploymentCollectionSpecificationRouteLoggingPolicyExecutionLog": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "logLevel": { "type": "string", "description": "Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.\n" } }, "type": "object", "required": [ "isEnabled", "logLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicy:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicy": { "properties": { "authorizations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyAuthorization:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyAuthorization" }, "description": "If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route, a policy with a type of AUTHENTICATION_ONLY is applied.\n" }, "bodyValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidation" }, "description": "Validate the payload body of the incoming API requests on a specific route.\n" }, "cors": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyCor:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyCor" }, "description": "Enable CORS (Cross-Origin-Resource-Sharing) request handling.\n" }, "headerTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "headerValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidation" }, "description": "Validate the HTTP headers on the incoming API requests on a specific route.\n" }, "queryParameterTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformation" }, "description": "A set of transformations to apply to query parameters that pass through the gateway.\n" }, "queryParameterValidations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidation" }, "description": "Validate the URL query parameters on the incoming API requests on a specific route.\n" }, "responseCacheLookups": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyResponseCacheLookup:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyResponseCacheLookup" }, "description": "Base policy for Response Cache lookup.\n" } }, "type": "object", "required": [ "authorizations", "bodyValidations", "cors", "headerTransformations", "headerValidations", "queryParameterTransformations", "queryParameterValidations", "responseCacheLookups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyAuthorization:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyAuthorization": { "properties": { "allowedScopes": { "type": "array", "items": { "type": "string" }, "description": "A user whose scope includes any of these access ranges is allowed on this route. Access ranges are case-sensitive.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "allowedScopes", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidation": { "properties": { "contents": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidationContent:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidationContent" }, "description": "The content of the request body.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "contents", "required", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidationContent:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyBodyValidationContent": { "properties": { "mediaType": { "type": "string", "description": "The key is a [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) subset restricted to the following schema\n" }, "validationType": { "type": "string", "description": "Validation type defines the content validation method.\n" } }, "type": "object", "required": [ "mediaType", "validationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyCor:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyCor": { "properties": { "allowedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that will be allowed from the client via the Access-Control-Allow-Headers header. '*' will allow all headers.\n" }, "allowedMethods": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed HTTP methods that will be returned for the preflight OPTIONS request in the Access-Control-Allow-Methods header. '*' will allow all methods.\n" }, "allowedOrigins": { "type": "array", "items": { "type": "string" }, "description": "The list of allowed origins that the CORS handler will use to respond to CORS requests. The gateway will send the Access-Control-Allow-Origin header with the best origin match for the circumstances. '*' will match any origins, and 'null' will match queries from 'file:' origins. All other origins must be qualified with the scheme, full hostname, and port if necessary.\n" }, "exposedHeaders": { "type": "array", "items": { "type": "string" }, "description": "The list of headers that the client will be allowed to see from the response as indicated by the Access-Control-Expose-Headers header. '*' will expose all headers.\n" }, "isAllowCredentialsEnabled": { "type": "boolean", "description": "Whether to send the Access-Control-Allow-Credentials header to allow CORS requests with cookies.\n" }, "maxAgeInSeconds": { "type": "integer", "description": "The time in seconds for the client to cache preflight responses. This is sent as the Access-Control-Max-Age if greater than 0.\n" } }, "type": "object", "required": [ "allowedHeaders", "allowedMethods", "allowedOrigins", "exposedHeaders", "isAllowCredentialsEnabled", "maxAgeInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidation": { "properties": { "headers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidationHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidationHeader" }, "description": "The List of Headers\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "headers", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidationHeader:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyHeaderValidationHeader": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name", "required" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformation": { "properties": { "filterQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter" }, "description": "Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter" }, "description": "Rename parameters on the query string as they pass through the gateway.\n" }, "setQueryParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter" }, "description": "Set parameters on the query string as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterQueryParameters", "renameQueryParameters", "setQueryParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationFilterQueryParameterItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationRenameQueryParameterItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameter": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterTransformationSetQueryParameterItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidation:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidation": { "properties": { "parameters": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidationParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidationParameter" }, "description": "The List of Query Parameters\n" }, "validationMode": { "type": "string", "description": "Validation behavior mode.\n" } }, "type": "object", "required": [ "parameters", "validationMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidationParameter:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyQueryParameterValidationParameter": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "required": { "type": "boolean", "description": "Determines if the parameter is required in the request.\n" } }, "type": "object", "required": [ "name", "required" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyResponseCacheLookup:getDeploymentsDeploymentCollectionSpecificationRouteRequestPolicyResponseCacheLookup": { "properties": { "cacheKeyAdditions": { "type": "array", "items": { "type": "string" }, "description": "A list of context expressions whose values will be added to the base cache key. Values should contain an expression enclosed within ${} delimiters. Only the request context is available.\n" }, "isEnabled": { "type": "boolean", "description": "Whether this policy is currently enabled.\n" }, "isPrivateCachingEnabled": { "type": "boolean", "description": "Set true to allow caching responses where the request has an Authorization header. Ensure you have configured your cache key additions to get the level of isolation across authenticated requests that you require.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "cacheKeyAdditions", "isEnabled", "isPrivateCachingEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicy:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicy": { "properties": { "headerTransformations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformation" }, "description": "A set of transformations to apply to HTTP headers that pass through the gateway.\n" }, "responseCacheStores": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyResponseCacheStore:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyResponseCacheStore" }, "description": "Base policy for how a response from a backend is cached in the Response Cache.\n" } }, "type": "object", "required": [ "headerTransformations", "responseCacheStores" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformation:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformation": { "properties": { "filterHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeader" }, "description": "Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be listed here when using an ALLOW type policy.\n" }, "renameHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeader" }, "description": "Rename HTTP headers as they pass through the gateway.\n" }, "setHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeader" }, "description": "Set HTTP headers as they pass through the gateway.\n" } }, "type": "object", "required": [ "filterHeaders", "renameHeaders", "setHeaders" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeader:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem" }, "description": "The list of headers.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "items", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationFilterHeaderItem": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeader:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationRenameHeaderItem": { "properties": { "from": { "type": "string", "description": "The original case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "to": { "type": "string", "description": "The new name of the header. This name must be unique across transformation policies.\n" } }, "type": "object", "required": [ "from", "to" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeader:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeader": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem" }, "description": "The list of headers.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyHeaderTransformationSetHeaderItem": { "properties": { "ifExists": { "type": "string", "description": "If a header with the same name already exists in the request, OVERWRITE will overwrite the value, APPEND will append to the existing value, or SKIP will keep the existing value.\n" }, "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "ifExists", "name", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyResponseCacheStore:getDeploymentsDeploymentCollectionSpecificationRouteResponsePolicyResponseCacheStore": { "properties": { "timeToLiveInSeconds": { "type": "integer", "description": "Sets the number of seconds for a response from a backend being stored in the Response Cache before it expires.\n" }, "type": { "type": "string", "description": "Type of the Response Cache Store Policy.\n" } }, "type": "object", "required": [ "timeToLiveInSeconds", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getDeploymentsFilter:getDeploymentsFilter": { "properties": { "name": { "type": "string", "description": "The case-insensitive name of the header. This name must be unique across transformation policies.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" }, "description": "A list of new values. Each value can be a constant or may include one or more expressions enclosed within ${} delimiters.\n" } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApiGateway/getGatewayCaBundle:getGatewayCaBundle": { "properties": { "caBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "certificateAuthorityId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "type": { "type": "string", "description": "Type of the Response Cache.\n" } }, "type": "object", "required": [ "caBundleId", "certificateAuthorityId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewayIpAddress:getGatewayIpAddress": { "properties": { "ipAddress": { "type": "string", "description": "An IP address.\n" } }, "type": "object", "required": [ "ipAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewayIpv4addressConfiguration:getGatewayIpv4addressConfiguration": { "properties": { "reservedIpIds": { "type": "array", "items": { "type": "string" }, "description": "List of Reserved IP OCIDs created in VCN service.\n" } }, "type": "object", "required": [ "reservedIpIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewayIpv6addressConfiguration:getGatewayIpv6addressConfiguration": { "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 addresses that will be assigned to the gateway during creation.\n" }, "subnetCidrs": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet.\n" } }, "type": "object", "required": [ "addresses", "subnetCidrs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewayLock:getGatewayLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the Response Cache.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewayResponseCacheDetail:getGatewayResponseCacheDetail": { "properties": { "authenticationSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "authenticationSecretVersionNumber": { "type": "string", "description": "The version number of the authentication secret to use.\n" }, "connectTimeoutInMs": { "type": "integer", "description": "Defines the timeout for establishing a connection with the Response Cache.\n" }, "isSslEnabled": { "type": "boolean", "description": "Defines if the connection should be over SSL.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInMs": { "type": "integer", "description": "Defines the timeout for reading data from the Response Cache.\n" }, "sendTimeoutInMs": { "type": "integer", "description": "Defines the timeout for transmitting data to the Response Cache.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewayResponseCacheDetailServer:getGatewayResponseCacheDetailServer" }, "description": "The set of cache store members to connect to. At present only a single server is supported.\n" }, "type": { "type": "string", "description": "Type of the Response Cache.\n" } }, "type": "object", "required": [ "authenticationSecretId", "authenticationSecretVersionNumber", "connectTimeoutInMs", "isSslEnabled", "isSslVerifyDisabled", "readTimeoutInMs", "sendTimeoutInMs", "servers", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewayResponseCacheDetailServer:getGatewayResponseCacheDetailServer": { "properties": { "host": { "type": "string", "description": "Hostname or IP address (IPv4 only) where the cache store is running.\n" }, "port": { "type": "integer", "description": "The port the cache store is exposed on.\n" } }, "type": "object", "required": [ "host", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysFilter:getGatewaysFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApiGateway/getGatewaysGatewayCollection:getGatewaysGatewayCollection": { "properties": { "caBundles": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionCaBundle:getGatewaysGatewayCollectionCaBundle" }, "description": "An array of CA bundles that should be used on the Gateway for TLS validation.\n" }, "certificateId": { "type": "string", "description": "Filter gateways by the certificate ocid.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "endpointType": { "type": "string", "description": "Gateway endpoint type. `PUBLIC` will have a public ip address assigned to it, while `PRIVATE` will only be accessible on a private IP address on the subnet. Example: `PUBLIC` or `PRIVATE`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostname": { "type": "string", "description": "The hostname for APIs deployed on the gateway.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "ipAddresses": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionIpAddress:getGatewaysGatewayCollectionIpAddress" }, "description": "An array of IP addresses associated with the gateway.\n" }, "ipMode": { "type": "string", "description": "Determines whether the gateway has an IPv4 or IPv6 address assigned to it, or both. `IPV4` means the gateway will only have an IPv4 address assigned to it, and `IPV6` means the gateway will only have an `IPv6` address assigned to it. `DUAL_STACK` means the gateway will have both an IPv4 and IPv6 address assigned to it. Example: `IPV4` or `IPV6` or `DUAL_STACK`\n" }, "ipv4addressConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionIpv4addressConfiguration:getGatewaysGatewayCollectionIpv4addressConfiguration" }, "description": "IPv4 address configuration details that should be used when creating the gateway.\n" }, "ipv6addressConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionIpv6addressConfiguration:getGatewaysGatewayCollectionIpv6addressConfiguration" }, "description": "IPv6 address configuration details that should be used when creating the gateway.\n" }, "isLockOverride": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionLock:getGatewaysGatewayCollectionLock" }, "description": "Locks associated with this resource.\n" }, "networkSecurityGroupIds": { "type": "array", "items": { "type": "string" }, "description": "An array of Network Security Groups OCIDs associated with this API Gateway.\n" }, "responseCacheDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionResponseCacheDetail:getGatewaysGatewayCollectionResponseCacheDetail" }, "description": "Base Gateway response cache.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state. Example: `SUCCEEDED`\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet in which related resources are created.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time this resource was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "caBundles", "certificateId", "compartmentId", "definedTags", "displayName", "endpointType", "freeformTags", "hostname", "id", "ipAddresses", "ipMode", "ipv4addressConfigurations", "ipv6addressConfigurations", "isLockOverride", "lifecycleDetails", "locks", "networkSecurityGroupIds", "responseCacheDetails", "state", "subnetId", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionCaBundle:getGatewaysGatewayCollectionCaBundle": { "properties": { "caBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "certificateAuthorityId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "type": { "type": "string", "description": "Type of the Response Cache.\n" } }, "type": "object", "required": [ "caBundleId", "certificateAuthorityId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionIpAddress:getGatewaysGatewayCollectionIpAddress": { "properties": { "ipAddress": { "type": "string", "description": "An IP address.\n" } }, "type": "object", "required": [ "ipAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionIpv4addressConfiguration:getGatewaysGatewayCollectionIpv4addressConfiguration": { "properties": { "reservedIpIds": { "type": "array", "items": { "type": "string" }, "description": "List of Reserved IP OCIDs created in VCN service.\n" } }, "type": "object", "required": [ "reservedIpIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionIpv6addressConfiguration:getGatewaysGatewayCollectionIpv6addressConfiguration": { "properties": { "addresses": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 addresses that will be assigned to the gateway during creation.\n" }, "subnetCidrs": { "type": "array", "items": { "type": "string" }, "description": "List of IPv6 prefixes from which to provision IPv6 addresses from. This is required if more than one prefix exists on the subnet.\n" } }, "type": "object", "required": [ "addresses", "subnetCidrs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionLock:getGatewaysGatewayCollectionLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the Response Cache.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionResponseCacheDetail:getGatewaysGatewayCollectionResponseCacheDetail": { "properties": { "authenticationSecretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Oracle Vault Service secret resource.\n" }, "authenticationSecretVersionNumber": { "type": "string", "description": "The version number of the authentication secret to use.\n" }, "connectTimeoutInMs": { "type": "integer", "description": "Defines the timeout for establishing a connection with the Response Cache.\n" }, "isSslEnabled": { "type": "boolean", "description": "Defines if the connection should be over SSL.\n" }, "isSslVerifyDisabled": { "type": "boolean", "description": "Defines whether or not to uphold SSL verification.\n" }, "readTimeoutInMs": { "type": "integer", "description": "Defines the timeout for reading data from the Response Cache.\n" }, "sendTimeoutInMs": { "type": "integer", "description": "Defines the timeout for transmitting data to the Response Cache.\n" }, "servers": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getGatewaysGatewayCollectionResponseCacheDetailServer:getGatewaysGatewayCollectionResponseCacheDetailServer" }, "description": "The set of cache store members to connect to. At present only a single server is supported.\n" }, "type": { "type": "string", "description": "Type of the Response Cache.\n" } }, "type": "object", "required": [ "authenticationSecretId", "authenticationSecretVersionNumber", "connectTimeoutInMs", "isSslEnabled", "isSslVerifyDisabled", "readTimeoutInMs", "sendTimeoutInMs", "servers", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getGatewaysGatewayCollectionResponseCacheDetailServer:getGatewaysGatewayCollectionResponseCacheDetailServer": { "properties": { "host": { "type": "string", "description": "Hostname or IP address (IPv4 only) where the cache store is running.\n" }, "port": { "type": "integer", "description": "The port the cache store is exposed on.\n" } }, "type": "object", "required": [ "host", "port" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getSubscriberClient:getSubscriberClient": { "properties": { "name": { "type": "string", "description": "The name of the client. Must be unique within a subscriber.\n" }, "token": { "type": "string", "description": "The token for the client. Must be unique within a tenancy.\n" } }, "type": "object", "required": [ "name", "token" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getSubscriberLock:getSubscriberLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getSubscribersFilter:getSubscribersFilter": { "properties": { "name": { "type": "string", "description": "The name of the client. Must be unique within a subscriber.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApiGateway/getSubscribersSubscriberCollection:getSubscribersSubscriberCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getSubscribersSubscriberCollectionItem:getSubscribersSubscriberCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getSubscribersSubscriberCollectionItem:getSubscribersSubscriberCollectionItem": { "properties": { "clients": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getSubscribersSubscriberCollectionItemClient:getSubscribersSubscriberCollectionItemClient" }, "description": "The clients belonging to this subscriber.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "isLockOverride": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getSubscribersSubscriberCollectionItemLock:getSubscribersSubscriberCollectionItemLock" }, "description": "Locks associated with this resource.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state. Example: `ACTIVE`\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time this resource was last updated. An RFC3339 formatted datetime string.\n" }, "usagePlans": { "type": "array", "items": { "type": "string" }, "description": "An array of [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s of usage plan resources.\n" } }, "type": "object", "required": [ "clients", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "isLockOverride", "lifecycleDetails", "locks", "state", "systemTags", "timeCreated", "timeUpdated", "usagePlans" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getSubscribersSubscriberCollectionItemClient:getSubscribersSubscriberCollectionItemClient": { "properties": { "name": { "type": "string", "description": "The name of the client. Must be unique within a subscriber.\n" }, "token": { "type": "string", "description": "The token for the client. Must be unique within a tenancy.\n" } }, "type": "object", "required": [ "name", "token" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getSubscribersSubscriberCollectionItemLock:getSubscribersSubscriberCollectionItemLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlanEntitlement:getUsagePlanEntitlement": { "properties": { "description": { "type": "string", "description": "A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.\n" }, "name": { "type": "string", "description": "An entitlement name, unique within a usage plan.\n" }, "quotas": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlanEntitlementQuota:getUsagePlanEntitlementQuota" }, "description": "Quota policy for a usage plan.\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlanEntitlementRateLimit:getUsagePlanEntitlementRateLimit" }, "description": "Rate-limiting policy for a usage plan.\n" }, "targets": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlanEntitlementTarget:getUsagePlanEntitlementTarget" }, "description": "A collection of targeted deployments that the entitlement will be applied to.\n" } }, "type": "object", "required": [ "description", "name", "quotas", "rateLimits", "targets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlanEntitlementQuota:getUsagePlanEntitlementQuota": { "properties": { "operationOnBreach": { "type": "string", "description": "What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests\n" }, "resetPolicy": { "type": "string", "description": "The policy that controls when quotas will reset. Example: `CALENDAR`\n" }, "unit": { "type": "string", "description": "The unit of time over which rate limits are calculated. Example: `SECOND`\n" }, "value": { "type": "integer", "description": "The number of requests that can be made per time period.\n" } }, "type": "object", "required": [ "operationOnBreach", "resetPolicy", "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlanEntitlementRateLimit:getUsagePlanEntitlementRateLimit": { "properties": { "unit": { "type": "string", "description": "The unit of time over which rate limits are calculated. Example: `SECOND`\n" }, "value": { "type": "integer", "description": "The number of requests that can be made per time period.\n" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlanEntitlementTarget:getUsagePlanEntitlementTarget": { "properties": { "deploymentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a deployment resource.\n" } }, "type": "object", "required": [ "deploymentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlanLock:getUsagePlanLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansFilter:getUsagePlansFilter": { "properties": { "name": { "type": "string", "description": "An entitlement name, unique within a usage plan.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApiGateway/getUsagePlansUsagePlanCollection:getUsagePlansUsagePlanCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlansUsagePlanCollectionItem:getUsagePlansUsagePlanCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansUsagePlanCollectionItem:getUsagePlansUsagePlanCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "entitlements": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlement:getUsagePlansUsagePlanCollectionItemEntitlement" }, "description": "A collection of entitlements currently assigned to the usage plan.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a usage plan resource.\n" }, "isLockOverride": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.\n" }, "locks": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlansUsagePlanCollectionItemLock:getUsagePlansUsagePlanCollectionItemLock" }, "description": "Locks associated with this resource.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state. Example: `ACTIVE`\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time this resource was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "entitlements", "freeformTags", "id", "isLockOverride", "lifecycleDetails", "locks", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlement:getUsagePlansUsagePlanCollectionItemEntitlement": { "properties": { "description": { "type": "string", "description": "A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.\n" }, "name": { "type": "string", "description": "An entitlement name, unique within a usage plan.\n" }, "quotas": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlementQuota:getUsagePlansUsagePlanCollectionItemEntitlementQuota" }, "description": "Quota policy for a usage plan.\n" }, "rateLimits": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlementRateLimit:getUsagePlansUsagePlanCollectionItemEntitlementRateLimit" }, "description": "Rate-limiting policy for a usage plan.\n" }, "targets": { "type": "array", "items": { "$ref": "#/types/oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlementTarget:getUsagePlansUsagePlanCollectionItemEntitlementTarget" }, "description": "A collection of targeted deployments that the entitlement will be applied to.\n" } }, "type": "object", "required": [ "description", "name", "quotas", "rateLimits", "targets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlementQuota:getUsagePlansUsagePlanCollectionItemEntitlementQuota": { "properties": { "operationOnBreach": { "type": "string", "description": "What the usage plan will do when a quota is breached: `REJECT` will allow no further requests `ALLOW` will continue to allow further requests\n" }, "resetPolicy": { "type": "string", "description": "The policy that controls when quotas will reset. Example: `CALENDAR`\n" }, "unit": { "type": "string", "description": "The unit of time over which rate limits are calculated. Example: `SECOND`\n" }, "value": { "type": "integer", "description": "The number of requests that can be made per time period.\n" } }, "type": "object", "required": [ "operationOnBreach", "resetPolicy", "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlementRateLimit:getUsagePlansUsagePlanCollectionItemEntitlementRateLimit": { "properties": { "unit": { "type": "string", "description": "The unit of time over which rate limits are calculated. Example: `SECOND`\n" }, "value": { "type": "integer", "description": "The number of requests that can be made per time period.\n" } }, "type": "object", "required": [ "unit", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansUsagePlanCollectionItemEntitlementTarget:getUsagePlansUsagePlanCollectionItemEntitlementTarget": { "properties": { "deploymentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a deployment resource.\n" } }, "type": "object", "required": [ "deploymentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApiGateway/getUsagePlansUsagePlanCollectionItemLock:getUsagePlansUsagePlanCollectionItemLock": { "properties": { "message": { "type": "string", "description": "A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.\n" }, "relatedResourceId": { "type": "string", "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n" }, "timeCreated": { "type": "string", "description": "The time this resource was created. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "Type of the lock.\n" } }, "type": "object", "required": [ "message", "relatedResourceId", "timeCreated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Apm/getApmDomainsApmDomain:getApmDomainsApmDomain": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "dataUploadEndpoint": { "type": "string", "description": "The endpoint where the APM agents upload their observations and metrics.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Description of the APM domain.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation.\n" }, "isFreeTier": { "type": "boolean", "description": "Indicates if this is an Always Free resource.\n" }, "logGroupId": { "type": "string", "description": "The OCID of the Log Analytics log group to which the data uploaded to this APM domain will be mapped to.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given life-cycle state.\n" }, "timeCreated": { "type": "string", "description": "The time the APM domain was created, expressed in RFC 3339 timestamp format.\n" }, "timeUpdated": { "type": "string", "description": "The time the APM domain was updated, expressed in RFC 3339 timestamp format.\n" } }, "type": "object", "required": [ "compartmentId", "dataUploadEndpoint", "definedTags", "description", "displayName", "freeformTags", "id", "isFreeTier", "logGroupId", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Apm/getApmDomainsFilter:getApmDomainsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Apm/getDataKeysDataKey:getDataKeysDataKey": { "properties": { "name": { "type": "string", "description": "Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.\n" }, "type": { "type": "string", "description": "Type of the Data Key.\n" }, "value": { "type": "string", "description": "Value of the Data Key.\n" } }, "type": "object", "required": [ "name", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Apm/getDataKeysFilter:getDataKeysFilter": { "properties": { "name": { "type": "string", "description": "Name of the Data Key. The name uniquely identifies a Data Key within an APM domain.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmConfig/ConfigConfig:ConfigConfig": { "properties": { "configMaps": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/ConfigConfigConfigMap:ConfigConfigConfigMap" }, "description": "(Updatable) Map of an agent configuration file.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configMaps" ] } } }, "oci:ApmConfig/ConfigConfigConfigMap:ConfigConfigConfigMap": { "properties": { "body": { "type": "string", "description": "The Base64 encoded agent configuration file.\n" }, "contentType": { "type": "string", "description": "(Updatable) The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8\n" }, "fileName": { "type": "string", "description": "(Updatable) An agent configuration file name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "body", "contentType", "fileName" ] } } }, "oci:ApmConfig/ConfigDimension:ConfigDimension": { "properties": { "name": { "type": "string", "description": "(Updatable) The name of the dimension.\n" }, "valueSource": { "type": "string", "description": "(Updatable) The source to populate the dimension. This must not be specified.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "valueSource" ] } } }, "oci:ApmConfig/ConfigInUseBy:ConfigInUseBy": { "properties": { "configType": { "type": "string", "description": "(Updatable) The type of configuration item.\n" }, "displayName": { "type": "string", "description": "(Updatable) The name by which a configuration entity is displayed to the end user.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated when the item is created.\n" }, "optionsGroup": { "type": "string", "description": "A string that specifies the group that an OPTIONS item belongs to.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configType", "displayName", "id", "optionsGroup" ] } } }, "oci:ApmConfig/ConfigMetric:ConfigMetric": { "properties": { "description": { "type": "string", "description": "(Updatable) A description of the metric.\n" }, "name": { "type": "string", "description": "(Updatable) The name of the metric. This must be a known metric name.\n" }, "unit": { "type": "string", "description": "(Updatable) The unit of the metric.\n" }, "valueSource": { "type": "string", "description": "(Updatable) This must not be set.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "name", "unit", "valueSource" ] } } }, "oci:ApmConfig/ConfigOverrides:ConfigOverrides": { "properties": { "overrideLists": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/ConfigOverridesOverrideList:ConfigOverridesOverrideList" }, "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "overrideLists" ] } } }, "oci:ApmConfig/ConfigOverridesOverrideList:ConfigOverridesOverrideList": { "properties": { "agentFilter": { "type": "string", "description": "(Updatable) The string that defines the Agent Filter expression.\n" }, "overrideMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) A map whose key is a substitution variable specified within the configuration's body. For example, if below was specified in the configuration's body {{ isJfrEnabled | default false }} Then a valid map key would be \"isJfrEnabled\". The value is typically different than the default specified in the configuration's body. Thus, in this example, the map entry could be \"isJfrEnabled\": true\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentFilter", "overrideMap" ] } } }, "oci:ApmConfig/ConfigRule:ConfigRule": { "properties": { "displayName": { "type": "string", "description": "(Updatable) The name by which a configuration entity is displayed to the end user.\n" }, "filterText": { "type": "string", "description": "(Updatable) The string that defines the Span Filter expression.\n" }, "isApplyToErrorSpans": { "type": "boolean", "description": "(Updatable) Specifies whether an Apdex score should be computed for error spans. Setting it to \"true\" means that the Apdex score is computed in the usual way. Setting it to \"false\" skips the Apdex computation and sets the Apdex score to \"frustrating\" regardless of the configured thresholds. The default is \"false\".\n" }, "isEnabled": { "type": "boolean", "description": "(Updatable) Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is \"true\".\n" }, "priority": { "type": "integer", "description": "(Updatable) The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.\n" }, "satisfiedResponseTime": { "type": "integer", "description": "(Updatable) The maximum response time in milliseconds that is considered \"satisfactory\" for the end user.\n" }, "toleratingResponseTime": { "type": "integer", "description": "(Updatable) The maximum response time in milliseconds that is considered \"tolerable\" for the end user. A response time beyond this threshold is considered \"frustrating\". This value cannot be lower than \"satisfiedResponseTime\".\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "filterText", "isApplyToErrorSpans", "isEnabled", "priority", "satisfiedResponseTime", "toleratingResponseTime" ] } } }, "oci:ApmConfig/getConfigConfig:getConfigConfig": { "properties": { "configMaps": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigConfigConfigMap:getConfigConfigConfigMap" }, "description": "Map of an agent configuration file.\n" } }, "type": "object", "required": [ "configMaps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigConfigConfigMap:getConfigConfigConfigMap": { "properties": { "body": { "type": "string", "description": "The Base64 encoded agent configuration file.\n" }, "contentType": { "type": "string", "description": "The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8\n" }, "fileName": { "type": "string", "description": "An agent configuration file name.\n" } }, "type": "object", "required": [ "body", "contentType", "fileName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigDimension:getConfigDimension": { "properties": { "name": { "type": "string", "description": "The name of the metric. This must be a known metric name.\n" }, "valueSource": { "type": "string", "description": "This must not be set.\n" } }, "type": "object", "required": [ "name", "valueSource" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigInUseBy:getConfigInUseBy": { "properties": { "configType": { "type": "string", "description": "The type of configuration item.\n" }, "displayName": { "type": "string", "description": "The name by which a configuration entity is displayed to the end user.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated when the item is created.\n" }, "optionsGroup": { "type": "string", "description": "A string that specifies the group that an OPTIONS item belongs to.\n" } }, "type": "object", "required": [ "configType", "displayName", "id", "optionsGroup" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigMetric:getConfigMetric": { "properties": { "description": { "type": "string", "description": "A description of the metric.\n" }, "name": { "type": "string", "description": "The name of the metric. This must be a known metric name.\n" }, "unit": { "type": "string", "description": "The unit of the metric.\n" }, "valueSource": { "type": "string", "description": "This must not be set.\n" } }, "type": "object", "required": [ "description", "name", "unit", "valueSource" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigOverride:getConfigOverride": { "properties": { "overrideLists": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigOverrideOverrideList:getConfigOverrideOverrideList" } } }, "type": "object", "required": [ "overrideLists" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigOverrideOverrideList:getConfigOverrideOverrideList": { "properties": { "agentFilter": { "type": "string", "description": "The string that defines the Agent Filter expression.\n" }, "overrideMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map whose key is a substitution variable specified within the configuration's body. For example, if below was specified in the configuration's body {{ isJfrEnabled | default false }} Then a valid map key would be \"isJfrEnabled\". The value is typically different than the default specified in the configuration's body. Thus, in this example, the map entry could be \"isJfrEnabled\": true\n" } }, "type": "object", "required": [ "agentFilter", "overrideMap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigRule:getConfigRule": { "properties": { "displayName": { "type": "string", "description": "The name by which a configuration entity is displayed to the end user.\n" }, "filterText": { "type": "string", "description": "The string that defines the Span Filter expression.\n" }, "isApplyToErrorSpans": { "type": "boolean", "description": "Specifies whether an Apdex score should be computed for error spans. Setting it to \"true\" means that the Apdex score is computed in the usual way. Setting it to \"false\" skips the Apdex computation and sets the Apdex score to \"frustrating\" regardless of the configured thresholds. The default is \"false\".\n" }, "isEnabled": { "type": "boolean", "description": "Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is \"true\".\n" }, "priority": { "type": "integer", "description": "The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.\n" }, "satisfiedResponseTime": { "type": "integer", "description": "The maximum response time in milliseconds that is considered \"satisfactory\" for the end user.\n" }, "toleratingResponseTime": { "type": "integer", "description": "The maximum response time in milliseconds that is considered \"tolerable\" for the end user. A response time beyond this threshold is considered \"frustrating\". This value cannot be lower than \"satisfiedResponseTime\".\n" } }, "type": "object", "required": [ "displayName", "filterText", "isApplyToErrorSpans", "isEnabled", "priority", "satisfiedResponseTime", "toleratingResponseTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollection:getConfigsConfigCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItem:getConfigsConfigCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItem:getConfigsConfigCollectionItem": { "properties": { "agentVersion": { "type": "string", "description": "The version of the referenced agent bundle.\n" }, "apmDomainId": { "type": "string", "description": "The APM Domain ID the request is intended for.\n" }, "attachInstallDir": { "type": "string", "description": "The directory owned by runAsUser.\n" }, "configType": { "type": "string", "description": "A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, AGENT and MACS_APM_EXTENSION.\n" }, "configs": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemConfig:getConfigsConfigCollectionItemConfig" }, "description": "Collection of agent configuration files. For agents that use a single configuration file, this SHOULD contain a single entry and the file name MAY be an empty string. For multiple entries, you should use multiple blocks of \u003cspan pulumi-lang-nodejs=\"`configMap`\" pulumi-lang-dotnet=\"`ConfigMap`\" pulumi-lang-go=\"`configMap`\" pulumi-lang-python=\"`config_map`\" pulumi-lang-yaml=\"`configMap`\" pulumi-lang-java=\"`configMap`\" pulumi-lang-hcl=\"`config_map`\"\u003e`configMap`\u003c/span\u003e. To apply a different configuration in a subset of the agents, put this block anywhere in the body of the configuration and edit \u003csome variable\u003e and \u003csome content\u003e {{ \u003csome variable\u003e | default \u003csome content\u003e }} Example: com.oracle.apm.agent.tracer.enable.jfr = {{ isJfrEnabled | default false }} Then, in the configuration's overrides, specify a different value for \u003csome variable\u003e along with the desired agent filter. Example: \"agentFilter\": \"ApplicationType='Tomcat'\" \"overrideMap\": { \"isJfrEnabled\": true }\n" }, "createdBy": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a user.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A description of the metric.\n" }, "dimensions": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemDimension:getConfigsConfigCollectionItemDimension" }, "description": "A list of dimensions for the metric. This variable should not be used.\n" }, "displayName": { "type": "string", "description": "A filter to return resources that match the given display name.\n" }, "etag": { "type": "string", "description": "For optimistic concurrency control. See `if-match`.\n" }, "filterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a Span Filter. The filterId is mandatory for the creation of MetricGroups. A filterId is generated when a Span Filter is created.\n" }, "filterText": { "type": "string", "description": "The string that defines the Span Filter expression.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "group": { "type": "string", "description": "A string that specifies the group that an OPTIONS item belongs to.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated when the item is created.\n" }, "inUseBies": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemInUseBy:getConfigsConfigCollectionItemInUseBy" }, "description": "The list of configuration items that reference the span filter.\n" }, "managementAgentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Management Agent that will provision the APM Agent.\n" }, "matchAgentsWithAttributeKeys": { "type": "array", "items": { "type": "string" }, "description": "The agent attribute KEY by which an Agent configuration is matched to an agent. All agent configuration objects share the same key. It is [ServiceName, service.name] by default. The attribute VALUE corresponding to this KEY is in the matchAgentsWithAttributeValue field.\n" }, "matchAgentsWithAttributeValue": { "type": "string", "description": "The agent attribute VALUE by which an agent configuration is matched to an agent. Each agent configuration object must specify a different value. The attribute KEY corresponding to this VALUE is in the matchAgentsWithAttributeKey field.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemMetric:getConfigsConfigCollectionItemMetric" }, "description": "The list of metrics in this group.\n" }, "namespace": { "type": "string", "description": "The namespace to which the metrics are published. It must be one of several predefined namespaces.\n" }, "opcDryRun": { "type": "string" }, "options": { "type": "string", "description": "The options are stored here as JSON.\n" }, "overrides": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemOverride:getConfigsConfigCollectionItemOverride" }, "description": "Agent configuration overrides that should apply to a subset of the agents associated with an Agent Config object.\n" }, "processFilters": { "type": "array", "items": { "type": "string" }, "description": "Filter patterns used to discover active Java processes for provisioning the APM Agent.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemRule:getConfigsConfigCollectionItemRule" } }, "runAsUser": { "type": "string", "description": "The OS user that should be used to discover Java processes.\n" }, "serviceName": { "type": "string", "description": "The name of the service being monitored. This argument enables you to filter by service and view traces and other signals in the APM Explorer user interface.\n" }, "timeCreated": { "type": "string", "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" }, "updatedBy": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a user.\n" } }, "type": "object", "required": [ "agentVersion", "apmDomainId", "attachInstallDir", "configs", "configType", "createdBy", "definedTags", "description", "dimensions", "displayName", "etag", "filterId", "filterText", "freeformTags", "group", "id", "inUseBies", "managementAgentId", "matchAgentsWithAttributeKeys", "matchAgentsWithAttributeValue", "metrics", "namespace", "opcDryRun", "options", "overrides", "processFilters", "rules", "runAsUser", "serviceName", "timeCreated", "timeUpdated", "updatedBy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemConfig:getConfigsConfigCollectionItemConfig": { "properties": { "configMaps": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemConfigConfigMap:getConfigsConfigCollectionItemConfigConfigMap" }, "description": "Map of an agent configuration file.\n" } }, "type": "object", "required": [ "configMaps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemConfigConfigMap:getConfigsConfigCollectionItemConfigConfigMap": { "properties": { "body": { "type": "string", "description": "The Base64 encoded agent configuration file.\n" }, "contentType": { "type": "string", "description": "The MIME Content-Type that describes the content of the body field, for example, text/yaml or text/yaml; charset=utf-8\n" }, "fileName": { "type": "string", "description": "An agent configuration file name.\n" } }, "type": "object", "required": [ "body", "contentType", "fileName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemDimension:getConfigsConfigCollectionItemDimension": { "properties": { "name": { "type": "string", "description": "The name of the metric. This must be a known metric name.\n" }, "valueSource": { "type": "string", "description": "This must not be set.\n" } }, "type": "object", "required": [ "name", "valueSource" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemInUseBy:getConfigsConfigCollectionItemInUseBy": { "properties": { "configType": { "type": "string", "description": "A filter to match configuration items of a given type. Supported values are SPAN_FILTER, METRIC_GROUP, APDEX, AGENT and MACS_APM_EXTENSION.\n" }, "displayName": { "type": "string", "description": "A filter to return resources that match the given display name.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration item. An OCID is generated when the item is created.\n" }, "optionsGroup": { "type": "string", "description": "A filter to return OPTIONS resources that match the given group.\n" } }, "type": "object", "required": [ "configType", "displayName", "id", "optionsGroup" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemMetric:getConfigsConfigCollectionItemMetric": { "properties": { "description": { "type": "string", "description": "A description of the metric.\n" }, "name": { "type": "string", "description": "The name of the metric. This must be a known metric name.\n" }, "unit": { "type": "string", "description": "The unit of the metric.\n" }, "valueSource": { "type": "string", "description": "This must not be set.\n" } }, "type": "object", "required": [ "description", "name", "unit", "valueSource" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemOverride:getConfigsConfigCollectionItemOverride": { "properties": { "overrideLists": { "type": "array", "items": { "$ref": "#/types/oci:ApmConfig/getConfigsConfigCollectionItemOverrideOverrideList:getConfigsConfigCollectionItemOverrideOverrideList" } } }, "type": "object", "required": [ "overrideLists" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemOverrideOverrideList:getConfigsConfigCollectionItemOverrideOverrideList": { "properties": { "agentFilter": { "type": "string", "description": "The string that defines the Agent Filter expression.\n" }, "overrideMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map whose key is a substitution variable specified within the configuration's body. For example, if below was specified in the configuration's body {{ isJfrEnabled | default false }} Then a valid map key would be \"isJfrEnabled\". The value is typically different than the default specified in the configuration's body. Thus, in this example, the map entry could be \"isJfrEnabled\": true\n" } }, "type": "object", "required": [ "agentFilter", "overrideMap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsConfigCollectionItemRule:getConfigsConfigCollectionItemRule": { "properties": { "displayName": { "type": "string", "description": "A filter to return resources that match the given display name.\n" }, "filterText": { "type": "string", "description": "The string that defines the Span Filter expression.\n" }, "isApplyToErrorSpans": { "type": "boolean", "description": "Specifies whether an Apdex score should be computed for error spans. Setting it to \"true\" means that the Apdex score is computed in the usual way. Setting it to \"false\" skips the Apdex computation and sets the Apdex score to \"frustrating\" regardless of the configured thresholds. The default is \"false\".\n" }, "isEnabled": { "type": "boolean", "description": "Specifies whether the Apdex score should be computed for spans matching the rule. This can be used to disable Apdex score for spans that do not need or require it. The default is \"true\".\n" }, "priority": { "type": "integer", "description": "The priority controls the order in which multiple rules in a rule set are applied. Lower values indicate higher priorities. Rules with higher priority are applied first, and once a match is found, the rest of the rules are ignored. Rules within the same rule set cannot have the same priority.\n" }, "satisfiedResponseTime": { "type": "integer", "description": "The maximum response time in milliseconds that is considered \"satisfactory\" for the end user.\n" }, "toleratingResponseTime": { "type": "integer", "description": "The maximum response time in milliseconds that is considered \"tolerable\" for the end user. A response time beyond this threshold is considered \"frustrating\". This value cannot be lower than \"satisfiedResponseTime\".\n" } }, "type": "object", "required": [ "displayName", "filterText", "isApplyToErrorSpans", "isEnabled", "priority", "satisfiedResponseTime", "toleratingResponseTime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmConfig/getConfigsFilter:getConfigsFilter": { "properties": { "name": { "type": "string", "description": "The name of the metric. This must be a known metric name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmConfig/getDataFilesFilter:getDataFilesFilter": { "properties": { "name": { "type": "string", "description": "A filter to return resources that match the specified name. Supports regular expressions to filter data files.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmConfig/getDataFilesItem:getDataFilesItem": { "properties": { "apmType": { "type": "string", "description": "The type of the data file.\n" }, "md5": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional user-defined metadata key and value to search by.\n" }, "name": { "type": "string", "description": "A filter to return resources that match the specified name. Supports regular expressions to filter data files.\n" }, "sizeInBytes": { "type": "string" }, "timeLastModified": { "type": "string" } }, "type": "object", "required": [ "apmType", "md5", "metadata", "name", "sizeInBytes", "timeLastModified" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/ConfigAvailabilityConfiguration:ConfigAvailabilityConfiguration": { "properties": { "maxAllowedFailuresPerInterval": { "type": "integer", "description": "(Updatable) Intervals with failed runs more than this value will be classified as UNAVAILABLE.\n" }, "minAllowedRunsPerInterval": { "type": "integer", "description": "(Updatable) Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maxAllowedFailuresPerInterval", "minAllowedRunsPerInterval" ] } } }, "oci:ApmSynthetics/ConfigConfiguration:ConfigConfiguration": { "properties": { "clientCertificateDetails": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationClientCertificateDetails:ConfigConfigurationClientCertificateDetails", "description": "(Updatable) Details for client certificate.\n" }, "configType": { "type": "string", "description": "(Updatable) Type of configuration.\n" }, "connectionString": { "type": "string", "description": "(Updatable) Database connection string.\n" }, "databaseAuthenticationDetails": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationDatabaseAuthenticationDetails:ConfigConfigurationDatabaseAuthenticationDetails", "description": "(Updatable) Details for basic authentication.\n" }, "databaseConnectionType": { "type": "string", "description": "(Updatable) Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.\n" }, "databaseRole": { "type": "string", "description": "(Updatable) Database role.\n" }, "databaseType": { "type": "string", "description": "(Updatable) Database type.\n" }, "databaseWalletDetails": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationDatabaseWalletDetails:ConfigConfigurationDatabaseWalletDetails", "description": "(Updatable) Details for database wallet.\n" }, "dnsConfiguration": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationDnsConfiguration:ConfigConfigurationDnsConfiguration", "description": "(Updatable) Information about the DNS settings.\n" }, "downloadSizeLimitInBytes": { "type": "integer", "description": "(Updatable) Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.\n" }, "ftpBasicAuthenticationDetails": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationFtpBasicAuthenticationDetails:ConfigConfigurationFtpBasicAuthenticationDetails", "description": "(Updatable) Details for basic authentication.\n" }, "ftpProtocol": { "type": "string", "description": "(Updatable) FTP protocol type.\n" }, "ftpRequestType": { "type": "string", "description": "(Updatable) FTP monitor request type.\n" }, "isActiveMode": { "type": "boolean", "description": "(Updatable) If enabled, Active mode will be used for the FTP connection. Not supported for SFTP protocol.\n" }, "isCertificateValidationEnabled": { "type": "boolean", "description": "(Updatable) If certificate validation is enabled, then the call will fail in case of certification errors.\n" }, "isDefaultSnapshotEnabled": { "type": "boolean", "description": "(Updatable) If disabled, auto snapshots are not collected.\n" }, "isFailureRetried": { "type": "boolean", "description": "(Updatable) If isFailureRetried is enabled, then a failed call will be retried.\n" }, "isQueryRecursive": { "type": "boolean", "description": "(Updatable) If isQueryRecursive is enabled, then queries will be sent recursively to the target server.\n" }, "isRedirectionEnabled": { "type": "boolean", "description": "(Updatable) If redirection is enabled, then redirects will be allowed while accessing target URL.\n" }, "nameServer": { "type": "string", "description": "(Updatable) Name of the server that will be used to perform DNS lookup.\n" }, "networkConfiguration": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationNetworkConfiguration:ConfigConfigurationNetworkConfiguration", "description": "(Updatable) Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.\n" }, "protocol": { "type": "string", "description": "(Updatable) Type of protocol.\n" }, "query": { "type": "string", "description": "(Updatable) SQL query to be executed.\n" }, "recordType": { "type": "string", "description": "(Updatable) DNS record type.\n" }, "reqAuthenticationDetails": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationReqAuthenticationDetails:ConfigConfigurationReqAuthenticationDetails", "description": "(Updatable) Details for request HTTP authentication.\n" }, "reqAuthenticationScheme": { "type": "string", "description": "(Updatable) Request HTTP authentication scheme.\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationRequestHeader:ConfigConfigurationRequestHeader" }, "description": "(Updatable) List of request headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`\n" }, "requestMethod": { "type": "string", "description": "(Updatable) Request HTTP method.\n" }, "requestPostBody": { "type": "string", "description": "(Updatable) Request post body content.\n" }, "requestQueryParams": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationRequestQueryParam:ConfigConfigurationRequestQueryParam" }, "description": "(Updatable) List of request query params. Example: `[{\"paramName\": \"sortOrder\", \"paramValue\": \"asc\"}]`\n" }, "uploadFileSizeInBytes": { "type": "integer", "description": "(Updatable) File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.\n" }, "verifyResponseCodes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.\n" }, "verifyResponseContent": { "type": "string", "description": "(Updatable) Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.\n" }, "verifyTexts": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationVerifyText:ConfigConfigurationVerifyText" }, "description": "(Updatable) Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "clientCertificateDetails", "configType", "connectionString", "databaseAuthenticationDetails", "databaseConnectionType", "databaseRole", "databaseType", "databaseWalletDetails", "dnsConfiguration", "downloadSizeLimitInBytes", "ftpBasicAuthenticationDetails", "ftpProtocol", "ftpRequestType", "isActiveMode", "isCertificateValidationEnabled", "isDefaultSnapshotEnabled", "isFailureRetried", "isQueryRecursive", "isRedirectionEnabled", "nameServer", "networkConfiguration", "protocol", "query", "recordType", "reqAuthenticationDetails", "reqAuthenticationScheme", "requestHeaders", "requestMethod", "requestPostBody", "requestQueryParams", "uploadFileSizeInBytes", "verifyResponseCodes", "verifyResponseContent", "verifyTexts" ] } } }, "oci:ApmSynthetics/ConfigConfigurationClientCertificateDetails:ConfigConfigurationClientCertificateDetails": { "properties": { "clientCertificate": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationClientCertificateDetailsClientCertificate:ConfigConfigurationClientCertificateDetailsClientCertificate", "description": "(Updatable) Client certificate in PEM format.\n" }, "privateKey": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationClientCertificateDetailsPrivateKey:ConfigConfigurationClientCertificateDetailsPrivateKey", "description": "(Updatable) The private key associated with the client certificate in PEM format.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "clientCertificate", "privateKey" ] } } }, "oci:ApmSynthetics/ConfigConfigurationClientCertificateDetailsClientCertificate:ConfigConfigurationClientCertificateDetailsClientCertificate": { "properties": { "content": { "type": "string", "description": "(Updatable) Content of the client certificate file.\n" }, "fileName": { "type": "string", "description": "(Updatable) Name of the certificate file. The name should not contain any confidential information.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "content", "fileName" ] } } }, "oci:ApmSynthetics/ConfigConfigurationClientCertificateDetailsPrivateKey:ConfigConfigurationClientCertificateDetailsPrivateKey": { "properties": { "content": { "type": "string", "description": "(Updatable) Content of the private key file.\n" }, "fileName": { "type": "string", "description": "(Updatable) Name of the private key file.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "content", "fileName" ] } } }, "oci:ApmSynthetics/ConfigConfigurationDatabaseAuthenticationDetails:ConfigConfigurationDatabaseAuthenticationDetails": { "properties": { "password": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationDatabaseAuthenticationDetailsPassword:ConfigConfigurationDatabaseAuthenticationDetailsPassword", "description": "(Updatable) Password.\n" }, "username": { "type": "string", "description": "(Updatable) Username for authentication.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "username" ] } } }, "oci:ApmSynthetics/ConfigConfigurationDatabaseAuthenticationDetailsPassword:ConfigConfigurationDatabaseAuthenticationDetailsPassword": { "properties": { "password": { "type": "string", "description": "(Updatable) Password.\n", "secret": true }, "passwordType": { "type": "string", "description": "(Updatable) Type of method to pass password.\n", "secret": true }, "vaultSecretId": { "type": "string", "description": "(Updatable) Vault secret OCID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "passwordType", "vaultSecretId" ] } } }, "oci:ApmSynthetics/ConfigConfigurationDatabaseWalletDetails:ConfigConfigurationDatabaseWalletDetails": { "properties": { "databaseWallet": { "type": "string", "description": "(Updatable) The database wallet configuration zip file.\n" }, "serviceName": { "type": "string", "description": "(Updatable) Service name of the database.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "databaseWallet", "serviceName" ] } } }, "oci:ApmSynthetics/ConfigConfigurationDnsConfiguration:ConfigConfigurationDnsConfiguration": { "properties": { "isOverrideDns": { "type": "boolean", "description": "(Updatable) If isOverrideDns is true, then DNS settings will be overridden.\n" }, "overrideDnsIp": { "type": "string", "description": "(Updatable) Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isOverrideDns", "overrideDnsIp" ] } } }, "oci:ApmSynthetics/ConfigConfigurationFtpBasicAuthenticationDetails:ConfigConfigurationFtpBasicAuthenticationDetails": { "properties": { "password": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationFtpBasicAuthenticationDetailsPassword:ConfigConfigurationFtpBasicAuthenticationDetailsPassword", "description": "(Updatable) Password.\n" }, "username": { "type": "string", "description": "(Updatable) Username for authentication.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "username" ] } } }, "oci:ApmSynthetics/ConfigConfigurationFtpBasicAuthenticationDetailsPassword:ConfigConfigurationFtpBasicAuthenticationDetailsPassword": { "properties": { "password": { "type": "string", "description": "(Updatable) Password.\n", "secret": true }, "passwordType": { "type": "string", "description": "(Updatable) Type of method to pass password.\n", "secret": true }, "vaultSecretId": { "type": "string", "description": "(Updatable) Vault secret OCID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "password", "passwordType", "vaultSecretId" ] } } }, "oci:ApmSynthetics/ConfigConfigurationNetworkConfiguration:ConfigConfigurationNetworkConfiguration": { "properties": { "numberOfHops": { "type": "integer", "description": "(Updatable) Number of hops.\n" }, "probeMode": { "type": "string", "description": "(Updatable) Type of probe mode when TCP protocol is selected.\n" }, "probePerHop": { "type": "integer", "description": "(Updatable) Number of probes per hop.\n" }, "protocol": { "type": "string", "description": "(Updatable) Type of protocol.\n" }, "transmissionRate": { "type": "integer", "description": "(Updatable) Number of probe packets sent out simultaneously.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "numberOfHops", "probeMode", "probePerHop", "protocol", "transmissionRate" ] } } }, "oci:ApmSynthetics/ConfigConfigurationReqAuthenticationDetails:ConfigConfigurationReqAuthenticationDetails": { "properties": { "authHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/ConfigConfigurationReqAuthenticationDetailsAuthHeader:ConfigConfigurationReqAuthenticationDetailsAuthHeader" }, "description": "(Updatable) List of authentication headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`\n" }, "authRequestMethod": { "type": "string", "description": "(Updatable) Request method.\n" }, "authRequestPostBody": { "type": "string", "description": "(Updatable) Request post body.\n" }, "authToken": { "type": "string", "description": "(Updatable) Authentication token.\n" }, "authUrl": { "type": "string", "description": "(Updatable) URL to get authentication token.\n" }, "authUserName": { "type": "string", "description": "(Updatable) User name for authentication.\n" }, "authUserPassword": { "type": "string", "description": "(Updatable) User password for authentication.\n", "secret": true }, "oauthScheme": { "type": "string", "description": "(Updatable) Request HTTP OAuth scheme.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "authHeaders", "authRequestMethod", "authRequestPostBody", "authToken", "authUrl", "authUserName", "authUserPassword", "oauthScheme" ] } } }, "oci:ApmSynthetics/ConfigConfigurationReqAuthenticationDetailsAuthHeader:ConfigConfigurationReqAuthenticationDetailsAuthHeader": { "properties": { "headerName": { "type": "string", "description": "(Updatable) Name of the header.\n" }, "headerValue": { "type": "string", "description": "(Updatable) Value of the header.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "headerName", "headerValue" ] } } }, "oci:ApmSynthetics/ConfigConfigurationRequestHeader:ConfigConfigurationRequestHeader": { "properties": { "headerName": { "type": "string", "description": "(Updatable) Name of the header.\n" }, "headerValue": { "type": "string", "description": "(Updatable) Value of the header.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "headerName", "headerValue" ] } } }, "oci:ApmSynthetics/ConfigConfigurationRequestQueryParam:ConfigConfigurationRequestQueryParam": { "properties": { "paramName": { "type": "string", "description": "(Updatable) Name of request query parameter.\n" }, "paramValue": { "type": "string", "description": "(Updatable) Value of request query parameter.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "paramName", "paramValue" ] } } }, "oci:ApmSynthetics/ConfigConfigurationVerifyText:ConfigConfigurationVerifyText": { "properties": { "text": { "type": "string", "description": "(Updatable) Verification text in the response.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "text" ] } } }, "oci:ApmSynthetics/ConfigMaintenanceWindowSchedule:ConfigMaintenanceWindowSchedule": { "properties": { "timeEnded": { "type": "string", "description": "(Updatable) End time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeStarted": { "type": "string", "description": "(Updatable) Start time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "timeEnded", "timeStarted" ] } } }, "oci:ApmSynthetics/ConfigScriptParameter:ConfigScriptParameter": { "properties": { "isOverwritten": { "type": "boolean", "description": "If parameter value is default or overwritten.\n" }, "isSecret": { "type": "boolean", "description": "Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.\n" }, "monitorScriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/ConfigScriptParameterMonitorScriptParameter:ConfigScriptParameterMonitorScriptParameter" }, "description": "Details of the script parameter that can be used to overwrite the parameter present in the script.\n" }, "paramName": { "type": "string", "description": "(Updatable) Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "(Updatable) Value of the parameter.\n" } }, "type": "object", "required": [ "paramName", "paramValue" ], "language": { "nodejs": { "requiredOutputs": [ "isOverwritten", "isSecret", "monitorScriptParameters", "paramName", "paramValue" ] } } }, "oci:ApmSynthetics/ConfigScriptParameterMonitorScriptParameter:ConfigScriptParameterMonitorScriptParameter": { "properties": { "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "paramName", "paramValue" ] } } }, "oci:ApmSynthetics/ConfigVantagePoint:ConfigVantagePoint": { "properties": { "displayName": { "type": "string", "description": "Unique name that can be edited. The name should not contain any confidential information.\n" }, "name": { "type": "string", "description": "Name of the vantage point.\n" }, "workerLists": { "type": "array", "items": { "type": "string" }, "description": "List of workers running the assigned monitor.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "displayName", "name", "workerLists" ] } } }, "oci:ApmSynthetics/DedicatedVantagePointDvpStackDetails:DedicatedVantagePointDvpStackDetails": { "properties": { "dvpStackId": { "type": "string", "description": "(Updatable) Stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point.\n" }, "dvpStackType": { "type": "string", "description": "(Updatable) Type of stack.\n" }, "dvpStreamId": { "type": "string", "description": "(Updatable) Stream [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point.\n" }, "dvpVersion": { "type": "string", "description": "(Updatable) Version of the dedicated vantage point.\n" } }, "type": "object", "required": [ "dvpStackId", "dvpStackType", "dvpStreamId", "dvpVersion" ] }, "oci:ApmSynthetics/DedicatedVantagePointMonitorStatusCountMap:DedicatedVantagePointMonitorStatusCountMap": { "properties": { "disabled": { "type": "integer", "description": "Number of disabled monitors using the script.\n" }, "enabled": { "type": "integer", "description": "Number of enabled monitors using the script.\n" }, "invalid": { "type": "integer", "description": "Number of invalid monitors using the script.\n" }, "total": { "type": "integer", "description": "Total number of monitors using the script.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "disabled", "enabled", "invalid", "total" ] } } }, "oci:ApmSynthetics/OnPremiseVantagePointWorkerIdentityInfo:OnPremiseVantagePointWorkerIdentityInfo": { "properties": { "apmShortId": { "type": "string", "description": "Domain short id of the On-premise VP worker.\n" }, "collectorEndPoint": { "type": "string", "description": "Collector endpoint of the On-premise VP worker.\n" }, "regionName": { "type": "string", "description": "Domain region of the On-premise VP worker.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "apmShortId", "collectorEndPoint", "regionName" ] } } }, "oci:ApmSynthetics/OnPremiseVantagePointWorkerMonitorList:OnPremiseVantagePointWorkerMonitorList": { "properties": { "displayName": { "type": "string", "description": "Unique name that can be edited. The name should not contain any confidential information.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor.\n" }, "isRunNow": { "type": "boolean", "description": "If isRunNow is enabled, then the monitor will run immediately.\n" }, "monitorType": { "type": "string", "description": "Type of monitor.\n" }, "timeAssigned": { "type": "string", "description": "The time the resource was last assigned to an On-premise vantage point worker, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "id", "isRunNow", "monitorType", "timeAssigned" ] } } }, "oci:ApmSynthetics/OnPremiseVantagePointWorkerVersionDetail:OnPremiseVantagePointWorkerVersionDetail": { "properties": { "latestVersion": { "type": "string", "description": "Latest image version of the On-premise VP worker.\n" }, "minSupportedVersion": { "type": "string", "description": "Minimum supported image version of the On-premise VP worker.\n" }, "version": { "type": "string", "description": "Image version of the On-premise VP worker.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "latestVersion", "minSupportedVersion", "version" ] } } }, "oci:ApmSynthetics/OnPremiseVantagePointWorkersSummary:OnPremiseVantagePointWorkersSummary": { "properties": { "available": { "type": "integer", "description": "Number of available workers in a specific On-premise vantage point.\n" }, "availableCapabilities": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/OnPremiseVantagePointWorkersSummaryAvailableCapability:OnPremiseVantagePointWorkersSummaryAvailableCapability" }, "description": "List of available capabilities in a specific On-premise vantage point.\n" }, "disabled": { "type": "integer", "description": "Number of disabled workers in a specific On-premise vantage point.\n" }, "minVersion": { "type": "string", "description": "Minimum version among the workers in a specific On-premise vantage point.\n" }, "total": { "type": "integer", "description": "Total number of workers in a specific On-premise vantage point.\n" }, "used": { "type": "integer", "description": "Number of occupied workers in a specific On-premise vantage point.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "available", "availableCapabilities", "disabled", "minVersion", "total", "used" ] } } }, "oci:ApmSynthetics/OnPremiseVantagePointWorkersSummaryAvailableCapability:OnPremiseVantagePointWorkersSummaryAvailableCapability": { "properties": { "capability": { "type": "string", "description": "Capability of an On-premise vantage point worker.\n" }, "onPremiseVantagePointCount": { "type": "integer", "description": "Count of available capability in a specific On-premise vantage point.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capability", "onPremiseVantagePointCount" ] } } }, "oci:ApmSynthetics/ScriptMonitorStatusCountMap:ScriptMonitorStatusCountMap": { "properties": { "disabled": { "type": "integer", "description": "Number of disabled monitors using the script.\n" }, "enabled": { "type": "integer", "description": "Number of enabled monitors using the script.\n" }, "invalid": { "type": "integer", "description": "Number of invalid monitors using the script.\n" }, "total": { "type": "integer", "description": "Total number of monitors using the script.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "disabled", "enabled", "invalid", "total" ] } } }, "oci:ApmSynthetics/ScriptParameter:ScriptParameter": { "properties": { "isOverwritten": { "type": "boolean", "description": "If parameter value is default or overwritten.\n" }, "isSecret": { "type": "boolean", "description": "(Updatable) If the parameter value is secret and should be kept confidential, then set isSecret to true.\n" }, "paramName": { "type": "string", "description": "(Updatable) Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "(Updatable) Value of the parameter.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" }, "scriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/ScriptParameterScriptParameter:ScriptParameterScriptParameter" }, "description": "Details of the script parameters, paramName must be from the script content and these details can be used to overwrite the default parameter present in the script content.\n" } }, "type": "object", "required": [ "paramName" ], "language": { "nodejs": { "requiredOutputs": [ "isOverwritten", "isSecret", "paramName", "paramValue", "scriptParameters" ] } } }, "oci:ApmSynthetics/ScriptParameterScriptParameter:ScriptParameterScriptParameter": { "properties": { "isSecret": { "type": "boolean", "description": "If the parameter value is secret and should be kept confidential, then set isSecret to true.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isSecret", "paramName", "paramValue" ] } } }, "oci:ApmSynthetics/getDedicatedVantagePointDvpStackDetail:getDedicatedVantagePointDvpStackDetail": { "properties": { "dvpStackId": { "type": "string", "description": "Stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point.\n" }, "dvpStackType": { "type": "string", "description": "Type of stack.\n" }, "dvpStreamId": { "type": "string", "description": "Stream [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point.\n" }, "dvpVersion": { "type": "string", "description": "Version of the dedicated vantage point.\n" } }, "type": "object", "required": [ "dvpStackId", "dvpStackType", "dvpStreamId", "dvpVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getDedicatedVantagePointMonitorStatusCountMap:getDedicatedVantagePointMonitorStatusCountMap": { "properties": { "disabled": { "type": "integer", "description": "Number of disabled monitors using the script.\n" }, "enabled": { "type": "integer", "description": "Number of enabled monitors using the script.\n" }, "invalid": { "type": "integer", "description": "Number of invalid monitors using the script.\n" }, "total": { "type": "integer", "description": "Total number of monitors using the script.\n" } }, "type": "object", "required": [ "disabled", "enabled", "invalid", "total" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollection:getDedicatedVantagePointsDedicatedVantagePointCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollectionItem:getDedicatedVantagePointsDedicatedVantagePointCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollectionItem:getDedicatedVantagePointsDedicatedVantagePointCollectionItem": { "properties": { "apmDomainId": { "type": "string", "description": "The APM domain ID the request is intended for.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "dvpStackDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollectionItemDvpStackDetail:getDedicatedVantagePointsDedicatedVantagePointCollectionItemDvpStackDetail" }, "description": "Details of a Dedicated Vantage Point (DVP) stack in Resource Manager.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated vantage point.\n" }, "monitorStatusCountMaps": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollectionItemMonitorStatusCountMap:getDedicatedVantagePointsDedicatedVantagePointCollectionItemMonitorStatusCountMap" }, "description": "Details of the monitor count per state. Example: `{ \"total\" : 5, \"enabled\" : 3 , \"disabled\" : 2, \"invalid\" : 0 }`\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "region": { "type": "string", "description": "Name of the region.\n" }, "status": { "type": "string", "description": "A filter to return only the dedicated vantage points that match a given status.\n" }, "timeCreated": { "type": "string", "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" } }, "type": "object", "required": [ "apmDomainId", "definedTags", "displayName", "dvpStackDetails", "freeformTags", "id", "monitorStatusCountMaps", "name", "region", "status", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollectionItemDvpStackDetail:getDedicatedVantagePointsDedicatedVantagePointCollectionItemDvpStackDetail": { "properties": { "dvpStackId": { "type": "string", "description": "Stack [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point.\n" }, "dvpStackType": { "type": "string", "description": "Type of stack.\n" }, "dvpStreamId": { "type": "string", "description": "Stream [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Resource Manager stack for dedicated vantage point.\n" }, "dvpVersion": { "type": "string", "description": "Version of the dedicated vantage point.\n" } }, "type": "object", "required": [ "dvpStackId", "dvpStackType", "dvpStreamId", "dvpVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getDedicatedVantagePointsDedicatedVantagePointCollectionItemMonitorStatusCountMap:getDedicatedVantagePointsDedicatedVantagePointCollectionItemMonitorStatusCountMap": { "properties": { "disabled": { "type": "integer", "description": "Number of disabled monitors using the script.\n" }, "enabled": { "type": "integer", "description": "Number of enabled monitors using the script.\n" }, "invalid": { "type": "integer", "description": "Number of invalid monitors using the script.\n" }, "total": { "type": "integer", "description": "Total number of monitors using the script.\n" } }, "type": "object", "required": [ "disabled", "enabled", "invalid", "total" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getDedicatedVantagePointsFilter:getDedicatedVantagePointsFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmSynthetics/getMonitorAvailabilityConfiguration:getMonitorAvailabilityConfiguration": { "properties": { "maxAllowedFailuresPerInterval": { "type": "integer", "description": "Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.\n" }, "minAllowedRunsPerInterval": { "type": "integer", "description": "Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.\n" } }, "type": "object", "required": [ "maxAllowedFailuresPerInterval", "minAllowedRunsPerInterval" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfiguration:getMonitorConfiguration": { "properties": { "clientCertificateDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationClientCertificateDetail:getMonitorConfigurationClientCertificateDetail" }, "description": "Details for client certificate.\n" }, "configType": { "type": "string", "description": "Type of configuration.\n" }, "connectionString": { "type": "string", "description": "Database connection string.\n" }, "databaseAuthenticationDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationDatabaseAuthenticationDetail:getMonitorConfigurationDatabaseAuthenticationDetail" }, "description": "Details for basic authentication.\n" }, "databaseConnectionType": { "type": "string", "description": "Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.\n" }, "databaseRole": { "type": "string", "description": "Database role.\n" }, "databaseType": { "type": "string", "description": "Database type.\n" }, "databaseWalletDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationDatabaseWalletDetail:getMonitorConfigurationDatabaseWalletDetail" }, "description": "Details for database wallet.\n" }, "dnsConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationDnsConfiguration:getMonitorConfigurationDnsConfiguration" }, "description": "Information about the DNS settings.\n" }, "downloadSizeLimitInBytes": { "type": "integer", "description": "Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.\n" }, "ftpBasicAuthenticationDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationFtpBasicAuthenticationDetail:getMonitorConfigurationFtpBasicAuthenticationDetail" }, "description": "Details for basic authentication.\n" }, "ftpProtocol": { "type": "string", "description": "FTP protocol type.\n" }, "ftpRequestType": { "type": "string", "description": "FTP monitor request type.\n" }, "isActiveMode": { "type": "boolean", "description": "If enabled, Active mode will be used for the FTP connection. Not supported for SFTP protocol.\n" }, "isCertificateValidationEnabled": { "type": "boolean", "description": "If certificate validation is enabled, then the call will fail in case of certification errors.\n" }, "isDefaultSnapshotEnabled": { "type": "boolean", "description": "If disabled, auto snapshots are not collected.\n" }, "isFailureRetried": { "type": "boolean", "description": "If isFailureRetried is enabled, then a failed call will be retried.\n" }, "isQueryRecursive": { "type": "boolean", "description": "If isQueryRecursive is enabled, then queries will be sent recursively to the target server.\n" }, "isRedirectionEnabled": { "type": "boolean", "description": "If redirection is enabled, then redirects will be allowed while accessing target URL.\n" }, "nameServer": { "type": "string", "description": "Name of the server that will be used to perform DNS lookup.\n" }, "networkConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationNetworkConfiguration:getMonitorConfigurationNetworkConfiguration" }, "description": "Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.\n" }, "protocol": { "type": "string", "description": "Type of protocol.\n" }, "query": { "type": "string", "description": "SQL query to be executed.\n" }, "recordType": { "type": "string", "description": "DNS record type.\n" }, "reqAuthenticationDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationReqAuthenticationDetail:getMonitorConfigurationReqAuthenticationDetail" }, "description": "Details for request HTTP authentication.\n" }, "reqAuthenticationScheme": { "type": "string", "description": "Request HTTP authentication scheme.\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationRequestHeader:getMonitorConfigurationRequestHeader" }, "description": "List of request headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`\n" }, "requestMethod": { "type": "string", "description": "Request HTTP method.\n" }, "requestPostBody": { "type": "string", "description": "Request post body content.\n" }, "requestQueryParams": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationRequestQueryParam:getMonitorConfigurationRequestQueryParam" }, "description": "List of request query params. Example: `[{\"paramName\": \"sortOrder\", \"paramValue\": \"asc\"}]`\n" }, "uploadFileSizeInBytes": { "type": "integer", "description": "File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.\n" }, "verifyResponseCodes": { "type": "array", "items": { "type": "string" }, "description": "Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.\n" }, "verifyResponseContent": { "type": "string", "description": "Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.\n" }, "verifyTexts": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationVerifyText:getMonitorConfigurationVerifyText" }, "description": "Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.\n" } }, "type": "object", "required": [ "clientCertificateDetails", "configType", "connectionString", "databaseAuthenticationDetails", "databaseConnectionType", "databaseRole", "databaseType", "databaseWalletDetails", "dnsConfigurations", "downloadSizeLimitInBytes", "ftpBasicAuthenticationDetails", "ftpProtocol", "ftpRequestType", "isActiveMode", "isCertificateValidationEnabled", "isDefaultSnapshotEnabled", "isFailureRetried", "isQueryRecursive", "isRedirectionEnabled", "nameServer", "networkConfigurations", "protocol", "query", "recordType", "reqAuthenticationDetails", "reqAuthenticationScheme", "requestHeaders", "requestMethod", "requestPostBody", "requestQueryParams", "uploadFileSizeInBytes", "verifyResponseCodes", "verifyResponseContent", "verifyTexts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationClientCertificateDetail:getMonitorConfigurationClientCertificateDetail": { "properties": { "clientCertificates": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationClientCertificateDetailClientCertificate:getMonitorConfigurationClientCertificateDetailClientCertificate" }, "description": "Client certificate in PEM format.\n" }, "privateKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationClientCertificateDetailPrivateKey:getMonitorConfigurationClientCertificateDetailPrivateKey" }, "description": "The private key associated with the client certificate in PEM format.\n" } }, "type": "object", "required": [ "clientCertificates", "privateKeys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationClientCertificateDetailClientCertificate:getMonitorConfigurationClientCertificateDetailClientCertificate": { "properties": { "content": { "type": "string", "description": "Content of the private key file.\n" }, "fileName": { "type": "string", "description": "Name of the private key file.\n" } }, "type": "object", "required": [ "content", "fileName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationClientCertificateDetailPrivateKey:getMonitorConfigurationClientCertificateDetailPrivateKey": { "properties": { "content": { "type": "string", "description": "Content of the private key file.\n" }, "fileName": { "type": "string", "description": "Name of the private key file.\n" } }, "type": "object", "required": [ "content", "fileName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationDatabaseAuthenticationDetail:getMonitorConfigurationDatabaseAuthenticationDetail": { "properties": { "passwords": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationDatabaseAuthenticationDetailPassword:getMonitorConfigurationDatabaseAuthenticationDetailPassword" }, "description": "Password.\n" }, "username": { "type": "string", "description": "Username for authentication.\n" } }, "type": "object", "required": [ "passwords", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationDatabaseAuthenticationDetailPassword:getMonitorConfigurationDatabaseAuthenticationDetailPassword": { "properties": { "password": { "type": "string", "description": "Password.\n", "secret": true }, "passwordType": { "type": "string", "description": "Type of method to pass password.\n", "secret": true }, "vaultSecretId": { "type": "string", "description": "Vault secret OCID.\n" } }, "type": "object", "required": [ "password", "passwordType", "vaultSecretId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationDatabaseWalletDetail:getMonitorConfigurationDatabaseWalletDetail": { "properties": { "databaseWallet": { "type": "string", "description": "The database wallet configuration zip file.\n" }, "serviceName": { "type": "string", "description": "Service name of the database.\n" } }, "type": "object", "required": [ "databaseWallet", "serviceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationDnsConfiguration:getMonitorConfigurationDnsConfiguration": { "properties": { "isOverrideDns": { "type": "boolean", "description": "If isOverrideDns is true, then DNS settings will be overridden.\n" }, "overrideDnsIp": { "type": "string", "description": "Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.\n" } }, "type": "object", "required": [ "isOverrideDns", "overrideDnsIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationFtpBasicAuthenticationDetail:getMonitorConfigurationFtpBasicAuthenticationDetail": { "properties": { "passwords": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationFtpBasicAuthenticationDetailPassword:getMonitorConfigurationFtpBasicAuthenticationDetailPassword" }, "description": "Password.\n" }, "username": { "type": "string", "description": "Username for authentication.\n" } }, "type": "object", "required": [ "passwords", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationFtpBasicAuthenticationDetailPassword:getMonitorConfigurationFtpBasicAuthenticationDetailPassword": { "properties": { "password": { "type": "string", "description": "Password.\n", "secret": true }, "passwordType": { "type": "string", "description": "Type of method to pass password.\n", "secret": true }, "vaultSecretId": { "type": "string", "description": "Vault secret OCID.\n" } }, "type": "object", "required": [ "password", "passwordType", "vaultSecretId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationNetworkConfiguration:getMonitorConfigurationNetworkConfiguration": { "properties": { "numberOfHops": { "type": "integer", "description": "Number of hops.\n" }, "probeMode": { "type": "string", "description": "Type of probe mode when TCP protocol is selected.\n" }, "probePerHop": { "type": "integer", "description": "Number of probes per hop.\n" }, "protocol": { "type": "string", "description": "Type of protocol.\n" }, "transmissionRate": { "type": "integer", "description": "Number of probe packets sent out simultaneously.\n" } }, "type": "object", "required": [ "numberOfHops", "probeMode", "probePerHop", "protocol", "transmissionRate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationReqAuthenticationDetail:getMonitorConfigurationReqAuthenticationDetail": { "properties": { "authHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorConfigurationReqAuthenticationDetailAuthHeader:getMonitorConfigurationReqAuthenticationDetailAuthHeader" }, "description": "List of authentication headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`\n" }, "authRequestMethod": { "type": "string", "description": "Request method.\n" }, "authRequestPostBody": { "type": "string", "description": "Request post body.\n" }, "authToken": { "type": "string", "description": "Authentication token.\n" }, "authUrl": { "type": "string", "description": "URL to get authentication token.\n" }, "authUserName": { "type": "string", "description": "User name for authentication.\n" }, "authUserPassword": { "type": "string", "description": "User password for authentication.\n", "secret": true }, "oauthScheme": { "type": "string", "description": "Request HTTP OAuth scheme.\n" } }, "type": "object", "required": [ "authHeaders", "authRequestMethod", "authRequestPostBody", "authToken", "authUrl", "authUserName", "authUserPassword", "oauthScheme" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationReqAuthenticationDetailAuthHeader:getMonitorConfigurationReqAuthenticationDetailAuthHeader": { "properties": { "headerName": { "type": "string", "description": "Name of the header.\n" }, "headerValue": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "headerName", "headerValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationRequestHeader:getMonitorConfigurationRequestHeader": { "properties": { "headerName": { "type": "string", "description": "Name of the header.\n" }, "headerValue": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "headerName", "headerValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationRequestQueryParam:getMonitorConfigurationRequestQueryParam": { "properties": { "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorConfigurationVerifyText:getMonitorConfigurationVerifyText": { "properties": { "text": { "type": "string", "description": "Verification text in the response.\n" } }, "type": "object", "required": [ "text" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorMaintenanceWindowSchedule:getMonitorMaintenanceWindowSchedule": { "properties": { "timeEnded": { "type": "string", "description": "End time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeStarted": { "type": "string", "description": "Start time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" } }, "type": "object", "required": [ "timeEnded", "timeStarted" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorScriptParameter:getMonitorScriptParameter": { "properties": { "isOverwritten": { "type": "boolean", "description": "If parameter value is default or overwritten.\n" }, "isSecret": { "type": "boolean", "description": "Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.\n" }, "monitorScriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorScriptParameterMonitorScriptParameter:getMonitorScriptParameterMonitorScriptParameter" }, "description": "Details of the script parameter that can be used to overwrite the parameter present in the script.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "isOverwritten", "isSecret", "monitorScriptParameters", "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorScriptParameterMonitorScriptParameter:getMonitorScriptParameterMonitorScriptParameter": { "properties": { "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorVantagePoint:getMonitorVantagePoint": { "properties": { "displayName": { "type": "string", "description": "Unique name that can be edited. The name should not contain any confidential information.\n" }, "name": { "type": "string", "description": "Name of the vantage point.\n" }, "workerLists": { "type": "array", "items": { "type": "string" }, "description": "List of workers running the assigned monitor.\n" } }, "type": "object", "required": [ "displayName", "name", "workerLists" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsFilter:getMonitorsFilter": { "properties": { "name": { "type": "string", "description": "Name of the vantage point.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmSynthetics/getMonitorsMonitorCollection:getMonitorsMonitorCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItem:getMonitorsMonitorCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItem:getMonitorsMonitorCollectionItem": { "properties": { "apmDomainId": { "type": "string", "description": "The APM domain ID the request is intended for.\n" }, "availabilityConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemAvailabilityConfiguration:getMonitorsMonitorCollectionItemAvailabilityConfiguration" }, "description": "Monitor availability configuration details.\n" }, "batchIntervalInSeconds": { "type": "integer", "description": "Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfiguration:getMonitorsMonitorCollectionItemConfiguration" }, "description": "Details of monitor configuration.\n" }, "contentType": { "type": "string", "description": "Content type of the script.\n" }, "createdBy": { "type": "string", "description": "Name of the user that created the monitor.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor.\n" }, "isIpv6": { "type": "boolean", "description": "If enabled, domain name will resolve to an IPv6 address.\n" }, "isRunNow": { "type": "boolean", "description": "If isRunNow is enabled, then the monitor will run immediately.\n" }, "isRunOnce": { "type": "boolean", "description": "If runOnce is enabled, then the monitor will run once.\n" }, "lastUpdatedBy": { "type": "string", "description": "Name of the user that recently updated the monitor.\n" }, "maintenanceWindowSchedules": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemMaintenanceWindowSchedule:getMonitorsMonitorCollectionItemMaintenanceWindowSchedule" }, "description": "Details required to schedule maintenance window.\n" }, "monitorType": { "type": "string", "description": "A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.\n" }, "repeatIntervalInSeconds": { "type": "integer", "description": "Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.\n" }, "schedulingPolicy": { "type": "string", "description": "Scheduling policy to decide the distribution of monitor executions on vantage points.\n" }, "scriptId": { "type": "string", "description": "A filter to return only monitors using scriptId.\n" }, "scriptName": { "type": "string", "description": "Name of the script.\n" }, "scriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemScriptParameter:getMonitorsMonitorCollectionItemScriptParameter" }, "description": "List of script parameters. Example: `[{\"monitorScriptParameter\": {\"paramName\": \"userid\", \"paramValue\":\"testuser\"}, \"isSecret\": false, \"isOverwritten\": false}]`\n" }, "status": { "type": "string", "description": "A filter to return only monitors that match the status given.\n" }, "target": { "type": "string", "description": "Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.\n" }, "timeCreated": { "type": "string", "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" }, "timeoutInSeconds": { "type": "integer", "description": "Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.\n" }, "vantagePointCount": { "type": "integer", "description": "Number of vantage points where monitor is running.\n" }, "vantagePoints": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemVantagePoint:getMonitorsMonitorCollectionItemVantagePoint" }, "description": "List of public, dedicated and onPremise vantage points where the monitor is running.\n" } }, "type": "object", "required": [ "apmDomainId", "availabilityConfigurations", "batchIntervalInSeconds", "configurations", "contentType", "createdBy", "definedTags", "displayName", "freeformTags", "id", "isIpv6", "isRunNow", "isRunOnce", "lastUpdatedBy", "maintenanceWindowSchedules", "monitorType", "repeatIntervalInSeconds", "schedulingPolicy", "scriptId", "scriptName", "scriptParameters", "status", "target", "timeCreated", "timeUpdated", "timeoutInSeconds", "vantagePointCount", "vantagePoints" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemAvailabilityConfiguration:getMonitorsMonitorCollectionItemAvailabilityConfiguration": { "properties": { "maxAllowedFailuresPerInterval": { "type": "integer", "description": "Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.\n" }, "minAllowedRunsPerInterval": { "type": "integer", "description": "Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.\n" } }, "type": "object", "required": [ "maxAllowedFailuresPerInterval", "minAllowedRunsPerInterval" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfiguration:getMonitorsMonitorCollectionItemConfiguration": { "properties": { "clientCertificateDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationClientCertificateDetail:getMonitorsMonitorCollectionItemConfigurationClientCertificateDetail" }, "description": "Details for client certificate.\n" }, "configType": { "type": "string", "description": "Type of configuration.\n" }, "connectionString": { "type": "string", "description": "Database connection string.\n" }, "databaseAuthenticationDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail:getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail" }, "description": "Details for basic authentication.\n" }, "databaseConnectionType": { "type": "string", "description": "Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.\n" }, "databaseRole": { "type": "string", "description": "Database role.\n" }, "databaseType": { "type": "string", "description": "Database type.\n" }, "databaseWalletDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail:getMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail" }, "description": "Details for database wallet.\n" }, "dnsConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDnsConfiguration:getMonitorsMonitorCollectionItemConfigurationDnsConfiguration" }, "description": "Information about the DNS settings.\n" }, "downloadSizeLimitInBytes": { "type": "integer", "description": "Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.\n" }, "ftpBasicAuthenticationDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail:getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail" }, "description": "Details for basic authentication.\n" }, "ftpProtocol": { "type": "string", "description": "FTP protocol type.\n" }, "ftpRequestType": { "type": "string", "description": "FTP monitor request type.\n" }, "isActiveMode": { "type": "boolean", "description": "If enabled, Active mode will be used for the FTP connection. Not supported for SFTP protocol.\n" }, "isCertificateValidationEnabled": { "type": "boolean", "description": "If certificate validation is enabled, then the call will fail in case of certification errors.\n" }, "isDefaultSnapshotEnabled": { "type": "boolean", "description": "If disabled, auto snapshots are not collected.\n" }, "isFailureRetried": { "type": "boolean", "description": "If isFailureRetried is enabled, then a failed call will be retried.\n" }, "isQueryRecursive": { "type": "boolean", "description": "If isQueryRecursive is enabled, then queries will be sent recursively to the target server.\n" }, "isRedirectionEnabled": { "type": "boolean", "description": "If redirection is enabled, then redirects will be allowed while accessing target URL.\n" }, "nameServer": { "type": "string", "description": "Name of the server that will be used to perform DNS lookup.\n" }, "networkConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationNetworkConfiguration:getMonitorsMonitorCollectionItemConfigurationNetworkConfiguration" }, "description": "Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.\n" }, "protocol": { "type": "string", "description": "Type of protocol.\n" }, "query": { "type": "string", "description": "SQL query to be executed.\n" }, "recordType": { "type": "string", "description": "DNS record type.\n" }, "reqAuthenticationDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail:getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail" }, "description": "Details for request HTTP authentication.\n" }, "reqAuthenticationScheme": { "type": "string", "description": "Request HTTP authentication scheme.\n" }, "requestHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationRequestHeader:getMonitorsMonitorCollectionItemConfigurationRequestHeader" }, "description": "List of request headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`\n" }, "requestMethod": { "type": "string", "description": "Request HTTP method.\n" }, "requestPostBody": { "type": "string", "description": "Request post body content.\n" }, "requestQueryParams": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationRequestQueryParam:getMonitorsMonitorCollectionItemConfigurationRequestQueryParam" }, "description": "List of request query params. Example: `[{\"paramName\": \"sortOrder\", \"paramValue\": \"asc\"}]`\n" }, "uploadFileSizeInBytes": { "type": "integer", "description": "File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.\n" }, "verifyResponseCodes": { "type": "array", "items": { "type": "string" }, "description": "Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.\n" }, "verifyResponseContent": { "type": "string", "description": "Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.\n" }, "verifyTexts": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationVerifyText:getMonitorsMonitorCollectionItemConfigurationVerifyText" }, "description": "Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.\n" } }, "type": "object", "required": [ "clientCertificateDetails", "configType", "connectionString", "databaseAuthenticationDetails", "databaseConnectionType", "databaseRole", "databaseType", "databaseWalletDetails", "dnsConfigurations", "downloadSizeLimitInBytes", "ftpBasicAuthenticationDetails", "ftpProtocol", "ftpRequestType", "isActiveMode", "isCertificateValidationEnabled", "isDefaultSnapshotEnabled", "isFailureRetried", "isQueryRecursive", "isRedirectionEnabled", "nameServer", "networkConfigurations", "protocol", "query", "recordType", "reqAuthenticationDetails", "reqAuthenticationScheme", "requestHeaders", "requestMethod", "requestPostBody", "requestQueryParams", "uploadFileSizeInBytes", "verifyResponseCodes", "verifyResponseContent", "verifyTexts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationClientCertificateDetail:getMonitorsMonitorCollectionItemConfigurationClientCertificateDetail": { "properties": { "clientCertificates": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate:getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate" }, "description": "Client certificate in PEM format.\n" }, "privateKeys": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey:getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey" }, "description": "The private key associated with the client certificate in PEM format.\n" } }, "type": "object", "required": [ "clientCertificates", "privateKeys" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate:getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate": { "properties": { "content": { "type": "string", "description": "Content of the private key file.\n" }, "fileName": { "type": "string", "description": "Name of the private key file.\n" } }, "type": "object", "required": [ "content", "fileName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey:getMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey": { "properties": { "content": { "type": "string", "description": "Content of the private key file.\n" }, "fileName": { "type": "string", "description": "Name of the private key file.\n" } }, "type": "object", "required": [ "content", "fileName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail:getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail": { "properties": { "passwords": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword:getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword" }, "description": "Password.\n" }, "username": { "type": "string", "description": "Username for authentication.\n" } }, "type": "object", "required": [ "passwords", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword:getMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword": { "properties": { "password": { "type": "string", "description": "Password.\n", "secret": true }, "passwordType": { "type": "string", "description": "Type of method to pass password.\n", "secret": true }, "vaultSecretId": { "type": "string", "description": "Vault secret OCID.\n" } }, "type": "object", "required": [ "password", "passwordType", "vaultSecretId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail:getMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail": { "properties": { "databaseWallet": { "type": "string", "description": "The database wallet configuration zip file.\n" }, "serviceName": { "type": "string", "description": "Service name of the database.\n" } }, "type": "object", "required": [ "databaseWallet", "serviceName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationDnsConfiguration:getMonitorsMonitorCollectionItemConfigurationDnsConfiguration": { "properties": { "isOverrideDns": { "type": "boolean", "description": "If isOverrideDns is true, then DNS settings will be overridden.\n" }, "overrideDnsIp": { "type": "string", "description": "Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.\n" } }, "type": "object", "required": [ "isOverrideDns", "overrideDnsIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail:getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail": { "properties": { "passwords": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword:getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword" }, "description": "Password.\n" }, "username": { "type": "string", "description": "Username for authentication.\n" } }, "type": "object", "required": [ "passwords", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword:getMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword": { "properties": { "password": { "type": "string", "description": "Password.\n", "secret": true }, "passwordType": { "type": "string", "description": "Type of method to pass password.\n", "secret": true }, "vaultSecretId": { "type": "string", "description": "Vault secret OCID.\n" } }, "type": "object", "required": [ "password", "passwordType", "vaultSecretId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationNetworkConfiguration:getMonitorsMonitorCollectionItemConfigurationNetworkConfiguration": { "properties": { "numberOfHops": { "type": "integer", "description": "Number of hops.\n" }, "probeMode": { "type": "string", "description": "Type of probe mode when TCP protocol is selected.\n" }, "probePerHop": { "type": "integer", "description": "Number of probes per hop.\n" }, "protocol": { "type": "string", "description": "Type of protocol.\n" }, "transmissionRate": { "type": "integer", "description": "Number of probe packets sent out simultaneously.\n" } }, "type": "object", "required": [ "numberOfHops", "probeMode", "probePerHop", "protocol", "transmissionRate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail:getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail": { "properties": { "authHeaders": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader:getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader" }, "description": "List of authentication headers. Example: `[{\"headerName\": \"content-type\", \"headerValue\":\"json\"}]`\n" }, "authRequestMethod": { "type": "string", "description": "Request method.\n" }, "authRequestPostBody": { "type": "string", "description": "Request post body.\n" }, "authToken": { "type": "string", "description": "Authentication token.\n" }, "authUrl": { "type": "string", "description": "URL to get authentication token.\n" }, "authUserName": { "type": "string", "description": "User name for authentication.\n" }, "authUserPassword": { "type": "string", "description": "User password for authentication.\n", "secret": true }, "oauthScheme": { "type": "string", "description": "Request HTTP OAuth scheme.\n" } }, "type": "object", "required": [ "authHeaders", "authRequestMethod", "authRequestPostBody", "authToken", "authUrl", "authUserName", "authUserPassword", "oauthScheme" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader:getMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader": { "properties": { "headerName": { "type": "string", "description": "Name of the header.\n" }, "headerValue": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "headerName", "headerValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationRequestHeader:getMonitorsMonitorCollectionItemConfigurationRequestHeader": { "properties": { "headerName": { "type": "string", "description": "Name of the header.\n" }, "headerValue": { "type": "string", "description": "Value of the header.\n" } }, "type": "object", "required": [ "headerName", "headerValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationRequestQueryParam:getMonitorsMonitorCollectionItemConfigurationRequestQueryParam": { "properties": { "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemConfigurationVerifyText:getMonitorsMonitorCollectionItemConfigurationVerifyText": { "properties": { "text": { "type": "string", "description": "Verification text in the response.\n" } }, "type": "object", "required": [ "text" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemMaintenanceWindowSchedule:getMonitorsMonitorCollectionItemMaintenanceWindowSchedule": { "properties": { "timeEnded": { "type": "string", "description": "End time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeStarted": { "type": "string", "description": "Start time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" } }, "type": "object", "required": [ "timeEnded", "timeStarted" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemScriptParameter:getMonitorsMonitorCollectionItemScriptParameter": { "properties": { "isOverwritten": { "type": "boolean", "description": "If parameter value is default or overwritten.\n" }, "isSecret": { "type": "boolean", "description": "Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.\n" }, "monitorScriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter:getMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter" }, "description": "Details of the script parameter that can be used to overwrite the parameter present in the script.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "isOverwritten", "isSecret", "monitorScriptParameters", "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter:getMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter": { "properties": { "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getMonitorsMonitorCollectionItemVantagePoint:getMonitorsMonitorCollectionItemVantagePoint": { "properties": { "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "name": { "type": "string", "description": "Name of the vantage point.\n" }, "workerLists": { "type": "array", "items": { "type": "string" }, "description": "List of workers running the assigned monitor.\n" } }, "type": "object", "required": [ "displayName", "name", "workerLists" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkerIdentityInfo:getOnPremiseVantagePointWorkerIdentityInfo": { "properties": { "apmShortId": { "type": "string", "description": "Domain short id of the On-premise VP worker.\n" }, "collectorEndPoint": { "type": "string", "description": "Collector endpoint of the On-premise VP worker.\n" }, "regionName": { "type": "string", "description": "Domain region of the On-premise VP worker.\n" } }, "type": "object", "required": [ "apmShortId", "collectorEndPoint", "regionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkerMonitorList:getOnPremiseVantagePointWorkerMonitorList": { "properties": { "displayName": { "type": "string", "description": "Unique name that can be edited. The name should not contain any confidential information.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor.\n" }, "isRunNow": { "type": "boolean", "description": "If isRunNow is enabled, then the monitor will run immediately.\n" }, "monitorType": { "type": "string", "description": "Type of monitor.\n" }, "timeAssigned": { "type": "string", "description": "The time the resource was last assigned to an On-premise vantage point worker, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" } }, "type": "object", "required": [ "displayName", "id", "isRunNow", "monitorType", "timeAssigned" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkerVersionDetail:getOnPremiseVantagePointWorkerVersionDetail": { "properties": { "latestVersion": { "type": "string", "description": "Latest image version of the On-premise VP worker.\n" }, "minSupportedVersion": { "type": "string", "description": "Minimum supported image version of the On-premise VP worker.\n" }, "version": { "type": "string", "description": "Current image version of the On-premise VP worker.\n" } }, "type": "object", "required": [ "latestVersion", "minSupportedVersion", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersFilter:getOnPremiseVantagePointWorkersFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersSummary:getOnPremiseVantagePointWorkersSummary": { "properties": { "available": { "type": "integer", "description": "Number of available workers in a specific On-premise vantage point.\n" }, "availableCapabilities": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointWorkersSummaryAvailableCapability:getOnPremiseVantagePointWorkersSummaryAvailableCapability" }, "description": "List of available capabilities in a specific On-premise vantage point.\n" }, "disabled": { "type": "integer", "description": "Number of disabled workers in a specific On-premise vantage point.\n" }, "minVersion": { "type": "string", "description": "Minimum version among the workers in a specific On-premise vantage point.\n" }, "total": { "type": "integer", "description": "Total number of workers in a specific On-premise vantage point.\n" }, "used": { "type": "integer", "description": "Number of occupied workers in a specific On-premise vantage point.\n" } }, "type": "object", "required": [ "available", "availableCapabilities", "disabled", "minVersion", "total", "used" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersSummaryAvailableCapability:getOnPremiseVantagePointWorkersSummaryAvailableCapability": { "properties": { "capability": { "type": "string", "description": "Capability of an On-premise vantage point worker.\n" }, "onPremiseVantagePointCount": { "type": "integer", "description": "Count of available capability in a specific On-premise vantage point.\n" } }, "type": "object", "required": [ "capability", "onPremiseVantagePointCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollection:getOnPremiseVantagePointWorkersWorkerCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItem:getOnPremiseVantagePointWorkersWorkerCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItem:getOnPremiseVantagePointWorkersWorkerCollectionItem": { "properties": { "apmDomainId": { "type": "string", "description": "The APM domain ID the request is intended for.\n" }, "configurationDetails": { "type": "string", "description": "Configuration details of the On-premise VP worker.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "geoInfo": { "type": "string", "description": "Geographical information of the On-premise VP worker.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor.\n" }, "identityInfos": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItemIdentityInfo:getOnPremiseVantagePointWorkersWorkerCollectionItemIdentityInfo" }, "description": "Domain details of the On-premise VP worker.\n" }, "monitorLists": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItemMonitorList:getOnPremiseVantagePointWorkersWorkerCollectionItemMonitorList" }, "description": "Monitors list assigned to the On-premise VP worker.\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "onPremiseVantagePointId": { "type": "string", "description": "The OCID of the On-premise vantage point.\n" }, "opvpId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the On-premise vantage point.\n" }, "opvpName": { "type": "string", "description": "On-premise vantage point name.\n" }, "priority": { "type": "integer", "description": "Priority of the On-premise VP worker to schedule monitors.\n" }, "resourcePrincipalTokenPublicKey": { "type": "string" }, "runtimeId": { "type": "string", "description": "The runtime assigned id of the On-premise VP worker.\n" }, "status": { "type": "string", "description": "A filter to return only On-premise VP workers that match the status given.\n" }, "timeCreated": { "type": "string", "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeLastSyncUp": { "type": "string", "description": "The time the resource was last synced, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" }, "version": { "type": "string", "description": "Current image version of the On-premise VP worker.\n" }, "versionDetails": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItemVersionDetail:getOnPremiseVantagePointWorkersWorkerCollectionItemVersionDetail" }, "description": "Image version details of the On-premise VP worker.\n" }, "workerType": { "type": "string", "description": "Type of the On-premise VP worker.\n" } }, "type": "object", "required": [ "apmDomainId", "configurationDetails", "definedTags", "displayName", "freeformTags", "geoInfo", "id", "identityInfos", "monitorLists", "name", "onPremiseVantagePointId", "opvpId", "opvpName", "priority", "resourcePrincipalTokenPublicKey", "runtimeId", "status", "timeCreated", "timeLastSyncUp", "timeUpdated", "version", "versionDetails", "workerType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItemIdentityInfo:getOnPremiseVantagePointWorkersWorkerCollectionItemIdentityInfo": { "properties": { "apmShortId": { "type": "string", "description": "Domain short id of the On-premise VP worker.\n" }, "collectorEndPoint": { "type": "string", "description": "Collector endpoint of the On-premise VP worker.\n" }, "regionName": { "type": "string", "description": "Domain region of the On-premise VP worker.\n" } }, "type": "object", "required": [ "apmShortId", "collectorEndPoint", "regionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItemMonitorList:getOnPremiseVantagePointWorkersWorkerCollectionItemMonitorList": { "properties": { "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the monitor.\n" }, "isRunNow": { "type": "boolean", "description": "If isRunNow is enabled, then the monitor will run immediately.\n" }, "monitorType": { "type": "string", "description": "Type of monitor.\n" }, "timeAssigned": { "type": "string", "description": "The time the resource was last assigned to an On-premise vantage point worker, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" } }, "type": "object", "required": [ "displayName", "id", "isRunNow", "monitorType", "timeAssigned" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointWorkersWorkerCollectionItemVersionDetail:getOnPremiseVantagePointWorkersWorkerCollectionItemVersionDetail": { "properties": { "latestVersion": { "type": "string", "description": "Latest image version of the On-premise VP worker.\n" }, "minSupportedVersion": { "type": "string", "description": "Minimum supported image version of the On-premise VP worker.\n" }, "version": { "type": "string", "description": "Current image version of the On-premise VP worker.\n" } }, "type": "object", "required": [ "latestVersion", "minSupportedVersion", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointsFilter:getOnPremiseVantagePointsFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollection:getOnPremiseVantagePointsOnPremiseVantagePointCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollectionItem:getOnPremiseVantagePointsOnPremiseVantagePointCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollectionItem:getOnPremiseVantagePointsOnPremiseVantagePointCollectionItem": { "properties": { "apmDomainId": { "type": "string", "description": "The APM domain ID the request is intended for.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A short description about the On-premise vantage point.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the On-premise vantage point.\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "timeCreated": { "type": "string", "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" }, "type": { "type": "string", "description": "Type of On-premise vantage point.\n" }, "workersSummaries": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary:getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary" }, "description": "Details of the workers in a specific On-premise vantage point.\n" } }, "type": "object", "required": [ "apmDomainId", "definedTags", "description", "displayName", "freeformTags", "id", "name", "timeCreated", "timeUpdated", "type", "workersSummaries" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary:getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary": { "properties": { "available": { "type": "integer", "description": "Number of available workers in a specific On-premise vantage point.\n" }, "availableCapabilities": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability:getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability" }, "description": "List of available capabilities in a specific On-premise vantage point.\n" }, "disabled": { "type": "integer", "description": "Number of disabled workers in a specific On-premise vantage point.\n" }, "minVersion": { "type": "string", "description": "Minimum version among the workers in a specific On-premise vantage point.\n" }, "total": { "type": "integer", "description": "Total number of workers in a specific On-premise vantage point.\n" }, "used": { "type": "integer", "description": "Number of occupied workers in a specific On-premise vantage point.\n" } }, "type": "object", "required": [ "available", "availableCapabilities", "disabled", "minVersion", "total", "used" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability:getOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability": { "properties": { "capability": { "type": "string", "description": "Capability of an On-premise vantage point worker.\n" }, "onPremiseVantagePointCount": { "type": "integer", "description": "Count of available capability in a specific On-premise vantage point.\n" } }, "type": "object", "required": [ "capability", "onPremiseVantagePointCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getResultResultDataSet:getResultResultDataSet": { "properties": { "byteContent": { "type": "string", "description": "Data content in byte format. Example: Zip or Screenshot.\n" }, "name": { "type": "string", "description": "Name of the data.\n" }, "stringContent": { "type": "string", "description": "Data content in string format. Example: HAR.\n" }, "timestamp": { "type": "string", "description": "The time when the data was generated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" } }, "type": "object", "required": [ "byteContent", "name", "stringContent", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptMonitorStatusCountMap:getScriptMonitorStatusCountMap": { "properties": { "disabled": { "type": "integer", "description": "Number of disabled monitors using the script.\n" }, "enabled": { "type": "integer", "description": "Number of enabled monitors using the script.\n" }, "invalid": { "type": "integer", "description": "Number of invalid monitors using the script.\n" }, "total": { "type": "integer", "description": "Total number of monitors using the script.\n" } }, "type": "object", "required": [ "disabled", "enabled", "invalid", "total" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptParameter:getScriptParameter": { "properties": { "isOverwritten": { "type": "boolean", "description": "If parameter value is default or overwritten.\n" }, "isSecret": { "type": "boolean", "description": "If the parameter value is secret and should be kept confidential, then set isSecret to true.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" }, "scriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getScriptParameterScriptParameter:getScriptParameterScriptParameter" }, "description": "Details of the script parameters, paramName must be from the script content and these details can be used to overwrite the default parameter present in the script content.\n" } }, "type": "object", "required": [ "isOverwritten", "isSecret", "paramName", "paramValue", "scriptParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptParameterScriptParameter:getScriptParameterScriptParameter": { "properties": { "isSecret": { "type": "boolean", "description": "If the parameter value is secret and should be kept confidential, then set isSecret to true.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "isSecret", "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptsFilter:getScriptsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmSynthetics/getScriptsScriptCollection:getScriptsScriptCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getScriptsScriptCollectionItem:getScriptsScriptCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptsScriptCollectionItem:getScriptsScriptCollectionItem": { "properties": { "apmDomainId": { "type": "string", "description": "The APM domain ID the request is intended for.\n" }, "content": { "type": "string", "description": "The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `\u003cORAP\u003e\u003cON\u003eparam name\u003c/ON\u003e\u003cOV\u003eparam value\u003c/OV\u003e\u003cOS\u003eisParamValueSecret(true/false)\u003c/OS\u003e\u003c/ORAP\u003e`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `\u003cORAP\u003e\u003cON\u003eparam name\u003c/ON\u003e\u003c/ORAP\u003e` With parameter name and value : `\u003cORAP\u003e\u003cON\u003eparam name\u003c/ON\u003e\u003cOV\u003eparam value\u003c/OV\u003e\u003c/ORAP\u003e` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format.\n" }, "contentFileName": { "type": "string", "description": "File name of the uploaded script content.\n" }, "contentSizeInBytes": { "type": "integer", "description": "Size of the script content.\n" }, "contentType": { "type": "string", "description": "A filter to return only resources that match the content type given.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.\n" }, "monitorStatusCountMaps": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getScriptsScriptCollectionItemMonitorStatusCountMap:getScriptsScriptCollectionItemMonitorStatusCountMap" }, "description": "Details of the monitor count per state. Example: `{ \"total\" : 5, \"enabled\" : 3 , \"disabled\" : 2, \"invalid\" : 0 }`\n" }, "parameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getScriptsScriptCollectionItemParameter:getScriptsScriptCollectionItemParameter" }, "description": "List of script parameters. Example: `[{\"scriptParameter\": {\"paramName\": \"userid\", \"paramValue\":\"testuser\", \"isSecret\": false}, \"isOverwritten\": false}]`\n" }, "timeCreated": { "type": "string", "description": "The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z`\n" }, "timeUploaded": { "type": "string", "description": "The time the script was uploaded.\n" } }, "type": "object", "required": [ "apmDomainId", "content", "contentFileName", "contentSizeInBytes", "contentType", "definedTags", "displayName", "freeformTags", "id", "monitorStatusCountMaps", "parameters", "timeCreated", "timeUpdated", "timeUploaded" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptsScriptCollectionItemMonitorStatusCountMap:getScriptsScriptCollectionItemMonitorStatusCountMap": { "properties": { "disabled": { "type": "integer", "description": "Number of disabled monitors using the script.\n" }, "enabled": { "type": "integer", "description": "Number of enabled monitors using the script.\n" }, "invalid": { "type": "integer", "description": "Number of invalid monitors using the script.\n" }, "total": { "type": "integer", "description": "Total number of monitors using the script.\n" } }, "type": "object", "required": [ "disabled", "enabled", "invalid", "total" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptsScriptCollectionItemParameter:getScriptsScriptCollectionItemParameter": { "properties": { "isOverwritten": { "type": "boolean", "description": "If parameter value is default or overwritten.\n" }, "isSecret": { "type": "boolean", "description": "If the parameter value is secret and should be kept confidential, then set isSecret to true.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" }, "scriptParameters": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getScriptsScriptCollectionItemParameterScriptParameter:getScriptsScriptCollectionItemParameterScriptParameter" }, "description": "Details of the script parameters, paramName must be from the script content and these details can be used to overwrite the default parameter present in the script content.\n" } }, "type": "object", "required": [ "isOverwritten", "isSecret", "paramName", "paramValue", "scriptParameters" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getScriptsScriptCollectionItemParameterScriptParameter:getScriptsScriptCollectionItemParameterScriptParameter": { "properties": { "isSecret": { "type": "boolean", "description": "If the parameter value is secret and should be kept confidential, then set isSecret to true.\n" }, "paramName": { "type": "string", "description": "Name of the parameter.\n" }, "paramValue": { "type": "string", "description": "Value of the parameter.\n" } }, "type": "object", "required": [ "isSecret", "paramName", "paramValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getVantagePointItem:getVantagePointItem": { "properties": { "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "geos": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getVantagePointItemGeo:getVantagePointItemGeo" }, "description": "Geographic summary of a vantage point.\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" } }, "type": "object", "required": [ "displayName", "geos", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getVantagePointItemGeo:getVantagePointItemGeo": { "properties": { "adminDivCode": { "type": "string", "description": "The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.\n" }, "cityName": { "type": "string", "description": "Common English-language name for the city.\n" }, "countryCode": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.\n" }, "countryName": { "type": "string", "description": "The common English-language name for the country.\n" }, "latitude": { "type": "number", "description": "Degrees north of the Equator.\n" }, "longitude": { "type": "number", "description": "Degrees east of the prime meridian.\n" } }, "type": "object", "required": [ "adminDivCode", "cityName", "countryCode", "countryName", "latitude", "longitude" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getVantagePointsFilter:getVantagePointsFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmSynthetics/getVantagePointsPublicVantagePointCollection:getVantagePointsPublicVantagePointCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getVantagePointsPublicVantagePointCollectionItem:getVantagePointsPublicVantagePointCollectionItem" }, "description": "List of PublicVantagePointSummary items.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getVantagePointsPublicVantagePointCollectionItem:getVantagePointsPublicVantagePointCollectionItem": { "properties": { "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name.\n" }, "geos": { "type": "array", "items": { "$ref": "#/types/oci:ApmSynthetics/getVantagePointsPublicVantagePointCollectionItemGeo:getVantagePointsPublicVantagePointCollectionItemGeo" }, "description": "Geographic summary of a vantage point.\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire name.\n" } }, "type": "object", "required": [ "displayName", "geos", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmSynthetics/getVantagePointsPublicVantagePointCollectionItemGeo:getVantagePointsPublicVantagePointCollectionItemGeo": { "properties": { "adminDivCode": { "type": "string", "description": "The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.\n" }, "cityName": { "type": "string", "description": "Common English-language name for the city.\n" }, "countryCode": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.\n" }, "countryName": { "type": "string", "description": "The common English-language name for the country.\n" }, "latitude": { "type": "number", "description": "Degrees north of the equator.\n" }, "longitude": { "type": "number", "description": "Degrees east of the prime meridian.\n" } }, "type": "object", "required": [ "adminDivCode", "cityName", "countryCode", "countryName", "latitude", "longitude" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfiguration:ScheduledQueryScheduledQueryProcessingConfiguration": { "properties": { "customMetric": { "$ref": "#/types/oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric:ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric", "description": "(Updatable) Definition of the Custom Metric.\n" }, "objectStorage": { "$ref": "#/types/oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage:ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage", "description": "(Updatable) Definition of the object storage.\n" }, "streaming": { "$ref": "#/types/oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfigurationStreaming:ScheduledQueryScheduledQueryProcessingConfigurationStreaming", "description": "(Updatable) Definition of the Stream.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customMetric", "objectStorage", "streaming" ] } } }, "oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric:ScheduledQueryScheduledQueryProcessingConfigurationCustomMetric": { "properties": { "compartment": { "type": "string", "description": "(Updatable) Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.\n" }, "description": { "type": "string", "description": "(Updatable) Description of the Custom Metric.\n" }, "isAnomalyDetectionEnabled": { "type": "boolean", "description": "(Updatable) Indicates whether anomaly Detection should be performed on the generated metric.\n" }, "isMetricPublished": { "type": "boolean", "description": "(Updatable) Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.\n" }, "name": { "type": "string", "description": "(Updatable) Name of the Custom Metric.\n" }, "namespace": { "type": "string", "description": "(Updatable) Namespace in the Custom Metric. It defaults to \u003cspan pulumi-lang-nodejs=\"`oracleApmCustom`\" pulumi-lang-dotnet=\"`OracleApmCustom`\" pulumi-lang-go=\"`oracleApmCustom`\" pulumi-lang-python=\"`oracle_apm_custom`\" pulumi-lang-yaml=\"`oracleApmCustom`\" pulumi-lang-java=\"`oracleApmCustom`\" pulumi-lang-hcl=\"`oracle_apm_custom`\"\u003e`oracleApmCustom`\u003c/span\u003e if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.\n" }, "resourceGroup": { "type": "string", "description": "(Updatable) Resource Group of the Custom Metric.\n" }, "unit": { "type": "string", "description": "(Updatable) Unit in which the metric value is reported. For example 'ms'.\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredOutputs": [ "compartment", "description", "isAnomalyDetectionEnabled", "isMetricPublished", "name", "namespace", "resourceGroup", "unit" ] } } }, "oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage:ScheduledQueryScheduledQueryProcessingConfigurationObjectStorage": { "properties": { "bucket": { "type": "string", "description": "(Updatable) Bucket name in the object store.\n" }, "nameSpace": { "type": "string", "description": "(Updatable) Namespace in the object store.\n" }, "objectNamePrefix": { "type": "string", "description": "(Updatable) Object name prefix in the object store.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bucket", "nameSpace", "objectNamePrefix" ] } } }, "oci:ApmTraces/ScheduledQueryScheduledQueryProcessingConfigurationStreaming:ScheduledQueryScheduledQueryProcessingConfigurationStreaming": { "properties": { "streamId": { "type": "string", "description": "(Updatable) Stream Id.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "streamId" ] } } }, "oci:ApmTraces/getLogAttribute:getLogAttribute": { "properties": { "attributeName": { "type": "string", "description": "Key that specifies the attribute name.\n" }, "attributeValue": { "type": "string", "description": "Value associated with the attribute key.\n" } }, "type": "object", "required": [ "attributeName", "attributeValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getQueryQuickPicksFilter:getQueryQuickPicksFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmTraces/getQueryQuickPicksQuickPick:getQueryQuickPicksQuickPick": { "properties": { "quickPickName": { "type": "string", "description": "Quick Pick name for the query.\n" }, "quickPickQuery": { "type": "string", "description": "Query for the Quick Pick.\n" } }, "type": "object", "required": [ "quickPickName", "quickPickQuery" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueriesFilter:getScheduledQueriesFilter": { "properties": { "name": { "type": "string", "description": "Name of the Custom Metric.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ApmTraces/getScheduledQueriesScheduledQueryCollection:getScheduledQueriesScheduledQueryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItem:getScheduledQueriesScheduledQueryCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItem:getScheduledQueriesScheduledQueryCollectionItem": { "properties": { "apmDomainId": { "type": "string", "description": "The APM Domain ID for the intended request.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the scheduled query . An OCID is generated when the scheduled query is created.\n" }, "opcDryRun": { "type": "string" }, "scheduledQueryDescription": { "type": "string", "description": "Description for the scheduled query.\n" }, "scheduledQueryInstances": { "type": "string", "description": "Scheduled query instances.\n" }, "scheduledQueryMaximumRuntimeInSeconds": { "type": "string", "description": "Maximum runtime for the scheduled query in seconds.\n" }, "scheduledQueryName": { "type": "string", "description": "Name of the scheduled query.\n" }, "scheduledQueryNextRunInMs": { "type": "string", "description": "Next run for the scheduled query.\n" }, "scheduledQueryProcessingConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfiguration:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfiguration" }, "description": "Definition of the scheduled query processing configuration.\n" }, "scheduledQueryProcessingSubType": { "type": "string", "description": "Processing sub type of the scheduled query.\n" }, "scheduledQueryProcessingType": { "type": "string", "description": "Processing type of the scheduled query.\n" }, "scheduledQueryRetentionCriteria": { "type": "string", "description": "Retention criteria for the scheduled query.\n" }, "scheduledQueryRetentionPeriodInMs": { "type": "string", "description": "Retention period for the scheduled query in milliseconds.\n" }, "scheduledQuerySchedule": { "type": "string", "description": "Schedule for the scheduled query.\n" }, "scheduledQueryText": { "type": "string", "description": "Scheduled query to be run.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the Scheduled Query.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" } }, "type": "object", "required": [ "apmDomainId", "definedTags", "freeformTags", "id", "opcDryRun", "scheduledQueryDescription", "scheduledQueryInstances", "scheduledQueryMaximumRuntimeInSeconds", "scheduledQueryName", "scheduledQueryNextRunInMs", "scheduledQueryProcessingConfigurations", "scheduledQueryProcessingSubType", "scheduledQueryProcessingType", "scheduledQueryRetentionCriteria", "scheduledQueryRetentionPeriodInMs", "scheduledQuerySchedule", "scheduledQueryText", "state", "systemTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfiguration:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfiguration": { "properties": { "customMetrics": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationCustomMetric:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationCustomMetric" }, "description": "Definition of the Custom Metric.\n" }, "objectStorages": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationObjectStorage:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationObjectStorage" }, "description": "Definition of the object storage.\n" }, "streamings": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationStreaming:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationStreaming" }, "description": "Definition of the Stream.\n" } }, "type": "object", "required": [ "customMetrics", "objectStorages", "streamings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationCustomMetric:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationCustomMetric": { "properties": { "compartment": { "type": "string", "description": "Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.\n" }, "description": { "type": "string", "description": "Description of the Custom Metric.\n" }, "isAnomalyDetectionEnabled": { "type": "boolean", "description": "Indicates whether anomaly Detection should be performed on the generated metric.\n" }, "isMetricPublished": { "type": "boolean", "description": "Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.\n" }, "name": { "type": "string", "description": "Name of the Custom Metric.\n" }, "namespace": { "type": "string", "description": "Namespace in the Custom Metric. It defaults to \u003cspan pulumi-lang-nodejs=\"`oracleApmCustom`\" pulumi-lang-dotnet=\"`OracleApmCustom`\" pulumi-lang-go=\"`oracleApmCustom`\" pulumi-lang-python=\"`oracle_apm_custom`\" pulumi-lang-yaml=\"`oracleApmCustom`\" pulumi-lang-java=\"`oracleApmCustom`\" pulumi-lang-hcl=\"`oracle_apm_custom`\"\u003e`oracleApmCustom`\u003c/span\u003e if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.\n" }, "resourceGroup": { "type": "string", "description": "Resource Group of the Custom Metric.\n" }, "unit": { "type": "string", "description": "Unit in which the metric value is reported. For example 'ms'.\n" } }, "type": "object", "required": [ "compartment", "description", "isAnomalyDetectionEnabled", "isMetricPublished", "name", "namespace", "resourceGroup", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationObjectStorage:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationObjectStorage": { "properties": { "bucket": { "type": "string", "description": "Bucket name in the object store.\n" }, "nameSpace": { "type": "string", "description": "Namespace in the object store.\n" }, "objectNamePrefix": { "type": "string", "description": "Object name prefix in the object store.\n" } }, "type": "object", "required": [ "bucket", "nameSpace", "objectNamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationStreaming:getScheduledQueriesScheduledQueryCollectionItemScheduledQueryProcessingConfigurationStreaming": { "properties": { "streamId": { "type": "string", "description": "Stream Id.\n" } }, "type": "object", "required": [ "streamId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfiguration:getScheduledQueryScheduledQueryProcessingConfiguration": { "properties": { "customMetrics": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfigurationCustomMetric:getScheduledQueryScheduledQueryProcessingConfigurationCustomMetric" }, "description": "Definition of the Custom Metric.\n" }, "objectStorages": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfigurationObjectStorage:getScheduledQueryScheduledQueryProcessingConfigurationObjectStorage" }, "description": "Definition of the object storage.\n" }, "streamings": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfigurationStreaming:getScheduledQueryScheduledQueryProcessingConfigurationStreaming" }, "description": "Definition of the Stream.\n" } }, "type": "object", "required": [ "customMetrics", "objectStorages", "streamings" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfigurationCustomMetric:getScheduledQueryScheduledQueryProcessingConfigurationCustomMetric": { "properties": { "compartment": { "type": "string", "description": "Compartment of the Monitoring Service. It defaults to the APM domain's compartment if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that compartment.\n" }, "description": { "type": "string", "description": "Description of the Custom Metric.\n" }, "isAnomalyDetectionEnabled": { "type": "boolean", "description": "Indicates whether anomaly Detection should be performed on the generated metric.\n" }, "isMetricPublished": { "type": "boolean", "description": "Used in conjunction with the dry run header. When the dry run header is set and the isPublishMetric flag is set to true, the scheduled query is not created, but validations happen to check if the right Oracle Cloud Infrastructure policies have been set to write to the specified namespace/compartment.\n" }, "name": { "type": "string", "description": "Name of the Custom Metric.\n" }, "namespace": { "type": "string", "description": "Namespace in the Custom Metric. It defaults to \u003cspan pulumi-lang-nodejs=\"`oracleApmCustom`\" pulumi-lang-dotnet=\"`OracleApmCustom`\" pulumi-lang-go=\"`oracleApmCustom`\" pulumi-lang-python=\"`oracle_apm_custom`\" pulumi-lang-yaml=\"`oracleApmCustom`\" pulumi-lang-java=\"`oracleApmCustom`\" pulumi-lang-hcl=\"`oracle_apm_custom`\"\u003e`oracleApmCustom`\u003c/span\u003e if not specified. If specified, the necessary Oracle Cloud Infrastructure policies should be set to allow APM to write to that namespace.\n" }, "resourceGroup": { "type": "string", "description": "Resource Group of the Custom Metric.\n" }, "unit": { "type": "string", "description": "Unit in which the metric value is reported. For example 'ms'.\n" } }, "type": "object", "required": [ "compartment", "description", "isAnomalyDetectionEnabled", "isMetricPublished", "name", "namespace", "resourceGroup", "unit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfigurationObjectStorage:getScheduledQueryScheduledQueryProcessingConfigurationObjectStorage": { "properties": { "bucket": { "type": "string", "description": "Bucket name in the object store.\n" }, "nameSpace": { "type": "string", "description": "Namespace in the object store.\n" }, "objectNamePrefix": { "type": "string", "description": "Object name prefix in the object store.\n" } }, "type": "object", "required": [ "bucket", "nameSpace", "objectNamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getScheduledQueryScheduledQueryProcessingConfigurationStreaming:getScheduledQueryScheduledQueryProcessingConfigurationStreaming": { "properties": { "streamId": { "type": "string", "description": "Stream Id.\n" } }, "type": "object", "required": [ "streamId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceAggregatedSnapshotDataDetail:getTraceAggregatedSnapshotDataDetail": { "properties": { "key": { "type": "string", "description": "Name of the property.\n" }, "value": { "type": "string", "description": "Value of the property.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceServiceSummary:getTraceServiceSummary": { "properties": { "errorSpans": { "type": "string", "description": "Number of spans with errors for serviceName in the trace.\n" }, "spanServiceName": { "type": "string", "description": "Name associated with the service.\n" }, "totalSpans": { "type": "string", "description": "Number of spans for serviceName in the trace.\n" } }, "type": "object", "required": [ "errorSpans", "spanServiceName", "totalSpans" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSnapshotDataTraceSnapshotDetail:getTraceSnapshotDataTraceSnapshotDetail": { "properties": { "key": { "type": "string", "description": "Name of the property.\n" }, "value": { "type": "string", "description": "Value of the property.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSpan:getTraceSpan": { "properties": { "durationInMs": { "type": "string", "description": "Total span duration in milliseconds.\n" }, "isError": { "type": "boolean", "description": "Indicates if the span has an error.\n" }, "key": { "type": "string", "description": "Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.\n" }, "kind": { "type": "string", "description": "Kind associated with the span.\n" }, "logs": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getTraceSpanLog:getTraceSpanLog" }, "description": "List of logs associated with the span.\n" }, "operationName": { "type": "string", "description": "Span name associated with the trace. This is usually the method or URI of the request.\n" }, "parentSpanKey": { "type": "string", "description": "Unique parent identifier for the span if one exists. For root spans this will be null.\n" }, "serviceName": { "type": "string", "description": "Service name associated with the span.\n" }, "sourceName": { "type": "string", "description": "Source of span (spans, syn_spans).\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getTraceSpanTag:getTraceSpanTag" }, "description": "List of tags associated with the span.\n" }, "timeEnded": { "type": "string", "description": "Span end time. Timestamp when the span was completed.\n" }, "timeStarted": { "type": "string", "description": "Span start time. Timestamp when the span was started.\n" }, "traceKey": { "type": "string", "description": "Unique Application Performance Monitoring trace identifier (traceId).\n" } }, "type": "object", "required": [ "durationInMs", "isError", "key", "kind", "logs", "operationName", "parentSpanKey", "serviceName", "sourceName", "tags", "timeEnded", "timeStarted", "traceKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSpanLog:getTraceSpanLog": { "properties": { "eventName": { "type": "string", "description": "Name of the event for which the log is created.\n" }, "spanLogs": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getTraceSpanLogSpanLog:getTraceSpanLogSpanLog" }, "description": "List of logs associated with the span at the given timestamp.\n" }, "timeCreated": { "type": "string", "description": "Timestamp at which the log is created.\n" } }, "type": "object", "required": [ "eventName", "spanLogs", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSpanLogSpanLog:getTraceSpanLogSpanLog": { "properties": { "logKey": { "type": "string", "description": "Key that specifies the log name.\n" }, "logValue": { "type": "string", "description": "Value associated with the log key.\n" } }, "type": "object", "required": [ "logKey", "logValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSpanSummary:getTraceSpanSummary": { "properties": { "errorSpanCount": { "type": "integer", "description": "The number of spans with errors that have been processed by the system for the trace. Note that the number of spans with errors will be less than or equal to the total number of spans in the trace.\n" }, "isFault": { "type": "boolean", "description": "Boolean flag that indicates whether the trace has an error.\n" }, "key": { "type": "string", "description": "Unique identifier (spanId) for the span. Note that this field is defined as spanKey in the API and it maps to the spanId in the trace data in Application Performance Monitoring.\n" }, "rootSpanDurationInMs": { "type": "integer", "description": "Time taken for the root span operation to complete in milliseconds.\n" }, "rootSpanOperationName": { "type": "string", "description": "Root span name associated with the trace. This is the flow start operation name. Null is displayed if the root span is not yet completed.\n" }, "rootSpanServiceName": { "type": "string", "description": "Service associated with the trace.\n" }, "serviceSummaries": { "type": "array", "items": { "$ref": "#/types/oci:ApmTraces/getTraceSpanSummaryServiceSummary:getTraceSpanSummaryServiceSummary" }, "description": "A summary of the spans by service.\n" }, "spanCount": { "type": "integer", "description": "The number of spans that have been processed by the system for the trace. Note that there could be additional spans that have not been processed or reported yet if the trace is still in progress.\n" }, "timeEarliestSpanStarted": { "type": "string", "description": "Start time of the earliest span in the span collection.\n" }, "timeLatestSpanEnded": { "type": "string", "description": "End time of the span that most recently ended in the span collection.\n" }, "timeRootSpanEnded": { "type": "string", "description": "End time of the root span for the span collection.\n" }, "timeRootSpanStarted": { "type": "string", "description": "Start time of the root span for the span collection.\n" }, "traceDurationInMs": { "type": "integer", "description": "Time between the start of the earliest span and the end of the most recent span in milliseconds.\n" }, "traceErrorCode": { "type": "string", "description": "Error code of the trace.\n" }, "traceErrorType": { "type": "string", "description": "Error type of the trace.\n" }, "traceStatus": { "type": "string", "description": "The status of the trace. The trace statuses are defined as follows: complete - a root span has been recorded, but there is no information on the errors. success - a complete root span is recorded there is a successful error type and error code - HTTP 200. incomplete - the root span has not yet been received. error - the root span returned with an error. There may or may not be an associated error code or error type.\n" } }, "type": "object", "required": [ "errorSpanCount", "isFault", "key", "rootSpanDurationInMs", "rootSpanOperationName", "rootSpanServiceName", "serviceSummaries", "spanCount", "timeEarliestSpanStarted", "timeLatestSpanEnded", "timeRootSpanEnded", "timeRootSpanStarted", "traceDurationInMs", "traceErrorCode", "traceErrorType", "traceStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSpanSummaryServiceSummary:getTraceSpanSummaryServiceSummary": { "properties": { "errorSpans": { "type": "string", "description": "Number of spans with errors for serviceName in the trace.\n" }, "spanServiceName": { "type": "string", "description": "Name associated with the service.\n" }, "totalSpans": { "type": "string", "description": "Number of spans for serviceName in the trace.\n" } }, "type": "object", "required": [ "errorSpans", "spanServiceName", "totalSpans" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ApmTraces/getTraceSpanTag:getTraceSpanTag": { "properties": { "tagName": { "type": "string", "description": "Key that specifies the tag name.\n" }, "tagValue": { "type": "string", "description": "Value associated with the tag key.\n" } }, "type": "object", "required": [ "tagName", "tagValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AppMgmtControl/getMonitoredInstancesFilter:getMonitoredInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:AppMgmtControl/getMonitoredInstancesMonitoredInstanceCollection:getMonitoredInstancesMonitoredInstanceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:AppMgmtControl/getMonitoredInstancesMonitoredInstanceCollectionItem:getMonitoredInstancesMonitoredInstanceCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:AppMgmtControl/getMonitoredInstancesMonitoredInstanceCollectionItem:getMonitoredInstancesMonitoredInstanceCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "instanceId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of monitored instance.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managementAgentId": { "type": "string", "description": "Management Agent Identifier [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Used to invoke manage operations on Management Agent Cloud Service.\n" }, "monitoringState": { "type": "string", "description": "Monitoring status. Can be either enabled or disabled.\n" }, "state": { "type": "string", "description": "The current state of the monitored instance.\n" }, "timeCreated": { "type": "string", "description": "The time the MonitoredInstance was created. An RFC3339 formatted datetime string\n" }, "timeUpdated": { "type": "string", "description": "The time the MonitoredInstance was updated. An RFC3339 formatted datetime string\n" } }, "type": "object", "required": [ "compartmentId", "displayName", "instanceId", "lifecycleDetails", "managementAgentId", "monitoringState", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/ContainerRepositoryReadme:ContainerRepositoryReadme": { "properties": { "content": { "type": "string", "description": "(Updatable) Readme content. Avoid entering confidential information.\n" }, "format": { "type": "string", "description": "(Updatable) Readme format. Supported formats are text/plain and text/markdown.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "content", "format" ] }, "oci:Artifacts/getContainerImageLayer:getContainerImageLayer": { "properties": { "digest": { "type": "string", "description": "The sha256 digest of the image layer.\n" }, "sizeInBytes": { "type": "string", "description": "The size of the layer in bytes.\n" }, "timeCreated": { "type": "string", "description": "The creation time of the version.\n" } }, "type": "object", "required": [ "digest", "sizeInBytes", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerImageVersion:getContainerImageVersion": { "properties": { "createdBy": { "type": "string", "description": "The OCID of the user or principal that pushed the version.\n" }, "timeCreated": { "type": "string", "description": "The creation time of the version.\n" }, "version": { "type": "string", "description": "The version name.\n" } }, "type": "object", "required": [ "createdBy", "timeCreated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerImagesContainerImageCollection:getContainerImagesContainerImageCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getContainerImagesContainerImageCollectionItem:getContainerImagesContainerImageCollectionItem" } }, "remainingItemsCount": { "type": "integer" } }, "type": "object", "required": [ "items", "remainingItemsCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerImagesContainerImageCollectionItem:getContainerImagesContainerImageCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "createdBy": { "type": "string", "description": "The OCID of the user or principal that pushed the version.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "digest": { "type": "string", "description": "The sha256 digest of the image layer.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image. Example: `ocid1.containerimage.oc1..exampleuniqueID`\n" }, "layers": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getContainerImagesContainerImageCollectionItemLayer:getContainerImagesContainerImageCollectionItemLayer" }, "description": "Layers of which the image is composed, ordered by the layer digest.\n" }, "layersSizeInBytes": { "type": "string", "description": "The total size of the container image layers in bytes.\n" }, "manifestSizeInBytes": { "type": "integer", "description": "The size of the container image manifest in bytes.\n" }, "pullCount": { "type": "string", "description": "Total number of pulls.\n" }, "repositoryId": { "type": "string", "description": "A filter to return container images only for the specified container repository OCID.\n" }, "repositoryName": { "type": "string", "description": "A filter to return container images or container image signatures that match the repository name. Example: \u003cspan pulumi-lang-nodejs=\"`foo`\" pulumi-lang-dotnet=\"`Foo`\" pulumi-lang-go=\"`foo`\" pulumi-lang-python=\"`foo`\" pulumi-lang-yaml=\"`foo`\" pulumi-lang-java=\"`foo`\" pulumi-lang-hcl=\"`foo`\"\u003e`foo`\u003c/span\u003e or `foo*`\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The creation time of the version.\n" }, "timeLastPulled": { "type": "string", "description": "An RFC 3339 timestamp indicating when the image was last pulled.\n" }, "version": { "type": "string", "description": "A filter to return container images that match the version. Example: \u003cspan pulumi-lang-nodejs=\"`foo`\" pulumi-lang-dotnet=\"`Foo`\" pulumi-lang-go=\"`foo`\" pulumi-lang-python=\"`foo`\" pulumi-lang-yaml=\"`foo`\" pulumi-lang-java=\"`foo`\" pulumi-lang-hcl=\"`foo`\"\u003e`foo`\u003c/span\u003e or `foo*`\n" }, "versions": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getContainerImagesContainerImageCollectionItemVersion:getContainerImagesContainerImageCollectionItemVersion" }, "description": "The versions associated with this image.\n" } }, "type": "object", "required": [ "compartmentId", "createdBy", "definedTags", "digest", "displayName", "freeformTags", "id", "layers", "layersSizeInBytes", "manifestSizeInBytes", "pullCount", "repositoryId", "repositoryName", "state", "systemTags", "timeCreated", "timeLastPulled", "version", "versions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerImagesContainerImageCollectionItemLayer:getContainerImagesContainerImageCollectionItemLayer": { "properties": { "digest": { "type": "string", "description": "The sha256 digest of the image layer.\n" }, "sizeInBytes": { "type": "string", "description": "The size of the layer in bytes.\n" }, "timeCreated": { "type": "string", "description": "The creation time of the version.\n" } }, "type": "object", "required": [ "digest", "sizeInBytes", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerImagesContainerImageCollectionItemVersion:getContainerImagesContainerImageCollectionItemVersion": { "properties": { "createdBy": { "type": "string", "description": "The OCID of the user or principal that pushed the version.\n" }, "timeCreated": { "type": "string", "description": "The creation time of the version.\n" }, "version": { "type": "string", "description": "A filter to return container images that match the version. Example: \u003cspan pulumi-lang-nodejs=\"`foo`\" pulumi-lang-dotnet=\"`Foo`\" pulumi-lang-go=\"`foo`\" pulumi-lang-python=\"`foo`\" pulumi-lang-yaml=\"`foo`\" pulumi-lang-java=\"`foo`\" pulumi-lang-hcl=\"`foo`\"\u003e`foo`\u003c/span\u003e or `foo*`\n" } }, "type": "object", "required": [ "createdBy", "timeCreated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerImagesFilter:getContainerImagesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Artifacts/getContainerRepositoriesContainerRepositoryCollection:getContainerRepositoriesContainerRepositoryCollection": { "properties": { "imageCount": { "type": "integer", "description": "Total number of images.\n" }, "items": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getContainerRepositoriesContainerRepositoryCollectionItem:getContainerRepositoriesContainerRepositoryCollectionItem" } }, "layerCount": { "type": "integer", "description": "Total number of layers.\n" }, "layersSizeInBytes": { "type": "string", "description": "Total storage in bytes consumed by layers.\n" }, "remainingItemsCount": { "type": "integer" }, "repositoryCount": { "type": "integer" } }, "type": "object", "required": [ "imageCount", "items", "layerCount", "layersSizeInBytes", "remainingItemsCount", "repositoryCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerRepositoriesContainerRepositoryCollectionItem:getContainerRepositoriesContainerRepositoryCollectionItem": { "properties": { "billableSizeInGbs": { "type": "string", "description": "Total storage size in GBs that will be charged.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "createdBy": { "type": "string", "description": "The id of the user or principal that created the resource.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository. Example: `ocid1.containerrepo.oc1..exampleuniqueID`\n" }, "imageCount": { "type": "integer", "description": "Total number of images.\n" }, "isImmutable": { "type": "boolean", "description": "Whether the repository is immutable. Images cannot be overwritten in an immutable repository.\n" }, "isPublic": { "type": "boolean", "description": "A filter to return resources that match the isPublic value.\n" }, "layerCount": { "type": "integer", "description": "Total number of layers.\n" }, "layersSizeInBytes": { "type": "string", "description": "Total storage in bytes consumed by layers.\n" }, "namespace": { "type": "string", "description": "The tenancy namespace used in the container repository path.\n" }, "readmes": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getContainerRepositoriesContainerRepositoryCollectionItemReadme:getContainerRepositoriesContainerRepositoryCollectionItemReadme" }, "description": "Container repository readme.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "An RFC 3339 timestamp indicating when the repository was created.\n" }, "timeLastPushed": { "type": "string", "description": "An RFC 3339 timestamp indicating when an image was last pushed to the repository.\n" } }, "type": "object", "required": [ "billableSizeInGbs", "compartmentId", "createdBy", "definedTags", "displayName", "freeformTags", "id", "imageCount", "isImmutable", "isPublic", "layerCount", "layersSizeInBytes", "namespace", "readmes", "state", "systemTags", "timeCreated", "timeLastPushed" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerRepositoriesContainerRepositoryCollectionItemReadme:getContainerRepositoriesContainerRepositoryCollectionItemReadme": { "properties": { "content": { "type": "string", "description": "Readme content. Avoid entering confidential information.\n" }, "format": { "type": "string", "description": "Readme format. Supported formats are text/plain and text/markdown.\n" } }, "type": "object", "required": [ "content", "format" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerRepositoriesFilter:getContainerRepositoriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Artifacts/getContainerRepositoryReadme:getContainerRepositoryReadme": { "properties": { "content": { "type": "string", "description": "Readme content. Avoid entering confidential information.\n" }, "format": { "type": "string", "description": "Readme format. Supported formats are text/plain and text/markdown.\n" } }, "type": "object", "required": [ "content", "format" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerSignaturesContainerImageSignatureCollection:getContainerSignaturesContainerImageSignatureCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getContainerSignaturesContainerImageSignatureCollectionItem:getContainerSignaturesContainerImageSignatureCollectionItem" } }, "remainingItemsCount": { "type": "integer" } }, "type": "object", "required": [ "items", "remainingItemsCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerSignaturesContainerImageSignatureCollectionItem:getContainerSignaturesContainerImageSignatureCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "createdBy": { "type": "string", "description": "The id of the user or principal that created the resource.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature. Example: `ocid1.containerimagesignature.oc1..exampleuniqueID`\n" }, "imageId": { "type": "string", "description": "A filter to return a container image summary only for the specified container image OCID.\n" }, "kmsKeyId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the kmsKeyVersionId used to sign the container image. Example: `ocid1.keyversion.oc1..exampleuniqueID`\n" }, "kmsKeyVersionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the kmsKeyVersionId used to sign the container image. Example: `ocid1.keyversion.oc1..exampleuniqueID`\n" }, "message": { "type": "string", "description": "The base64 encoded signature payload that was signed.\n" }, "signature": { "type": "string", "description": "The signature of the message field using the kmsKeyId, the kmsKeyVersionId, and the signingAlgorithm.\n" }, "signingAlgorithm": { "type": "string", "description": "The algorithm to be used for signing. These are the only supported signing algorithms for container images.\n" }, "state": { "type": "string", "description": "The current state of the container image signature.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "An RFC 3339 timestamp indicating when the image was created.\n" } }, "type": "object", "required": [ "compartmentId", "createdBy", "definedTags", "displayName", "freeformTags", "id", "imageId", "kmsKeyId", "kmsKeyVersionId", "message", "signature", "signingAlgorithm", "state", "systemTags", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getContainerSignaturesFilter:getContainerSignaturesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Artifacts/getGenericArtifactsFilter:getGenericArtifactsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Artifacts/getGenericArtifactsGenericArtifactCollection:getGenericArtifactsGenericArtifactCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getGenericArtifactsGenericArtifactCollectionItem:getGenericArtifactsGenericArtifactCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getGenericArtifactsGenericArtifactCollectionItem:getGenericArtifactsGenericArtifactCollectionItem": { "properties": { "artifactId": { "type": "string" }, "artifactPath": { "type": "string", "description": "Filter results by a prefix for the `artifactPath` and and return artifacts that begin with the specified prefix in their path.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "A filter to return the resources for the specified OCID.\n" }, "repositoryId": { "type": "string", "description": "A filter to return the artifacts only for the specified repository OCID.\n" }, "sha256": { "type": "string", "description": "Filter results by a specified SHA256 digest for the artifact.\n" }, "sizeInBytes": { "type": "string", "description": "The size of the artifact in bytes.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, "timeCreated": { "type": "string", "description": "An RFC 3339 timestamp indicating when the repository was created.\n" }, "version": { "type": "string", "description": "Filter results by a prefix for \u003cspan pulumi-lang-nodejs=\"`version`\" pulumi-lang-dotnet=\"`Version`\" pulumi-lang-go=\"`version`\" pulumi-lang-python=\"`version`\" pulumi-lang-yaml=\"`version`\" pulumi-lang-java=\"`version`\" pulumi-lang-hcl=\"`version`\"\u003e`version`\u003c/span\u003e and return artifacts that that begin with the specified prefix in their version.\n" } }, "type": "object", "required": [ "artifactId", "artifactPath", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "repositoryId", "sha256", "sizeInBytes", "state", "timeCreated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getRepositoriesFilter:getRepositoriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Artifacts/getRepositoriesRepositoryCollection:getRepositoriesRepositoryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Artifacts/getRepositoriesRepositoryCollectionItem:getRepositoriesRepositoryCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Artifacts/getRepositoriesRepositoryCollectionItem:getRepositoriesRepositoryCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "The repository description.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "A filter to return the resources for the specified OCID.\n" }, "isImmutable": { "type": "boolean", "description": "A filter to return resources that match the isImmutable value.\n" }, "repositoryType": { "type": "string", "description": "The repository's supported artifact type.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, "timeCreated": { "type": "string", "description": "An RFC 3339 timestamp indicating when the repository was created.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "isImmutable", "repositoryType", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsAuditEvent:getEventsAuditEvent": { "properties": { "cloudEventsVersion": { "type": "string", "description": "The version of the CloudEvents specification. The structure of the envelope follows the [CloudEvents](https://github.com/cloudevents/spec) industry standard format hosted by the [Cloud Native Computing Foundation ( CNCF)](https://www.cncf.io/).\n" }, "contentType": { "type": "string", "description": "The content type of the data contained in \u003cspan pulumi-lang-nodejs=\"`data`\" pulumi-lang-dotnet=\"`Data`\" pulumi-lang-go=\"`data`\" pulumi-lang-python=\"`data`\" pulumi-lang-yaml=\"`data`\" pulumi-lang-java=\"`data`\" pulumi-lang-hcl=\"`data`\"\u003e`data`\u003c/span\u003e. Example: `application/json`\n" }, "datas": { "type": "array", "items": { "$ref": "#/types/oci:Audit/getEventsAuditEventData:getEventsAuditEventData" }, "description": "The payload of the event. Information within \u003cspan pulumi-lang-nodejs=\"`data`\" pulumi-lang-dotnet=\"`Data`\" pulumi-lang-go=\"`data`\" pulumi-lang-python=\"`data`\" pulumi-lang-yaml=\"`data`\" pulumi-lang-java=\"`data`\" pulumi-lang-hcl=\"`data`\"\u003e`data`\u003c/span\u003e comes from the resource emitting the event.\n" }, "eventId": { "type": "string", "description": "The GUID of the event.\n" }, "eventTime": { "type": "string", "description": "The time the event occurred, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-09-18T00:10:59.252Z`\n" }, "eventType": { "type": "string", "description": "The type of event that happened.\n" }, "eventTypeVersion": { "type": "string", "description": "The version of the event type. This version applies to the payload of the event, not the envelope. Use `cloudEventsVersion` to determine the version of the envelope. Example: `2.0`\n" }, "source": { "type": "string", "description": "The source of the event. Example: `ComputeApi`\n" } }, "type": "object", "required": [ "cloudEventsVersion", "contentType", "datas", "eventId", "eventTime", "eventType", "eventTypeVersion", "source" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsAuditEventData:getEventsAuditEventData": { "properties": { "additionalDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A container object for attribues unique to the resource emitting the event.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain where the resource resides.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "compartmentName": { "type": "string", "description": "The name of the compartment. This value is the friendly name associated with compartmentId. This value can change, but the service logs the value that appeared at the time of the audit event. Example: `CompartmentA`\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "eventGroupingId": { "type": "string", "description": "This value links multiple audit events that are part of the same API operation. For example, a long running API operations that emit an event at the start and the end of an operation would use the same value in this field for both events.\n" }, "eventName": { "type": "string", "description": "Name of the API operation that generated this event. Example: `GetInstance`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "identities": { "type": "array", "items": { "$ref": "#/types/oci:Audit/getEventsAuditEventDataIdentity:getEventsAuditEventDataIdentity" }, "description": "A container object for identity attributes.\n" }, "requests": { "type": "array", "items": { "$ref": "#/types/oci:Audit/getEventsAuditEventDataRequest:getEventsAuditEventDataRequest" }, "description": "A container object for request attributes.\n" }, "resourceId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) or some other ID for the resource emitting the event.\n" }, "resourceName": { "type": "string", "description": "The name of the resource emitting the event.\n" }, "responses": { "type": "array", "items": { "$ref": "#/types/oci:Audit/getEventsAuditEventDataResponse:getEventsAuditEventDataResponse" }, "description": "A container object for response attributes.\n" }, "stateChanges": { "type": "array", "items": { "$ref": "#/types/oci:Audit/getEventsAuditEventDataStateChange:getEventsAuditEventDataStateChange" }, "description": "A container object for state change attributes.\n" } }, "type": "object", "required": [ "additionalDetails", "availabilityDomain", "compartmentId", "compartmentName", "definedTags", "eventGroupingId", "eventName", "freeformTags", "identities", "requests", "resourceId", "resourceName", "responses", "stateChanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsAuditEventDataIdentity:getEventsAuditEventDataIdentity": { "properties": { "authType": { "type": "string", "description": "The type of authentication used. Example: \u003cspan pulumi-lang-nodejs=\"`natv`\" pulumi-lang-dotnet=\"`Natv`\" pulumi-lang-go=\"`natv`\" pulumi-lang-python=\"`natv`\" pulumi-lang-yaml=\"`natv`\" pulumi-lang-java=\"`natv`\" pulumi-lang-hcl=\"`natv`\"\u003e`natv`\u003c/span\u003e\n" }, "callerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the caller. The caller that made a request on behalf of the prinicpal.\n" }, "callerName": { "type": "string", "description": "The name of the user or service. This value is the friendly name associated with `callerId`.\n" }, "consoleSessionId": { "type": "string", "description": "This value identifies any Console session associated with this request.\n" }, "credentials": { "type": "string", "description": "The credential ID of the user. This value is extracted from the HTTP 'Authorization' request header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/).\n" }, "ipAddress": { "type": "string", "description": "The IP address of the source of the request. Example: `172.24.80.88`\n" }, "principalId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the principal.\n" }, "principalName": { "type": "string", "description": "The name of the user or service. This value is the friendly name associated with `principalId`. Example: `ExampleName`\n" }, "tenantId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tenant.\n" }, "userAgent": { "type": "string", "description": "The user agent of the client that made the request. Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)`\n" } }, "type": "object", "required": [ "authType", "callerId", "callerName", "consoleSessionId", "credentials", "ipAddress", "principalId", "principalName", "tenantId", "userAgent" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsAuditEventDataRequest:getEventsAuditEventDataRequest": { "properties": { "action": { "type": "string", "description": "The HTTP method of the request. Example: `GET`\n" }, "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The headers of the response.\n" }, "id": { "type": "string", "description": "The opc-request-id of the request.\n" }, "parameters": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The parameters supplied by the caller during this operation.\n" }, "path": { "type": "string", "description": "The full path of the API request. Example: `/20160918/instances/ocid1.instance.oc1.phx.\u003cunique_ID\u003e`\n" } }, "type": "object", "required": [ "action", "headers", "id", "parameters", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsAuditEventDataResponse:getEventsAuditEventDataResponse": { "properties": { "headers": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The headers of the response.\n" }, "message": { "type": "string", "description": "A friendly description of what happened during the operation. Use this for troubleshooting.\n" }, "payload": { "type": "object", "additionalProperties": { "type": "string" }, "description": "This value is included for backward compatibility with the Audit version 1 schema, where it contained metadata of interest from the response payload.\n" }, "responseTime": { "type": "string", "description": "The time of the response to the audited request, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-09-18T00:10:59.278Z`\n" }, "status": { "type": "string", "description": "The status code of the response. Example: \u003cspan pulumi-lang-nodejs=\"`200`\" pulumi-lang-dotnet=\"`200`\" pulumi-lang-go=\"`200`\" pulumi-lang-python=\"`200`\" pulumi-lang-yaml=\"`200`\" pulumi-lang-java=\"`200`\" pulumi-lang-hcl=\"`200`\"\u003e`200`\u003c/span\u003e\n" } }, "type": "object", "required": [ "headers", "message", "payload", "responseTime", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsAuditEventDataStateChange:getEventsAuditEventDataStateChange": { "properties": { "current": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Provides the current state of fields that may have changed during an operation. To determine how the current operation changed a resource, compare the information in this attribute to \u003cspan pulumi-lang-nodejs=\"`previous`\" pulumi-lang-dotnet=\"`Previous`\" pulumi-lang-go=\"`previous`\" pulumi-lang-python=\"`previous`\" pulumi-lang-yaml=\"`previous`\" pulumi-lang-java=\"`previous`\" pulumi-lang-hcl=\"`previous`\"\u003e`previous`\u003c/span\u003e.\n" }, "previous": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Provides the previous state of fields that may have changed during an operation. To determine how the current operation changed a resource, compare the information in this attribute to \u003cspan pulumi-lang-nodejs=\"`current`\" pulumi-lang-dotnet=\"`Current`\" pulumi-lang-go=\"`current`\" pulumi-lang-python=\"`current`\" pulumi-lang-yaml=\"`current`\" pulumi-lang-java=\"`current`\" pulumi-lang-hcl=\"`current`\"\u003e`current`\u003c/span\u003e.\n" } }, "type": "object", "required": [ "current", "previous" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Audit/getEventsFilter:getEventsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Autoscaling/AutoScalingConfigurationAutoScalingResources:AutoScalingConfigurationAutoScalingResources": { "properties": { "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource that is managed by the autoscaling configuration.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of resource.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "id", "type" ] }, "oci:Autoscaling/AutoScalingConfigurationPolicy:AutoScalingConfigurationPolicy": { "properties": { "capacity": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyCapacity:AutoScalingConfigurationPolicyCapacity", "description": "The capacity requirements of the autoscaling policy.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "executionSchedule": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyExecutionSchedule:AutoScalingConfigurationPolicyExecutionSchedule", "description": "An execution schedule for an autoscaling policy.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "isEnabled": { "type": "boolean", "description": "Whether the autoscaling policy is enabled.\n", "willReplaceOnChanges": true }, "policyType": { "type": "string", "description": "The type of autoscaling policy.\n", "willReplaceOnChanges": true }, "resourceAction": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyResourceAction:AutoScalingConfigurationPolicyResourceAction", "description": "An action to run on a resource, such as stopping or starting an instance pool.\n", "willReplaceOnChanges": true }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyRule:AutoScalingConfigurationPolicyRule" }, "willReplaceOnChanges": true }, "timeCreated": { "type": "string", "description": "The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "policyType" ], "language": { "nodejs": { "requiredOutputs": [ "capacity", "displayName", "executionSchedule", "id", "isEnabled", "policyType", "resourceAction", "rules", "timeCreated" ] } } }, "oci:Autoscaling/AutoScalingConfigurationPolicyCapacity:AutoScalingConfigurationPolicyCapacity": { "properties": { "initial": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.\n\nFor a schedule-based autoscaling policy, this value is the target pool size to scale to when executing the schedule that's defined in the autoscaling policy.\n", "willReplaceOnChanges": true }, "max": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out).\n\nFor a schedule-based autoscaling policy, this value is not used.\n", "willReplaceOnChanges": true }, "min": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in).\n\nFor a schedule-based autoscaling policy, this value is not used.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "initial", "max", "min" ] } } }, "oci:Autoscaling/AutoScalingConfigurationPolicyExecutionSchedule:AutoScalingConfigurationPolicyExecutionSchedule": { "properties": { "expression": { "type": "string", "description": "A cron expression that represents the time at which to execute the autoscaling policy.\n\nCron expressions have this format: `\u003csecond\u003e \u003cminute\u003e \u003chour\u003e \u003cday of month\u003e \u003cmonth\u003e \u003cday of week\u003e \u003cyear\u003e`\n\nYou can use special characters that are supported with the Quartz cron implementation.\n\nYou must specify \u003cspan pulumi-lang-nodejs=\"`0`\" pulumi-lang-dotnet=\"`0`\" pulumi-lang-go=\"`0`\" pulumi-lang-python=\"`0`\" pulumi-lang-yaml=\"`0`\" pulumi-lang-java=\"`0`\" pulumi-lang-hcl=\"`0`\"\u003e`0`\u003c/span\u003e as the value for seconds.\n\nExample: `0 15 10 ? * *`\n", "willReplaceOnChanges": true }, "timezone": { "type": "string", "description": "The time zone for the execution schedule.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of execution schedule.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "expression", "timezone", "type" ] }, "oci:Autoscaling/AutoScalingConfigurationPolicyResourceAction:AutoScalingConfigurationPolicyResourceAction": { "properties": { "action": { "type": "string", "willReplaceOnChanges": true }, "actionType": { "type": "string", "description": "The category of action to run on the resource.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "action", "actionType" ] }, "oci:Autoscaling/AutoScalingConfigurationPolicyRule:AutoScalingConfigurationPolicyRule": { "properties": { "action": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyRuleAction:AutoScalingConfigurationPolicyRuleAction", "description": "The action to take when autoscaling is triggered.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "metric": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyRuleMetric:AutoScalingConfigurationPolicyRuleMetric", "willReplaceOnChanges": true } }, "type": "object", "required": [ "displayName" ], "language": { "nodejs": { "requiredOutputs": [ "action", "displayName", "id", "metric" ] } } }, "oci:Autoscaling/AutoScalingConfigurationPolicyRuleAction:AutoScalingConfigurationPolicyRuleAction": { "properties": { "type": { "type": "string", "description": "The type of action to take.\n", "willReplaceOnChanges": true }, "value": { "type": "integer", "description": "To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type", "value" ] } } }, "oci:Autoscaling/AutoScalingConfigurationPolicyRuleMetric:AutoScalingConfigurationPolicyRuleMetric": { "properties": { "metricCompartmentId": { "type": "string", "description": "The OCID of the compartment containing the metrics.\n", "willReplaceOnChanges": true }, "metricSource": { "type": "string", "description": "Source of the metric data for creating the alarm used to trigger autoscaling actions.\n\nThe following values are supported:\n* `COMPUTE_AGENT`: CPU or memory metrics emitted by the Compute Instance Monitoring plugin.\n* `CUSTOM_QUERY`: A custom Monitoring Query Language (MQL) expression.\n", "willReplaceOnChanges": true }, "metricType": { "type": "string", "willReplaceOnChanges": true }, "namespace": { "type": "string", "description": "The namespace for the query.\n", "willReplaceOnChanges": true }, "pendingDuration": { "type": "string", "description": "The period of time that the condition defined in the alarm must persist before the alarm state changes from \"OK\" to \"FIRING\" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to \"FIRING\"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to \"OK.\"\n\nThe duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT1H. Default: PT3M.\n", "willReplaceOnChanges": true }, "query": { "type": "string", "description": "The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: \u003cspan pulumi-lang-nodejs=\"`1m`\" pulumi-lang-dotnet=\"`1m`\" pulumi-lang-go=\"`1m`\" pulumi-lang-python=\"`1m`\" pulumi-lang-yaml=\"`1m`\" pulumi-lang-java=\"`1m`\" pulumi-lang-hcl=\"`1m`\"\u003e`1m`\u003c/span\u003e-\u003cspan pulumi-lang-nodejs=\"`60m`\" pulumi-lang-dotnet=\"`60m`\" pulumi-lang-go=\"`60m`\" pulumi-lang-python=\"`60m`\" pulumi-lang-yaml=\"`60m`\" pulumi-lang-java=\"`60m`\" pulumi-lang-hcl=\"`60m`\"\u003e`60m`\u003c/span\u003e (also \u003cspan pulumi-lang-nodejs=\"`1h`\" pulumi-lang-dotnet=\"`1h`\" pulumi-lang-go=\"`1h`\" pulumi-lang-python=\"`1h`\" pulumi-lang-yaml=\"`1h`\" pulumi-lang-java=\"`1h`\" pulumi-lang-hcl=\"`1h`\"\u003e`1h`\u003c/span\u003e). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.\n\nExample of threshold alarm:\n\n-----\n\nCpuUtilization[1m]{availabilityDomain=\"cumS:PHX-AD-1\"}.groupBy(availabilityDomain).percentile(0.9) \u003e 85\n\n-----\n", "willReplaceOnChanges": true }, "resourceGroup": { "type": "string", "description": "The resource group for the query.\n", "willReplaceOnChanges": true }, "threshold": { "$ref": "#/types/oci:Autoscaling/AutoScalingConfigurationPolicyRuleMetricThreshold:AutoScalingConfigurationPolicyRuleMetricThreshold", "willReplaceOnChanges": true } }, "type": "object" }, "oci:Autoscaling/AutoScalingConfigurationPolicyRuleMetricThreshold:AutoScalingConfigurationPolicyRuleMetricThreshold": { "properties": { "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (`GT`), greater than or equal to (`GTE`), less than (`LT`), and less than or equal to (`LTE`).\n", "willReplaceOnChanges": true }, "value": { "type": "integer", "description": "** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "operator", "value" ] } } }, "oci:Autoscaling/getAutoScalingConfigurationAutoScalingResource:getAutoScalingConfigurationAutoScalingResource": { "properties": { "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "type": { "type": "string", "description": "The type of action to take.\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicy:getAutoScalingConfigurationPolicy": { "properties": { "capacities": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyCapacity:getAutoScalingConfigurationPolicyCapacity" }, "description": "The capacity requirements of the autoscaling policy.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "executionSchedules": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyExecutionSchedule:getAutoScalingConfigurationPolicyExecutionSchedule" }, "description": "The schedule for executing the autoscaling policy.\n" }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "isEnabled": { "type": "boolean", "description": "Whether the autoscaling policy is enabled.\n" }, "policyType": { "type": "string", "description": "The type of autoscaling policy.\n" }, "resourceActions": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyResourceAction:getAutoScalingConfigurationPolicyResourceAction" }, "description": "An action to run on a resource, such as stopping or starting an instance pool.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationPolicyRule" } }, "timeCreated": { "type": "string", "description": "The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "capacities", "displayName", "executionSchedules", "id", "isEnabled", "policyType", "resourceActions", "rules", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyCapacity:getAutoScalingConfigurationPolicyCapacity": { "properties": { "initial": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.\n" }, "max": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out).\n" }, "min": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in).\n" } }, "type": "object", "required": [ "initial", "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyExecutionSchedule:getAutoScalingConfigurationPolicyExecutionSchedule": { "properties": { "expression": { "type": "string", "description": "A cron expression that represents the time at which to execute the autoscaling policy.\n" }, "timezone": { "type": "string", "description": "The time zone for the execution schedule.\n" }, "type": { "type": "string", "description": "The type of action to take.\n" } }, "type": "object", "required": [ "expression", "timezone", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyResourceAction:getAutoScalingConfigurationPolicyResourceAction": { "properties": { "action": { "type": "string", "description": "The action to take when autoscaling is triggered.\n" }, "actionType": { "type": "string", "description": "The category of action to run on the resource.\n" } }, "type": "object", "required": [ "action", "actionType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationPolicyRule": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyRuleAction:getAutoScalingConfigurationPolicyRuleAction" }, "description": "The action to take when autoscaling is triggered.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationPolicyRuleMetric" } } }, "type": "object", "required": [ "actions", "displayName", "id", "metrics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyRuleAction:getAutoScalingConfigurationPolicyRuleAction": { "properties": { "type": { "type": "string", "description": "The type of action to take.\n" }, "value": { "type": "integer" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationPolicyRuleMetric": { "properties": { "metricCompartmentId": { "type": "string", "description": "The OCID of the compartment containing the metrics.\n" }, "metricSource": { "type": "string", "description": "Source of the metric data for creating the alarm used to trigger autoscaling actions.\n" }, "metricType": { "type": "string", "description": "Metric type example: CPU_UTILIZATION, MEMORY_UTILIZATION\n" }, "namespace": { "type": "string", "description": "The namespace for the query.\n" }, "pendingDuration": { "type": "string", "description": "The period of time that the condition defined in the alarm must persist before the alarm state changes from \"OK\" to \"FIRING\" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to \"FIRING\"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to \"OK.\"\n" }, "query": { "type": "string", "description": "The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: \u003cspan pulumi-lang-nodejs=\"`1m`\" pulumi-lang-dotnet=\"`1m`\" pulumi-lang-go=\"`1m`\" pulumi-lang-python=\"`1m`\" pulumi-lang-yaml=\"`1m`\" pulumi-lang-java=\"`1m`\" pulumi-lang-hcl=\"`1m`\"\u003e`1m`\u003c/span\u003e-\u003cspan pulumi-lang-nodejs=\"`60m`\" pulumi-lang-dotnet=\"`60m`\" pulumi-lang-go=\"`60m`\" pulumi-lang-python=\"`60m`\" pulumi-lang-yaml=\"`60m`\" pulumi-lang-java=\"`60m`\" pulumi-lang-hcl=\"`60m`\"\u003e`60m`\u003c/span\u003e (also \u003cspan pulumi-lang-nodejs=\"`1h`\" pulumi-lang-dotnet=\"`1h`\" pulumi-lang-go=\"`1h`\" pulumi-lang-python=\"`1h`\" pulumi-lang-yaml=\"`1h`\" pulumi-lang-java=\"`1h`\" pulumi-lang-hcl=\"`1h`\"\u003e`1h`\u003c/span\u003e). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.\n" }, "resourceGroup": { "type": "string", "description": "The resource group for the query.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationPolicyRuleMetricThreshold" } } }, "type": "object", "required": [ "metricCompartmentId", "metricSource", "metricType", "namespace", "pendingDuration", "query", "resourceGroup", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationPolicyRuleMetricThreshold": { "properties": { "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (`GT`), greater than or equal to (`GTE`), less than (`LT`), and less than or equal to (`LTE`).\n" }, "value": { "type": "integer" } }, "type": "object", "required": [ "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfiguration:getAutoScalingConfigurationsAutoScalingConfiguration": { "properties": { "autoScalingResources": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationAutoScalingResource:getAutoScalingConfigurationsAutoScalingConfigurationAutoScalingResource" }, "description": "A resource that is managed by an autoscaling configuration. The only supported type is \"instancePool.\"\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment.\n" }, "coolDownInSeconds": { "type": "integer", "description": "For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "isEnabled": { "type": "boolean", "description": "Whether the autoscaling policy is enabled.\n" }, "maxResourceCount": { "type": "integer", "description": "The maximum number of resources to scale out to.\n" }, "minResourceCount": { "type": "integer", "description": "The minimum number of resources to scale in to.\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicy:getAutoScalingConfigurationsAutoScalingConfigurationPolicy" }, "description": "Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.\n" }, "timeCreated": { "type": "string", "description": "The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "autoScalingResources", "compartmentId", "coolDownInSeconds", "definedTags", "displayName", "freeformTags", "id", "isEnabled", "maxResourceCount", "minResourceCount", "policies", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationAutoScalingResource:getAutoScalingConfigurationsAutoScalingConfigurationAutoScalingResource": { "properties": { "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "type": { "type": "string", "description": "The type of action to take.\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicy:getAutoScalingConfigurationsAutoScalingConfigurationPolicy": { "properties": { "capacities": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyCapacity:getAutoScalingConfigurationsAutoScalingConfigurationPolicyCapacity" }, "description": "The capacity requirements of the autoscaling policy.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "executionSchedules": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyExecutionSchedule:getAutoScalingConfigurationsAutoScalingConfigurationPolicyExecutionSchedule" }, "description": "The schedule for executing the autoscaling policy.\n" }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "isEnabled": { "type": "boolean", "description": "Whether the autoscaling policy is enabled.\n" }, "policyType": { "type": "string", "description": "The type of autoscaling policy.\n" }, "resourceActions": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyResourceAction:getAutoScalingConfigurationsAutoScalingConfigurationPolicyResourceAction" }, "description": "An action to run on a resource, such as stopping or starting an instance pool.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule" } }, "timeCreated": { "type": "string", "description": "The date and time the autoscaling configuration was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "capacities", "displayName", "executionSchedules", "id", "isEnabled", "policyType", "resourceActions", "rules", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyCapacity:getAutoScalingConfigurationsAutoScalingConfigurationPolicyCapacity": { "properties": { "initial": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.\n" }, "max": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out).\n" }, "min": { "type": "integer", "description": "For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in).\n" } }, "type": "object", "required": [ "initial", "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyExecutionSchedule:getAutoScalingConfigurationsAutoScalingConfigurationPolicyExecutionSchedule": { "properties": { "expression": { "type": "string", "description": "A cron expression that represents the time at which to execute the autoscaling policy.\n" }, "timezone": { "type": "string", "description": "The time zone for the execution schedule.\n" }, "type": { "type": "string", "description": "The type of action to take.\n" } }, "type": "object", "required": [ "expression", "timezone", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyResourceAction:getAutoScalingConfigurationsAutoScalingConfigurationPolicyResourceAction": { "properties": { "action": { "type": "string", "description": "The action to take when autoscaling is triggered.\n" }, "actionType": { "type": "string", "description": "The category of action to run on the resource.\n" } }, "type": "object", "required": [ "action", "actionType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule": { "properties": { "actions": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleAction:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleAction" }, "description": "The action to take when autoscaling is triggered.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "id": { "type": "string", "description": "ID of the condition that is assigned after creation.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric" }, "description": "Metric type example: CPU_UTILIZATION, MEMORY_UTILIZATION\n" } }, "type": "object", "required": [ "actions", "displayName", "id", "metrics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleAction:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleAction": { "properties": { "type": { "type": "string", "description": "The type of action to take.\n" }, "value": { "type": "integer" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric": { "properties": { "metricCompartmentId": { "type": "string", "description": "The OCID of the compartment containing the metrics.\n" }, "metricSource": { "type": "string", "description": "Source of the metric data for creating the alarm used to trigger autoscaling actions.\n" }, "metricType": { "type": "string" }, "namespace": { "type": "string", "description": "The namespace for the query.\n" }, "pendingDuration": { "type": "string", "description": "The period of time that the condition defined in the alarm must persist before the alarm state changes from \"OK\" to \"FIRING\" or vice versa. For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to \"FIRING\"; likewise, the alarm must persist in not breaching the condition for five minutes before the alarm updates its state to \"OK.\"\n" }, "query": { "type": "string", "description": "The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval: \u003cspan pulumi-lang-nodejs=\"`1m`\" pulumi-lang-dotnet=\"`1m`\" pulumi-lang-go=\"`1m`\" pulumi-lang-python=\"`1m`\" pulumi-lang-yaml=\"`1m`\" pulumi-lang-java=\"`1m`\" pulumi-lang-hcl=\"`1m`\"\u003e`1m`\u003c/span\u003e-\u003cspan pulumi-lang-nodejs=\"`60m`\" pulumi-lang-dotnet=\"`60m`\" pulumi-lang-go=\"`60m`\" pulumi-lang-python=\"`60m`\" pulumi-lang-yaml=\"`60m`\" pulumi-lang-java=\"`60m`\" pulumi-lang-hcl=\"`60m`\"\u003e`60m`\u003c/span\u003e (also \u003cspan pulumi-lang-nodejs=\"`1h`\" pulumi-lang-dotnet=\"`1h`\" pulumi-lang-go=\"`1h`\" pulumi-lang-python=\"`1h`\" pulumi-lang-yaml=\"`1h`\" pulumi-lang-java=\"`1h`\" pulumi-lang-hcl=\"`1h`\"\u003e`1h`\u003c/span\u003e). You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`.\n" }, "resourceGroup": { "type": "string", "description": "The resource group for the query.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold" } } }, "type": "object", "required": [ "metricCompartmentId", "metricSource", "metricType", "namespace", "pendingDuration", "query", "resourceGroup", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold": { "properties": { "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (`GT`), greater than or equal to (`GTE`), less than (`LT`), and less than or equal to (`LTE`).\n" }, "value": { "type": "integer" } }, "type": "object", "required": [ "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Autoscaling/getAutoScalingConfigurationsFilter:getAutoScalingConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Bastion/SessionKeyDetails:SessionKeyDetails": { "properties": { "publicKeyContent": { "type": "string", "description": "The public key in OpenSSH format of the SSH key pair for the session. When you connect to the session, you must provide the private key of the same SSH key pair.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "publicKeyContent" ] }, "oci:Bastion/SessionTargetResourceDetails:SessionTargetResourceDetails": { "properties": { "sessionType": { "type": "string", "description": "The session type.\n", "willReplaceOnChanges": true }, "targetResourceDisplayName": { "type": "string", "description": "The display name of the target Compute instance that the session connects to.\n" }, "targetResourceFqdn": { "type": "string", "description": "The Fully Qualified Domain Name of the target resource that the session connects to.\n", "willReplaceOnChanges": true }, "targetResourceId": { "type": "string", "description": "The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.\n", "willReplaceOnChanges": true }, "targetResourceOperatingSystemUserName": { "type": "string", "description": "The name of the user on the target resource operating system that the session uses for the connection.\n", "willReplaceOnChanges": true }, "targetResourcePort": { "type": "integer", "description": "The port number to connect to on the target resource.\n", "willReplaceOnChanges": true }, "targetResourcePrivateIpAddress": { "type": "string", "description": "The private IP address of the target resource that the session connects to.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sessionType" ], "language": { "nodejs": { "requiredOutputs": [ "sessionType", "targetResourceDisplayName", "targetResourceFqdn", "targetResourceId", "targetResourceOperatingSystemUserName", "targetResourcePort", "targetResourcePrivateIpAddress" ] } } }, "oci:Bastion/getBastionsBastion:getBastionsBastion": { "properties": { "bastionType": { "type": "string", "description": "The type of bastion.\n" }, "clientCidrBlockAllowLists": { "type": "array", "items": { "type": "string" }, "description": "A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.\n" }, "compartmentId": { "type": "string", "description": "The unique identifier (OCID) of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "dnsProxyStatus": { "type": "string", "description": "Flag to enable FQDN and SOCKS5 Proxy Support. Example: `ENABLED`, `DISABLED`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The unique identifier (OCID) of the bastion, which can't be changed after creation.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail.\n" }, "maxSessionTtlInSeconds": { "type": "integer", "description": "The maximum amount of time that any session on the bastion can remain active.\n" }, "maxSessionsAllowed": { "type": "integer", "description": "The maximum number of active sessions allowed on the bastion.\n" }, "name": { "type": "string", "description": "A filter to return only resources that match the entire name given.\n" }, "phoneBookEntry": { "type": "string", "description": "The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to \u003cspan pulumi-lang-nodejs=\"`standard`\" pulumi-lang-dotnet=\"`Standard`\" pulumi-lang-go=\"`standard`\" pulumi-lang-python=\"`standard`\" pulumi-lang-yaml=\"`standard`\" pulumi-lang-java=\"`standard`\" pulumi-lang-hcl=\"`standard`\"\u003e`standard`\u003c/span\u003e bastions.\n" }, "privateEndpointIpAddress": { "type": "string", "description": "The private IP address of the created private endpoint.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: `{\"Oracle-DataSecurity-ZPR.MaxEgressCount.value\": \"42\", \"Oracle-DataSecurity-ZPR.MaxEgressCount.mode\": \"audit\"}`\n" }, "state": { "type": "string", "description": "The current state of the bastion.\n" }, "staticJumpHostIpAddresses": { "type": "array", "items": { "type": "string" }, "description": "A list of IP addresses of the hosts that the bastion has access to. Not applicable to \u003cspan pulumi-lang-nodejs=\"`standard`\" pulumi-lang-dotnet=\"`Standard`\" pulumi-lang-go=\"`standard`\" pulumi-lang-python=\"`standard`\" pulumi-lang-yaml=\"`standard`\" pulumi-lang-java=\"`standard`\" pulumi-lang-hcl=\"`standard`\"\u003e`standard`\u003c/span\u003e bastions.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetSubnetId": { "type": "string", "description": "The unique identifier (OCID) of the subnet that the bastion connects to.\n" }, "targetVcnId": { "type": "string", "description": "The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.\n" }, "timeCreated": { "type": "string", "description": "The time the bastion was created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the bastion was updated. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "bastionType", "clientCidrBlockAllowLists", "compartmentId", "definedTags", "dnsProxyStatus", "freeformTags", "id", "lifecycleDetails", "maxSessionTtlInSeconds", "maxSessionsAllowed", "name", "phoneBookEntry", "privateEndpointIpAddress", "securityAttributes", "state", "staticJumpHostIpAddresses", "systemTags", "targetSubnetId", "targetVcnId", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Bastion/getBastionsFilter:getBastionsFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only resources that match the entire name given.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Bastion/getSessionKeyDetail:getSessionKeyDetail": { "properties": { "publicKeyContent": { "type": "string", "description": "The public key in OpenSSH format of the SSH key pair for the session. When you connect to the session, you must provide the private key of the same SSH key pair.\n" } }, "type": "object", "required": [ "publicKeyContent" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Bastion/getSessionTargetResourceDetail:getSessionTargetResourceDetail": { "properties": { "sessionType": { "type": "string", "description": "The Bastion service recognizes three types of sessions, managed SSH sessions, SSH port forwarding sessions, and Dynamic SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.\n" }, "targetResourceDisplayName": { "type": "string", "description": "The display name of the target Compute instance that the session connects to.\n" }, "targetResourceFqdn": { "type": "string", "description": "The Fully Qualified Domain Name of the target resource that the session connects to.\n" }, "targetResourceId": { "type": "string", "description": "The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.\n" }, "targetResourceOperatingSystemUserName": { "type": "string", "description": "The name of the user on the target resource operating system that the session uses for the connection.\n" }, "targetResourcePort": { "type": "integer", "description": "The port number to connect to on the target resource.\n" }, "targetResourcePrivateIpAddress": { "type": "string", "description": "The private IP address of the target resource that the session connects to.\n" } }, "type": "object", "required": [ "sessionType", "targetResourceDisplayName", "targetResourceFqdn", "targetResourceId", "targetResourceOperatingSystemUserName", "targetResourcePort", "targetResourcePrivateIpAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Bastion/getSessionsFilter:getSessionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Bastion/getSessionsSession:getSessionsSession": { "properties": { "bastionId": { "type": "string", "description": "The unique identifier (OCID) of the bastion in which to list sessions.\n" }, "bastionName": { "type": "string", "description": "The name of the bastion that is hosting this session.\n" }, "bastionPublicHostKeyInfo": { "type": "string", "description": "The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.\n" }, "bastionUserName": { "type": "string", "description": "The username that the session uses to connect to the target resource.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "id": { "type": "string", "description": "The unique identifier (OCID) of the session, which can't be changed after creation.\n" }, "keyDetails": { "type": "array", "items": { "$ref": "#/types/oci:Bastion/getSessionsSessionKeyDetail:getSessionsSessionKeyDetail" }, "description": "Public key details for a bastion session.\n" }, "keyType": { "type": "string", "description": "The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current session state in more detail.\n" }, "sessionTtlInSeconds": { "type": "integer", "description": "The amount of time the session can remain active.\n" }, "sshMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The connection message for the session.\n" }, "state": { "type": "string", "description": "The current state of the session.\n" }, "targetResourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Bastion/getSessionsSessionTargetResourceDetail:getSessionsSessionTargetResourceDetail" }, "description": "Details about a bastion session's target resource.\n" }, "timeCreated": { "type": "string", "description": "The time the session was created. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The time the session was updated. Format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-01-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "bastionId", "bastionName", "bastionPublicHostKeyInfo", "bastionUserName", "displayName", "id", "keyDetails", "keyType", "lifecycleDetails", "sessionTtlInSeconds", "sshMetadata", "state", "targetResourceDetails", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Bastion/getSessionsSessionKeyDetail:getSessionsSessionKeyDetail": { "properties": { "publicKeyContent": { "type": "string", "description": "The public key in OpenSSH format of the SSH key pair for the session. When you connect to the session, you must provide the private key of the same SSH key pair.\n" } }, "type": "object", "required": [ "publicKeyContent" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Bastion/getSessionsSessionTargetResourceDetail:getSessionsSessionTargetResourceDetail": { "properties": { "sessionType": { "type": "string", "description": "The Bastion service recognizes three types of sessions, managed SSH sessions, SSH port forwarding sessions, and Dynamic SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.\n" }, "targetResourceDisplayName": { "type": "string", "description": "The display name of the target Compute instance that the session connects to.\n" }, "targetResourceFqdn": { "type": "string", "description": "The Fully Qualified Domain Name of the target resource that the session connects to.\n" }, "targetResourceId": { "type": "string", "description": "The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.\n" }, "targetResourceOperatingSystemUserName": { "type": "string", "description": "The name of the user on the target resource operating system that the session uses for the connection.\n" }, "targetResourcePort": { "type": "integer", "description": "The port number to connect to on the target resource.\n" }, "targetResourcePrivateIpAddress": { "type": "string", "description": "The private IP address of the target resource that the session connects to.\n" } }, "type": "object", "required": [ "sessionType", "targetResourceDisplayName", "targetResourceFqdn", "targetResourceId", "targetResourceOperatingSystemUserName", "targetResourcePort", "targetResourcePrivateIpAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/AutoScalingConfigurationPolicy:AutoScalingConfigurationPolicy": { "properties": { "policyType": { "type": "string", "description": "(Updatable) Types of autoscale policies. Options are SCHEDULE-BASED or THRESHOLD-BASED. (Only THRESHOLD-BASED is supported in this release.)\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyRule:AutoScalingConfigurationPolicyRule" }, "description": "(Updatable) The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied.\n" } }, "type": "object", "required": [ "policyType", "rules" ] }, "oci:BigDataService/AutoScalingConfigurationPolicyDetails:AutoScalingConfigurationPolicyDetails": { "properties": { "actionType": { "type": "string", "description": "The type of autoscaling action to take.\n" }, "policyType": { "type": "string", "description": "Type of autoscaling policy.\n", "willReplaceOnChanges": true }, "scaleDownConfig": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleDownConfig:AutoScalingConfigurationPolicyDetailsScaleDownConfig", "description": "(Updatable) Configration for a metric based vertical scale-down policy.\n" }, "scaleInConfig": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleInConfig:AutoScalingConfigurationPolicyDetailsScaleInConfig", "description": "(Updatable) Configration for a metric based horizontal scale-in policy.\n" }, "scaleOutConfig": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleOutConfig:AutoScalingConfigurationPolicyDetailsScaleOutConfig", "description": "(Updatable) Configration for a metric based horizontal scale-out policy.\n" }, "scaleUpConfig": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleUpConfig:AutoScalingConfigurationPolicyDetailsScaleUpConfig", "description": "(Updatable) Configration for a metric based vertical scale-up policy.\n" }, "scheduleDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScheduleDetail:AutoScalingConfigurationPolicyDetailsScheduleDetail" }, "description": "(Updatable) Details of a horizontal scaling schedule.\n" }, "timezone": { "type": "string", "description": "(Updatable) The time zone of the execution schedule, in IANA time zone database name format\n" }, "triggerType": { "type": "string", "description": "The type of autoscaling trigger.\n" } }, "type": "object", "required": [ "policyType" ], "language": { "nodejs": { "requiredOutputs": [ "actionType", "policyType", "scaleDownConfig", "scaleInConfig", "scaleOutConfig", "scaleUpConfig", "scheduleDetails", "timezone", "triggerType" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleDownConfig:AutoScalingConfigurationPolicyDetailsScaleDownConfig": { "properties": { "memoryStepSize": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the size of memory in GBs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.\n" }, "metric": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleDownConfigMetric:AutoScalingConfigurationPolicyDetailsScaleDownConfigMetric", "description": "(Updatable) Metric and threshold details for triggering an autoscale action.\n" }, "minMemoryPerNode": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the minimum memory in GBs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.\n" }, "minOcpusPerNode": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the minimum number of OCPUs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.\n" }, "ocpuStepSize": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the number of OCPUs to remove from each node during a scale-down event. This value is not used for nodes with fixed compute shapes.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "memoryStepSize", "metric", "minMemoryPerNode", "minOcpusPerNode", "ocpuStepSize" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleDownConfigMetric:AutoScalingConfigurationPolicyDetailsScaleDownConfigMetric": { "properties": { "metricType": { "type": "string", "description": "(Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "threshold": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleDownConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleDownConfigMetricThreshold", "description": "(Updatable) An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metricType", "threshold" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleDownConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleDownConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "(Updatable) This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "(Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "(Updatable) Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "durationInMinutes", "operator", "value" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleInConfig:AutoScalingConfigurationPolicyDetailsScaleInConfig": { "properties": { "metric": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleInConfigMetric:AutoScalingConfigurationPolicyDetailsScaleInConfigMetric", "description": "(Updatable) Metric and threshold details for triggering an autoscale action.\n" }, "minNodeCount": { "type": "integer", "description": "(Updatable) This value is the minimum number of nodes the cluster can be scaled-in to.\n" }, "stepSize": { "type": "integer", "description": "(Updatable) This value is the number of nodes to remove during a scale-in event.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metric", "minNodeCount", "stepSize" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleInConfigMetric:AutoScalingConfigurationPolicyDetailsScaleInConfigMetric": { "properties": { "metricType": { "type": "string", "description": "(Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "threshold": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleInConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleInConfigMetricThreshold", "description": "(Updatable) An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metricType", "threshold" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleInConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleInConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "(Updatable) This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "(Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "(Updatable) Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "durationInMinutes", "operator", "value" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleOutConfig:AutoScalingConfigurationPolicyDetailsScaleOutConfig": { "properties": { "maxNodeCount": { "type": "integer", "description": "(Updatable) This value is the maximum number of nodes the cluster can be scaled-out to.\n" }, "metric": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleOutConfigMetric:AutoScalingConfigurationPolicyDetailsScaleOutConfigMetric", "description": "(Updatable) Metric and threshold details for triggering an autoscale action.\n" }, "stepSize": { "type": "integer", "description": "(Updatable) This value is the number of nodes to add during a scale-out event.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maxNodeCount", "metric", "stepSize" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleOutConfigMetric:AutoScalingConfigurationPolicyDetailsScaleOutConfigMetric": { "properties": { "metricType": { "type": "string", "description": "(Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "threshold": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleOutConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleOutConfigMetricThreshold", "description": "(Updatable) An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metricType", "threshold" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleOutConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleOutConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "(Updatable) This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "(Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "(Updatable) Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "durationInMinutes", "operator", "value" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleUpConfig:AutoScalingConfigurationPolicyDetailsScaleUpConfig": { "properties": { "maxMemoryPerNode": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the maximum memory in GBs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.\n" }, "maxOcpusPerNode": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the maximum number of OCPUs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.\n" }, "memoryStepSize": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the size of memory in GBs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.\n" }, "metric": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleUpConfigMetric:AutoScalingConfigurationPolicyDetailsScaleUpConfigMetric", "description": "(Updatable) Metric and threshold details for triggering an autoscale action.\n" }, "ocpuStepSize": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the number of OCPUs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "maxMemoryPerNode", "maxOcpusPerNode", "memoryStepSize", "metric", "ocpuStepSize" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleUpConfigMetric:AutoScalingConfigurationPolicyDetailsScaleUpConfigMetric": { "properties": { "metricType": { "type": "string", "description": "(Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "threshold": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleUpConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleUpConfigMetricThreshold", "description": "(Updatable) An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metricType", "threshold" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScaleUpConfigMetricThreshold:AutoScalingConfigurationPolicyDetailsScaleUpConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "(Updatable) This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "(Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "(Updatable) Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "durationInMinutes", "operator", "value" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScheduleDetail:AutoScalingConfigurationPolicyDetailsScheduleDetail": { "properties": { "scheduleType": { "type": "string", "description": "(Updatable) The type of schedule.\n" }, "timeAndHorizontalScalingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndHorizontalScalingConfig:AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndHorizontalScalingConfig" }, "description": "(Updatable) Time of day and horizontal scaling configuration.\n" }, "timeAndVerticalScalingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndVerticalScalingConfig:AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndVerticalScalingConfig" }, "description": "(Updatable) Time of day and vertical scaling configuration\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "scheduleType", "timeAndHorizontalScalingConfigs", "timeAndVerticalScalingConfigs" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndHorizontalScalingConfig:AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndHorizontalScalingConfig": { "properties": { "targetNodeCount": { "type": "integer", "description": "(Updatable) This value is the desired number of nodes in the cluster.\n" }, "timeRecurrence": { "type": "string", "description": "(Updatable) Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "targetNodeCount", "timeRecurrence" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndVerticalScalingConfig:AutoScalingConfigurationPolicyDetailsScheduleDetailTimeAndVerticalScalingConfig": { "properties": { "targetMemoryPerNode": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired memory in GBs on each node. This value is not used for nodes with fixed compute shapes.\n" }, "targetOcpusPerNode": { "type": "integer", "description": "(Updatable) For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired OCPUs count on each node. This value is not used for nodes with fixed compute shapes.\n" }, "targetShape": { "type": "string", "description": "(Updatable) For nodes with [fixed compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired shape of each node. This value is not used for nodes with flexible compute shapes.\n" }, "timeRecurrence": { "type": "string", "description": "(Updatable) Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "targetMemoryPerNode", "targetOcpusPerNode", "targetShape", "timeRecurrence" ] } } }, "oci:BigDataService/AutoScalingConfigurationPolicyRule:AutoScalingConfigurationPolicyRule": { "properties": { "action": { "type": "string", "description": "(Updatable) The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN.\n" }, "metric": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyRuleMetric:AutoScalingConfigurationPolicyRuleMetric", "description": "(Updatable) Metric and threshold details for triggering an autoscale action.\n" } }, "type": "object", "required": [ "action", "metric" ] }, "oci:BigDataService/AutoScalingConfigurationPolicyRuleMetric:AutoScalingConfigurationPolicyRuleMetric": { "properties": { "metricType": { "type": "string", "description": "(Updatable) Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "threshold": { "$ref": "#/types/oci:BigDataService/AutoScalingConfigurationPolicyRuleMetricThreshold:AutoScalingConfigurationPolicyRuleMetricThreshold", "description": "(Updatable) An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "required": [ "metricType", "threshold" ] }, "oci:BigDataService/AutoScalingConfigurationPolicyRuleMetricThreshold:AutoScalingConfigurationPolicyRuleMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "(Updatable) This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "(Updatable) The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "(Updatable) Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ] }, "oci:BigDataService/BdsCapacityReportShapeAvailability:BdsCapacityReportShapeAvailability": { "properties": { "domainLevelCapacityReports": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/BdsCapacityReportShapeAvailabilityDomainLevelCapacityReport:BdsCapacityReportShapeAvailabilityDomainLevelCapacityReport" }, "description": "Information about the capacity in each domain.\n" }, "shape": { "type": "string", "description": "The shape that you want to request a capacity report for.\n", "willReplaceOnChanges": true }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsCapacityReportShapeAvailabilityShapeConfig:BdsCapacityReportShapeAvailabilityShapeConfig", "description": "The shape configuration requested for the node.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "shape" ], "language": { "nodejs": { "requiredOutputs": [ "domainLevelCapacityReports", "shape", "shapeConfig" ] } } }, "oci:BigDataService/BdsCapacityReportShapeAvailabilityDomainLevelCapacityReport:BdsCapacityReportShapeAvailabilityDomainLevelCapacityReport": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain for the capacity report.\n" }, "capacityAvailabilities": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/BdsCapacityReportShapeAvailabilityDomainLevelCapacityReportCapacityAvailability:BdsCapacityReportShapeAvailabilityDomainLevelCapacityReportCapacityAvailability" }, "description": "Information about the available capacity for a shape.\n" }, "domainType": { "type": "string", "description": "Type of domain level for the capacity report.\n" }, "faultDomain": { "type": "string", "description": "The fault domain for the capacity report.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "capacityAvailabilities", "domainType", "faultDomain" ] } } }, "oci:BigDataService/BdsCapacityReportShapeAvailabilityDomainLevelCapacityReportCapacityAvailability:BdsCapacityReportShapeAvailabilityDomainLevelCapacityReportCapacityAvailability": { "properties": { "availabilityStatus": { "type": "string", "description": "A flag denoting whether capacity is available.\n" }, "availableCount": { "type": "string", "description": "The total number of new cluster nodes that can be created with the specified shape configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availabilityStatus", "availableCount" ] } } }, "oci:BigDataService/BdsCapacityReportShapeAvailabilityShapeConfig:BdsCapacityReportShapeAvailabilityShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n", "willReplaceOnChanges": true }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available. This parameter is used only for dense shapes.\n", "willReplaceOnChanges": true }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "memoryInGbs", "nvmes", "ocpus" ] } } }, "oci:BigDataService/BdsInstanceBdsClusterVersionSummary:BdsInstanceBdsClusterVersionSummary": { "properties": { "bdsVersion": { "type": "string", "description": "BDS version to be used for cluster creation\n", "willReplaceOnChanges": true }, "odhVersion": { "type": "string", "description": "ODH version to be used for cluster creation\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bdsVersion" ], "language": { "nodejs": { "requiredOutputs": [ "bdsVersion", "odhVersion" ] } } }, "oci:BigDataService/BdsInstanceCloudSqlDetail:BdsInstanceCloudSqlDetail": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "ipAddress": { "type": "string", "description": "IP address of the node\n" }, "isKerberosMappedToDatabaseUsers": { "type": "boolean", "description": "Boolean flag specifying whether or not are Kerberos principals mapped to database users.\n" }, "kerberosDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/BdsInstanceCloudSqlDetailKerberosDetail:BdsInstanceCloudSqlDetailKerberosDetail" }, "description": "Details about Kerberos principals\n" }, "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" }, "shape": { "type": "string", "description": "Shape of the node\n" } }, "type": "object", "required": [ "shape" ], "language": { "nodejs": { "requiredOutputs": [ "blockVolumeSizeInGbs", "ipAddress", "isKerberosMappedToDatabaseUsers", "kerberosDetails", "memoryInGbs", "nvmes", "ocpus", "shape" ] } } }, "oci:BigDataService/BdsInstanceCloudSqlDetailKerberosDetail:BdsInstanceCloudSqlDetailKerberosDetail": { "properties": { "keytabFile": { "type": "string", "description": "Location of the keytab file\n" }, "principalName": { "type": "string", "description": "Name of the Kerberos principal\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "keytabFile", "principalName" ] } } }, "oci:BigDataService/BdsInstanceClusterDetail:BdsInstanceClusterDetail": { "properties": { "ambariUrl": { "type": "string", "description": "The URL of Ambari\n" }, "bdCellVersion": { "type": "string", "description": "Cloud SQL cell version.\n" }, "bdaVersion": { "type": "string", "description": "BDA version installed in the cluster\n" }, "bdmVersion": { "type": "string", "description": "Big Data Manager version installed in the cluster.\n" }, "bdsVersion": { "type": "string", "description": "Big Data Service version installed in the cluster.\n" }, "bigDataManagerUrl": { "type": "string", "description": "The URL of Big Data Manager.\n" }, "clouderaManagerUrl": { "type": "string", "description": "The URL of Cloudera Manager\n" }, "csqlCellVersion": { "type": "string", "description": "Big Data SQL version.\n" }, "dbVersion": { "type": "string", "description": "Cloud SQL query server database version.\n" }, "hueServerUrl": { "type": "string", "description": "The URL of the Hue server.\n" }, "jupyterHubUrl": { "type": "string", "description": "The URL of the Jupyterhub.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" }, "osVersion": { "type": "string", "description": "BDS-assigned Operating System version for the node.\n" }, "timeCreated": { "type": "string", "description": "The time the BDS instance was created. An RFC3339 formatted datetime string\n" }, "timeRefreshed": { "type": "string", "description": "The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ambariUrl", "bdCellVersion", "bdaVersion", "bdmVersion", "bdsVersion", "bigDataManagerUrl", "clouderaManagerUrl", "csqlCellVersion", "dbVersion", "hueServerUrl", "jupyterHubUrl", "odhVersion", "osVersion", "timeCreated", "timeRefreshed" ] } } }, "oci:BigDataService/BdsInstanceComputeOnlyWorkerNode:BdsInstanceComputeOnlyWorkerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "Number of nodes that forming the cluster\n" }, "shape": { "type": "string", "description": "Shape of the node\n" }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsInstanceComputeOnlyWorkerNodeShapeConfig:BdsInstanceComputeOnlyWorkerNodeShapeConfig" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node should be created\n" } }, "type": "object", "required": [ "numberOfNodes", "shape", "subnetId" ] }, "oci:BigDataService/BdsInstanceComputeOnlyWorkerNodeShapeConfig:BdsInstanceComputeOnlyWorkerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nvmes" ] } } }, "oci:BigDataService/BdsInstanceEdgeNode:BdsInstanceEdgeNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "Number of nodes that forming the cluster\n" }, "shape": { "type": "string", "description": "Shape of the node\n" }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsInstanceEdgeNodeShapeConfig:BdsInstanceEdgeNodeShapeConfig" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node should be created\n" } }, "type": "object", "required": [ "numberOfNodes", "shape", "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "numberOfNodes", "shape", "shapeConfig", "subnetId" ] } } }, "oci:BigDataService/BdsInstanceEdgeNodeShapeConfig:BdsInstanceEdgeNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nvmes" ] } } }, "oci:BigDataService/BdsInstanceIdentityConfigurationIamUserSyncConfiguration:BdsInstanceIdentityConfigurationIamUserSyncConfiguration": { "properties": { "isPosixAttributesAdditionRequired": { "type": "boolean", "description": "whether to append POSIX attributes to IAM users\n" }, "state": { "type": "string", "description": "Lifecycle state of the UPST config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isPosixAttributesAdditionRequired", "state", "timeCreated", "timeUpdated" ] } } }, "oci:BigDataService/BdsInstanceIdentityConfigurationIamUserSyncConfigurationDetails:BdsInstanceIdentityConfigurationIamUserSyncConfigurationDetails": { "properties": { "isPosixAttributesAdditionRequired": { "type": "boolean", "description": "(Updatable) whether posix attribute needs to be appended to users, required for updating IAM user sync configuration\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isPosixAttributesAdditionRequired" ] } } }, "oci:BigDataService/BdsInstanceIdentityConfigurationUpstConfiguration:BdsInstanceIdentityConfigurationUpstConfiguration": { "properties": { "keytabContent": { "type": "string", "description": "The kerberos keytab content used for creating identity propagation trust config, in base64 format\n" }, "masterEncryptionKeyId": { "type": "string", "description": "Master Encryption key used for encrypting token exchange keytab.\n" }, "secretId": { "type": "string", "description": "(Updatable) The secretId for the clusterAdminPassword.\n" }, "state": { "type": "string", "description": "Lifecycle state of the UPST config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeTokenExchangeKeytabLastRefreshed": { "type": "string", "description": "Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" }, "tokenExchangePrincipalName": { "type": "string", "description": "Token exchange kerberos Principal name in cluster\n" }, "vaultId": { "type": "string", "description": "The instance OCID of the node, which is the resource from which the node backup was acquired.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "keytabContent", "masterEncryptionKeyId", "secretId", "state", "timeCreated", "timeTokenExchangeKeytabLastRefreshed", "timeUpdated", "tokenExchangePrincipalName", "vaultId" ] } } }, "oci:BigDataService/BdsInstanceIdentityConfigurationUpstConfigurationDetails:BdsInstanceIdentityConfigurationUpstConfigurationDetails": { "properties": { "masterEncryptionKeyId": { "type": "string", "description": "(Updatable) OCID of the master encryption key in vault for encrypting token exchange service principal keytab, required for activating UPST config\n" }, "vaultId": { "type": "string", "description": "(Updatable) OCID of the vault to store token exchange service principal keyta, required for activating UPST config\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "masterEncryptionKeyId", "vaultId" ] } } }, "oci:BigDataService/BdsInstanceKafkaBrokerNode:BdsInstanceKafkaBrokerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfKafkaNodes": { "type": "integer" }, "shape": { "type": "string", "description": "Shape of the node\n" }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsInstanceKafkaBrokerNodeShapeConfig:BdsInstanceKafkaBrokerNodeShapeConfig", "description": "The shape configuration requested for the node.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node should be created\n" } }, "type": "object", "required": [ "numberOfKafkaNodes", "shape", "subnetId" ] }, "oci:BigDataService/BdsInstanceKafkaBrokerNodeShapeConfig:BdsInstanceKafkaBrokerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nvmes" ] } } }, "oci:BigDataService/BdsInstanceMasterNode:BdsInstanceMasterNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n", "willReplaceOnChanges": true }, "numberOfNodes": { "type": "integer", "description": "The amount of master nodes should be created.\n" }, "shape": { "type": "string", "description": "Shape of the node\n" }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsInstanceMasterNodeShapeConfig:BdsInstanceMasterNodeShapeConfig", "description": "The shape configuration requested for the node.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node should be created\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "numberOfNodes", "shape", "subnetId" ] }, "oci:BigDataService/BdsInstanceMasterNodeShapeConfig:BdsInstanceMasterNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nvmes" ] } } }, "oci:BigDataService/BdsInstanceNetworkConfig:BdsInstanceNetworkConfig": { "properties": { "cidrBlock": { "type": "string", "description": "(Updatable) The CIDR IP address block of the VCN.\n" }, "isNatGatewayRequired": { "type": "boolean", "description": "(Updatable) A boolean flag whether to configure a NAT gateway.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cidrBlock", "isNatGatewayRequired" ] } } }, "oci:BigDataService/BdsInstanceNode:BdsInstanceNode": { "properties": { "attachedBlockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/BdsInstanceNodeAttachedBlockVolume:BdsInstanceNodeAttachedBlockVolume" }, "description": "The list of block volumes attached to a given node.\n" }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain the node is running in\n" }, "displayName": { "type": "string", "description": "(Updatable) Name of the BDS instance\n" }, "faultDomain": { "type": "string", "description": "The name of the fault domain the node is running in\n" }, "hostname": { "type": "string", "description": "The fully-qualified hostname (FQDN) of the node\n" }, "imageId": { "type": "string", "description": "The OCID of the image from which the node was created\n" }, "instanceId": { "type": "string", "description": "The OCID of the underlying compute instance\n" }, "ipAddress": { "type": "string", "description": "IP address of the node\n" }, "isRebootRequired": { "type": "boolean", "description": "Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.\n" }, "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nodeType": { "type": "string", "description": "The Big Data Service cluster node type.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" }, "osVersion": { "type": "string", "description": "BDS-assigned Operating System version for the node.\n" }, "shape": { "type": "string", "description": "(Updatable) Shape of the node.\n" }, "sshFingerprint": { "type": "string", "description": "The fingerprint of the SSH key used for node access\n" }, "state": { "type": "string", "description": "(Updatable) The target state for the Bds Instance. Could be set to `ACTIVE` or `INACTIVE`.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node will be created.\n" }, "timeCreated": { "type": "string", "description": "The time the BDS instance was created. An RFC3339 formatted datetime string\n" }, "timeMaintenanceRebootDue": { "type": "string", "description": "The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachedBlockVolumes", "availabilityDomain", "displayName", "faultDomain", "hostname", "imageId", "instanceId", "ipAddress", "isRebootRequired", "localDisksTotalSizeInGbs", "memoryInGbs", "nodeType", "nvmes", "ocpus", "odhVersion", "osVersion", "shape", "sshFingerprint", "state", "subnetId", "timeCreated", "timeMaintenanceRebootDue" ] } } }, "oci:BigDataService/BdsInstanceNodeAttachedBlockVolume:BdsInstanceNodeAttachedBlockVolume": { "properties": { "volumeAttachmentId": { "type": "string", "description": "The OCID of the volume attachment.\n" }, "volumeSizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "volumeAttachmentId", "volumeSizeInGbs" ] } } }, "oci:BigDataService/BdsInstanceNodeBackupConfigurationLevelTypeDetails:BdsInstanceNodeBackupConfigurationLevelTypeDetails": { "properties": { "levelType": { "type": "string", "description": "(Updatable) Type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "nodeHostName": { "type": "string", "description": "(Updatable) Host name of the node to create backup configuration.\n" }, "nodeType": { "type": "string", "description": "(Updatable) Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created. Accepted values are MASTER and UTILITY.\n" } }, "type": "object", "required": [ "levelType" ], "language": { "nodejs": { "requiredOutputs": [ "levelType", "nodeHostName", "nodeType" ] } } }, "oci:BigDataService/BdsInstanceNodeBackupLevelTypeDetails:BdsInstanceNodeBackupLevelTypeDetails": { "properties": { "levelType": { "type": "string", "description": "Type of level used to trigger the creation of a new node backup.\n" }, "nodeHostName": { "type": "string", "description": "(Updatable) Host name of the node to create backup.\n" }, "nodeType": { "type": "string", "description": "(Updatable) Type of the node or nodes of the node backup which are going to be created.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "levelType" ], "language": { "nodejs": { "requiredOutputs": [ "levelType", "nodeHostName", "nodeType" ] } } }, "oci:BigDataService/BdsInstanceNodeReplaceConfigurationLevelTypeDetails:BdsInstanceNodeReplaceConfigurationLevelTypeDetails": { "properties": { "levelType": { "type": "string", "description": "(Updatable) Type of level used to trigger the creation of a new node backup configuration or node replacement configuration. Accepted values are NODE_LEVEL and NODE_TYPE_LEVEL.\n" }, "nodeHostName": { "type": "string", "description": "(Updatable) Host name of the node to create backup configuration.\n" }, "nodeType": { "type": "string", "description": "(Updatable) Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created.\n" } }, "type": "object", "required": [ "levelType" ], "language": { "nodejs": { "requiredOutputs": [ "levelType", "nodeHostName", "nodeType" ] } } }, "oci:BigDataService/BdsInstanceOperationCertificateManagementsManagementHostCertDetail:BdsInstanceOperationCertificateManagementsManagementHostCertDetail": { "properties": { "certificate": { "type": "string", "description": "Certificate value in string format\n", "willReplaceOnChanges": true }, "hostName": { "type": "string", "description": "Fully qualified domain name (FQDN) of the host\n", "willReplaceOnChanges": true }, "privateKey": { "type": "string", "description": "Private key of the provided certificate\n", "secret": true, "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificate", "hostName", "privateKey" ] } } }, "oci:BigDataService/BdsInstanceOsPatchActionPatchingConfigs:BdsInstanceOsPatchActionPatchingConfigs": { "properties": { "batchSize": { "type": "integer", "description": "How many nodes to be patched in each iteration.\n" }, "patchingConfigStrategy": { "type": "string", "description": "Type of strategy used for detailed patching configuration\n", "willReplaceOnChanges": true }, "toleranceThresholdPerBatch": { "type": "integer", "description": "Acceptable number of failed-to-be-patched nodes in each batch. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of nodes.\n" }, "toleranceThresholdPerDomain": { "type": "integer", "description": "Acceptable number of failed-to-be-patched nodes in each domain. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of nodes.\n" }, "waitTimeBetweenBatchInSeconds": { "type": "integer", "description": "The wait time between batches in seconds.\n" }, "waitTimeBetweenDomainInSeconds": { "type": "integer", "description": "The wait time between AD/FD in seconds.\n" } }, "type": "object", "required": [ "patchingConfigStrategy" ], "language": { "nodejs": { "requiredOutputs": [ "batchSize", "patchingConfigStrategy", "toleranceThresholdPerBatch", "toleranceThresholdPerDomain", "waitTimeBetweenBatchInSeconds", "waitTimeBetweenDomainInSeconds" ] } } }, "oci:BigDataService/BdsInstancePatchActionPatchingConfig:BdsInstancePatchActionPatchingConfig": { "properties": { "batchSize": { "type": "integer", "description": "How many nodes to be patched in each iteration.\n", "willReplaceOnChanges": true }, "patchingConfigStrategy": { "type": "string", "description": "Type of strategy used for detailed patching configuration\n", "willReplaceOnChanges": true }, "toleranceThresholdPerBatch": { "type": "integer", "description": "Acceptable number of failed-to-be-patched nodes in each batch. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes.\n", "willReplaceOnChanges": true }, "toleranceThresholdPerDomain": { "type": "integer", "description": "Acceptable number of failed-to-be-patched nodes in each domain. The maximum number of failed-to-patch nodes cannot exceed 20% of the number of non-utility and non-master nodes.\n", "willReplaceOnChanges": true }, "waitTimeBetweenBatchInSeconds": { "type": "integer", "description": "The wait time between batches in seconds.\n", "willReplaceOnChanges": true }, "waitTimeBetweenDomainInSeconds": { "type": "integer", "description": "The wait time between AD/FD in seconds.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "patchingConfigStrategy" ], "language": { "nodejs": { "requiredOutputs": [ "batchSize", "patchingConfigStrategy", "toleranceThresholdPerBatch", "toleranceThresholdPerDomain", "waitTimeBetweenBatchInSeconds", "waitTimeBetweenDomainInSeconds" ] } } }, "oci:BigDataService/BdsInstanceStartClusterShapeConfig:BdsInstanceStartClusterShapeConfig": { "properties": { "nodeTypeShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/BdsInstanceStartClusterShapeConfigNodeTypeShapeConfig:BdsInstanceStartClusterShapeConfigNodeTypeShapeConfig" } } }, "type": "object" }, "oci:BigDataService/BdsInstanceStartClusterShapeConfigNodeTypeShapeConfig:BdsInstanceStartClusterShapeConfigNodeTypeShapeConfig": { "properties": { "nodeType": { "type": "string", "description": "BDS instance node type\n" }, "shape": { "type": "string", "description": "Shape of the node\n" } }, "type": "object" }, "oci:BigDataService/BdsInstanceUtilNode:BdsInstanceUtilNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n", "willReplaceOnChanges": true }, "numberOfNodes": { "type": "integer", "description": "The amount of utility nodes should be created.\n" }, "shape": { "type": "string", "description": "Shape of the node\n" }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsInstanceUtilNodeShapeConfig:BdsInstanceUtilNodeShapeConfig", "description": "The shape configuration requested for the node.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node should be created\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "numberOfNodes", "shape", "subnetId" ] }, "oci:BigDataService/BdsInstanceUtilNodeShapeConfig:BdsInstanceUtilNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nvmes" ] } } }, "oci:BigDataService/BdsInstanceWorkerNode:BdsInstanceWorkerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "Number of nodes that forming the cluster\n" }, "shape": { "type": "string", "description": "Shape of the node\n" }, "shapeConfig": { "$ref": "#/types/oci:BigDataService/BdsInstanceWorkerNodeShapeConfig:BdsInstanceWorkerNodeShapeConfig" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node should be created\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "numberOfNodes", "shape", "subnetId" ] }, "oci:BigDataService/BdsInstanceWorkerNodeShapeConfig:BdsInstanceWorkerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nvmes" ] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicy:getAutoScalingConfigurationPolicy": { "properties": { "policyType": { "type": "string", "description": "Type of autoscaling policy.\n" }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationPolicyRule" }, "description": "The list of rules for autoscaling. If an action has multiple rules, the last rule in the array will be applied.\n" } }, "type": "object", "required": [ "policyType", "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetail:getAutoScalingConfigurationPolicyDetail": { "properties": { "actionType": { "type": "string", "description": "The type of autoscaling action to take.\n" }, "policyType": { "type": "string", "description": "Type of autoscaling policy.\n" }, "scaleDownConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleDownConfig:getAutoScalingConfigurationPolicyDetailScaleDownConfig" }, "description": "Configration for a metric based vertical scale-down policy.\n" }, "scaleInConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleInConfig:getAutoScalingConfigurationPolicyDetailScaleInConfig" }, "description": "Configration for a metric based horizontal scale-in policy.\n" }, "scaleOutConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleOutConfig:getAutoScalingConfigurationPolicyDetailScaleOutConfig" }, "description": "Configration for a metric based horizontal scale-out policy.\n" }, "scaleUpConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleUpConfig:getAutoScalingConfigurationPolicyDetailScaleUpConfig" }, "description": "Configration for a metric based vertical scale-up policy.\n" }, "scheduleDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScheduleDetail:getAutoScalingConfigurationPolicyDetailScheduleDetail" }, "description": "Details of a horizontal scaling schedule.\n" }, "timezone": { "type": "string", "description": "The time zone of the execution schedule, in IANA time zone database name format\n" }, "triggerType": { "type": "string", "description": "The type of autoscaling trigger.\n" } }, "type": "object", "required": [ "actionType", "policyType", "scaleDownConfigs", "scaleInConfigs", "scaleOutConfigs", "scaleUpConfigs", "scheduleDetails", "timezone", "triggerType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleDownConfig:getAutoScalingConfigurationPolicyDetailScaleDownConfig": { "properties": { "memoryStepSize": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the size of memory in GBs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleDownConfigMetric:getAutoScalingConfigurationPolicyDetailScaleDownConfigMetric" }, "description": "Metric and threshold details for triggering an autoscale action.\n" }, "minMemoryPerNode": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the minimum memory in GBs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.\n" }, "minOcpusPerNode": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the minimum number of OCPUs each node can be scaled-down to. This value is not used for nodes with fixed compute shapes.\n" }, "ocpuStepSize": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the number of OCPUs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.\n" } }, "type": "object", "required": [ "memoryStepSize", "metrics", "minMemoryPerNode", "minOcpusPerNode", "ocpuStepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleDownConfigMetric:getAutoScalingConfigurationPolicyDetailScaleDownConfigMetric": { "properties": { "metricType": { "type": "string", "description": "Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold" }, "description": "An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleInConfig:getAutoScalingConfigurationPolicyDetailScaleInConfig": { "properties": { "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleInConfigMetric:getAutoScalingConfigurationPolicyDetailScaleInConfigMetric" }, "description": "Metric and threshold details for triggering an autoscale action.\n" }, "minNodeCount": { "type": "integer", "description": "This value is the minimum number of nodes the cluster can be scaled-in to.\n" }, "stepSize": { "type": "integer", "description": "This value is the number of nodes to add during a scale-out event.\n" } }, "type": "object", "required": [ "metrics", "minNodeCount", "stepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleInConfigMetric:getAutoScalingConfigurationPolicyDetailScaleInConfigMetric": { "properties": { "metricType": { "type": "string", "description": "Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold" }, "description": "An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleOutConfig:getAutoScalingConfigurationPolicyDetailScaleOutConfig": { "properties": { "maxNodeCount": { "type": "integer", "description": "This value is the maximum number of nodes the cluster can be scaled-out to.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleOutConfigMetric:getAutoScalingConfigurationPolicyDetailScaleOutConfigMetric" }, "description": "Metric and threshold details for triggering an autoscale action.\n" }, "stepSize": { "type": "integer", "description": "This value is the number of nodes to add during a scale-out event.\n" } }, "type": "object", "required": [ "maxNodeCount", "metrics", "stepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleOutConfigMetric:getAutoScalingConfigurationPolicyDetailScaleOutConfigMetric": { "properties": { "metricType": { "type": "string", "description": "Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold" }, "description": "An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleUpConfig:getAutoScalingConfigurationPolicyDetailScaleUpConfig": { "properties": { "maxMemoryPerNode": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the maximum memory in GBs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.\n" }, "maxOcpusPerNode": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the maximum number of OCPUs each node can be scaled-up to. This value is not used for nodes with fixed compute shapes.\n" }, "memoryStepSize": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the size of memory in GBs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleUpConfigMetric:getAutoScalingConfigurationPolicyDetailScaleUpConfigMetric" }, "description": "Metric and threshold details for triggering an autoscale action.\n" }, "ocpuStepSize": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the number of OCPUs to add to each node during a scale-up event. This value is not used for nodes with fixed compute shapes.\n" } }, "type": "object", "required": [ "maxMemoryPerNode", "maxOcpusPerNode", "memoryStepSize", "metrics", "ocpuStepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleUpConfigMetric:getAutoScalingConfigurationPolicyDetailScaleUpConfigMetric": { "properties": { "metricType": { "type": "string", "description": "Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold" }, "description": "An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold:getAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScheduleDetail:getAutoScalingConfigurationPolicyDetailScheduleDetail": { "properties": { "scheduleType": { "type": "string", "description": "The type of schedule.\n" }, "timeAndHorizontalScalingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig:getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig" }, "description": "Time of day and horizontal scaling configuration.\n" }, "timeAndVerticalScalingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig:getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig" }, "description": "Time of day and vertical scaling configuration\n" } }, "type": "object", "required": [ "scheduleType", "timeAndHorizontalScalingConfigs", "timeAndVerticalScalingConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig:getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig": { "properties": { "targetNodeCount": { "type": "integer", "description": "This value is the desired number of nodes in the cluster.\n" }, "timeRecurrence": { "type": "string", "description": "Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.\n" } }, "type": "object", "required": [ "targetNodeCount", "timeRecurrence" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig:getAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig": { "properties": { "targetMemoryPerNode": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired memory in GBs on each node. This value is not used for nodes with fixed compute shapes.\n" }, "targetOcpusPerNode": { "type": "integer", "description": "For nodes with [flexible compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired OCPUs count on each node. This value is not used for nodes with fixed compute shapes.\n" }, "targetShape": { "type": "string", "description": "For nodes with [fixed compute shapes](https://docs.cloud.oracle.com/iaas/Content/bigdata/create-cluster.htm#cluster-plan-shape), this value is the desired shape of each node. This value is not used for nodes with flexible compute shapes.\n" }, "timeRecurrence": { "type": "string", "description": "Day/time recurrence (specified following RFC 5545) at which to trigger autoscaling action. Currently only WEEKLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR and BYMINUTE fields. Other fields are not supported.\n" } }, "type": "object", "required": [ "targetMemoryPerNode", "targetOcpusPerNode", "targetShape", "timeRecurrence" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationPolicyRule": { "properties": { "action": { "type": "string", "description": "The valid value are CHANGE_SHAPE_SCALE_UP or CHANGE_SHAPE_SCALE_DOWN.\n" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationPolicyRuleMetric" }, "description": "Metric and threshold details for triggering an autoscale action.\n" } }, "type": "object", "required": [ "action", "metrics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationPolicyRuleMetric": { "properties": { "metricType": { "type": "string", "description": "Allowed values are CPU_UTILIZATION and MEMORY_UTILIZATION.\n" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationPolicyRuleMetricThreshold" }, "description": "An autoscale action is triggered when a performance metric exceeds a threshold.\n" } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationPolicyRuleMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer", "description": "This value is the minimum period of time the metric value exceeds the threshold value before the action is triggered. The value is in minutes.\n" }, "operator": { "type": "string", "description": "The comparison operator to use. Options are greater than (GT) or less than (LT).\n" }, "value": { "type": "integer", "description": "Integer non-negative value. 0 \u003c value \u003c 100\n" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfiguration:getAutoScalingConfigurationsAutoScalingConfiguration": { "properties": { "bdsInstanceId": { "type": "string" }, "clusterAdminPassword": { "type": "string", "secret": true }, "displayName": { "type": "string" }, "id": { "type": "string" }, "isEnabled": { "type": "boolean" }, "nodeType": { "type": "string" }, "policies": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicy:getAutoScalingConfigurationsAutoScalingConfigurationPolicy" } }, "policyDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetail:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetail" } }, "secretId": { "type": "string" }, "state": { "type": "string" }, "timeCreated": { "type": "string" }, "timeUpdated": { "type": "string" } }, "type": "object", "required": [ "bdsInstanceId", "clusterAdminPassword", "displayName", "id", "isEnabled", "nodeType", "policies", "policyDetails", "secretId", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicy:getAutoScalingConfigurationsAutoScalingConfigurationPolicy": { "properties": { "policyType": { "type": "string" }, "rules": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule" } } }, "type": "object", "required": [ "policyType", "rules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetail:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetail": { "properties": { "actionType": { "type": "string" }, "policyType": { "type": "string" }, "scaleDownConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfig" } }, "scaleInConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfig" } }, "scaleOutConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfig" } }, "scaleUpConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfig" } }, "scheduleDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetail:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetail" } }, "timezone": { "type": "string" }, "triggerType": { "type": "string" } }, "type": "object", "required": [ "actionType", "policyType", "scaleDownConfigs", "scaleInConfigs", "scaleOutConfigs", "scaleUpConfigs", "scheduleDetails", "timezone", "triggerType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfig": { "properties": { "memoryStepSize": { "type": "integer" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetric" } }, "minMemoryPerNode": { "type": "integer" }, "minOcpusPerNode": { "type": "integer" }, "ocpuStepSize": { "type": "integer" } }, "type": "object", "required": [ "memoryStepSize", "metrics", "minMemoryPerNode", "minOcpusPerNode", "ocpuStepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetric": { "properties": { "metricType": { "type": "string" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold" } } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleDownConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer" }, "operator": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfig": { "properties": { "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetric" } }, "minNodeCount": { "type": "integer" }, "stepSize": { "type": "integer" } }, "type": "object", "required": [ "metrics", "minNodeCount", "stepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetric": { "properties": { "metricType": { "type": "string" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold" } } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleInConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer" }, "operator": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfig": { "properties": { "maxNodeCount": { "type": "integer" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetric" } }, "stepSize": { "type": "integer" } }, "type": "object", "required": [ "maxNodeCount", "metrics", "stepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetric": { "properties": { "metricType": { "type": "string" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold" } } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleOutConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer" }, "operator": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfig": { "properties": { "maxMemoryPerNode": { "type": "integer" }, "maxOcpusPerNode": { "type": "integer" }, "memoryStepSize": { "type": "integer" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetric" } }, "ocpuStepSize": { "type": "integer" } }, "type": "object", "required": [ "maxMemoryPerNode", "maxOcpusPerNode", "memoryStepSize", "metrics", "ocpuStepSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetric": { "properties": { "metricType": { "type": "string" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold" } } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScaleUpConfigMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer" }, "operator": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetail:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetail": { "properties": { "scheduleType": { "type": "string" }, "timeAndHorizontalScalingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig" } }, "timeAndVerticalScalingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig" } } }, "type": "object", "required": [ "scheduleType", "timeAndHorizontalScalingConfigs", "timeAndVerticalScalingConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndHorizontalScalingConfig": { "properties": { "targetNodeCount": { "type": "integer" }, "timeRecurrence": { "type": "string" } }, "type": "object", "required": [ "targetNodeCount", "timeRecurrence" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig:getAutoScalingConfigurationsAutoScalingConfigurationPolicyDetailScheduleDetailTimeAndVerticalScalingConfig": { "properties": { "targetMemoryPerNode": { "type": "integer" }, "targetOcpusPerNode": { "type": "integer" }, "targetShape": { "type": "string" }, "timeRecurrence": { "type": "string" } }, "type": "object", "required": [ "targetMemoryPerNode", "targetOcpusPerNode", "targetShape", "timeRecurrence" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRule": { "properties": { "action": { "type": "string" }, "metrics": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric" } } }, "type": "object", "required": [ "action", "metrics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetric": { "properties": { "metricType": { "type": "string" }, "thresholds": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold" } } }, "type": "object", "required": [ "metricType", "thresholds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold:getAutoScalingConfigurationsAutoScalingConfigurationPolicyRuleMetricThreshold": { "properties": { "durationInMinutes": { "type": "integer" }, "operator": { "type": "string" }, "value": { "type": "integer" } }, "type": "object", "required": [ "durationInMinutes", "operator", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getAutoScalingConfigurationsFilter:getAutoScalingConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsClusterVersionsBdsClusterVersion:getBdsClusterVersionsBdsClusterVersion": { "properties": { "bdsVersion": { "type": "string", "description": "BDS version to be used for cluster creation\n" }, "odhVersion": { "type": "string", "description": "ODH version to be used for cluster creation\n" } }, "type": "object", "required": [ "bdsVersion", "odhVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsClusterVersionsFilter:getBdsClusterVersionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceApiKeysBdsApiKey:getBdsInstanceApiKeysBdsApiKey": { "properties": { "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "defaultRegion": { "type": "string", "description": "The name of the region to establish the Object Storage endpoint which was set as part of key creation operation. If no region was provided this will be set to be the same region where the cluster lives. Example us-phoenix-1 .\n" }, "domainOcid": { "type": "string", "description": "Identity domain OCID ,where user is present. For default domain ,this field will be optional.\n" }, "fingerprint": { "type": "string", "description": "The fingerprint that corresponds to the public API key requested.\n" }, "id": { "type": "string", "description": "Identifier of the user's API key.\n" }, "keyAlias": { "type": "string", "description": "User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.\n" }, "passphrase": { "type": "string", "secret": true }, "pemfilepath": { "type": "string", "description": "The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system.\n" }, "state": { "type": "string", "description": "The current status of the API key.\n" }, "tenantId": { "type": "string", "description": "The OCID of your tenancy.\n" }, "timeCreated": { "type": "string", "description": "The time the API key was created, shown as an RFC 3339 formatted datetime string.\n" }, "userId": { "type": "string", "description": "The user OCID for which this API key was created.\n" } }, "type": "object", "required": [ "bdsInstanceId", "defaultRegion", "domainOcid", "fingerprint", "id", "keyAlias", "passphrase", "pemfilepath", "state", "tenantId", "timeCreated", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceApiKeysFilter:getBdsInstanceApiKeysFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceBdsCertificateConfigurationsBdsCertificateConfiguration:getBdsInstanceBdsCertificateConfigurationsBdsCertificateConfiguration": { "properties": { "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "certificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority which is associated with this certificate configuration. The value is Null when this BDS certificate configuration type is SELF_SIGNED.\n" }, "certificateType": { "type": "string" }, "clusterAdminPassword": { "type": "string", "secret": true }, "compartmentId": { "type": "string", "description": "The OCID of the compartment of the certificate authority connecting to this certificate configuration.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "id": { "type": "string", "description": "The ID of the BDS certificate configuration defined under BDS resources, not OCID.\n" }, "isDefaultConfiguration": { "type": "boolean", "description": "If this BDS certificate configuration is a default configuration or not. There will be only one Default certificate configuration per BDS cluster.\n" }, "isMissingNodesOnly": { "type": "boolean" }, "issueCertificateTrigger": { "type": "string" }, "renewCertificateTrigger": { "type": "string" }, "secretId": { "type": "string" }, "setDefaultTrigger": { "type": "string" }, "state": { "type": "string", "description": "The state of the BdsCertificateConfiguration.\n" }, "timeCreated": { "type": "string", "description": "The time when the BDS certificate configuration was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeLastRefreshedOrGenerated": { "type": "string", "description": "The last time the BDS certificate configuration was used to generate or renew the certificate(s).\n" }, "timeUpdated": { "type": "string", "description": "The time the BDS certificate configuration was updated, shown as an RFC 3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "The type of the BDS certificate configuration, also the type of the BDS certificates which will be generated by the BDS certificate configuration.\n" } }, "type": "object", "required": [ "bdsInstanceId", "certificateAuthorityId", "certificateType", "clusterAdminPassword", "compartmentId", "displayName", "id", "isDefaultConfiguration", "isMissingNodesOnly", "issueCertificateTrigger", "renewCertificateTrigger", "secretId", "setDefaultTrigger", "state", "timeCreated", "timeLastRefreshedOrGenerated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceBdsCertificateConfigurationsFilter:getBdsInstanceBdsCertificateConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceBdsClusterVersionSummary:getBdsInstanceBdsClusterVersionSummary": { "properties": { "bdsVersion": { "type": "string", "description": "Big Data Service version installed in the cluster.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" } }, "type": "object", "required": [ "bdsVersion", "odhVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceCloudSqlDetail:getBdsInstanceCloudSqlDetail": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "ipAddress": { "type": "string", "description": "IP address of the node.\n" }, "isKerberosMappedToDatabaseUsers": { "type": "boolean", "description": "Boolean flag specifying whether or not Kerberos principals are mapped to database users.\n" }, "kerberosDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceCloudSqlDetailKerberosDetail:getBdsInstanceCloudSqlDetailKerberosDetail" }, "description": "Details about the Kerberos principals.\n" }, "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "ipAddress", "isKerberosMappedToDatabaseUsers", "kerberosDetails", "memoryInGbs", "nvmes", "ocpus", "shape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceCloudSqlDetailKerberosDetail:getBdsInstanceCloudSqlDetailKerberosDetail": { "properties": { "keytabFile": { "type": "string", "description": "Location of the keytab file\n" }, "principalName": { "type": "string", "description": "Name of the Kerberos principal.\n" } }, "type": "object", "required": [ "keytabFile", "principalName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceClusterDetail:getBdsInstanceClusterDetail": { "properties": { "ambariUrl": { "type": "string", "description": "The URL of Ambari\n" }, "bdCellVersion": { "type": "string", "description": "Cloud SQL cell version.\n" }, "bdaVersion": { "type": "string", "description": "BDA version installed in the cluster\n" }, "bdmVersion": { "type": "string", "description": "Big Data Manager version installed in the cluster.\n" }, "bdsVersion": { "type": "string", "description": "Big Data Service version installed in the cluster.\n" }, "bigDataManagerUrl": { "type": "string", "description": "The URL of Big Data Manager.\n" }, "clouderaManagerUrl": { "type": "string", "description": "The URL of Cloudera Manager\n" }, "csqlCellVersion": { "type": "string", "description": "Big Data SQL version.\n" }, "dbVersion": { "type": "string", "description": "Cloud SQL query server database version.\n" }, "hueServerUrl": { "type": "string", "description": "The URL of the Hue server.\n" }, "jupyterHubUrl": { "type": "string", "description": "The URL of the Jupyterhub.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" }, "osVersion": { "type": "string", "description": "BDS-assigned Operating System version for the node.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeRefreshed": { "type": "string", "description": "The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "ambariUrl", "bdCellVersion", "bdaVersion", "bdmVersion", "bdsVersion", "bigDataManagerUrl", "clouderaManagerUrl", "csqlCellVersion", "dbVersion", "hueServerUrl", "jupyterHubUrl", "odhVersion", "osVersion", "timeCreated", "timeRefreshed" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceComputeOnlyWorkerNode:getBdsInstanceComputeOnlyWorkerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceComputeOnlyWorkerNodeShapeConfig:getBdsInstanceComputeOnlyWorkerNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceComputeOnlyWorkerNodeShapeConfig:getBdsInstanceComputeOnlyWorkerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceEdgeNode:getBdsInstanceEdgeNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceEdgeNodeShapeConfig:getBdsInstanceEdgeNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceEdgeNodeShapeConfig:getBdsInstanceEdgeNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceGetOsPatchFilter:getBdsInstanceGetOsPatchFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceGetOsPatchTargetPackage:getBdsInstanceGetOsPatchTargetPackage": { "properties": { "packageName": { "type": "string", "description": "The package's name.\n" }, "packageType": { "type": "string", "description": "Package type based on package installation manager.\n" }, "relatedCvEs": { "type": "array", "items": { "type": "string" }, "description": "Related CVEs of the package update.\n" }, "targetVersion": { "type": "string", "description": "The target version of the package.\n" }, "updateType": { "type": "string", "description": "The action that current package will be executed on the cluster.\n" } }, "type": "object", "required": [ "packageName", "packageType", "relatedCvEs", "targetVersion", "updateType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationIamUserSyncConfiguration:getBdsInstanceIdentityConfigurationIamUserSyncConfiguration": { "properties": { "isPosixAttributesAdditionRequired": { "type": "boolean", "description": "whether to append POSIX attributes to IAM users\n" }, "state": { "type": "string", "description": "Lifecycle state of the UPST config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "isPosixAttributesAdditionRequired", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationIamUserSyncConfigurationDetail:getBdsInstanceIdentityConfigurationIamUserSyncConfigurationDetail": { "properties": { "isPosixAttributesAdditionRequired": { "type": "boolean", "description": "whether to append POSIX attributes to IAM users\n" } }, "type": "object", "required": [ "isPosixAttributesAdditionRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationUpstConfiguration:getBdsInstanceIdentityConfigurationUpstConfiguration": { "properties": { "keytabContent": { "type": "string", "description": "The kerberos keytab content used for creating identity propagation trust config, in base64 format\n" }, "masterEncryptionKeyId": { "type": "string", "description": "Master Encryption key used for encrypting token exchange keytab.\n" }, "secretId": { "type": "string", "description": "Secret ID for token exchange keytab\n" }, "state": { "type": "string", "description": "Lifecycle state of the UPST config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeTokenExchangeKeytabLastRefreshed": { "type": "string", "description": "Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" }, "tokenExchangePrincipalName": { "type": "string", "description": "Token exchange kerberos Principal name in cluster\n" }, "vaultId": { "type": "string", "description": "The instance OCID of the node, which is the resource from which the node backup was acquired.\n" } }, "type": "object", "required": [ "keytabContent", "masterEncryptionKeyId", "secretId", "state", "timeCreated", "timeTokenExchangeKeytabLastRefreshed", "timeUpdated", "tokenExchangePrincipalName", "vaultId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationUpstConfigurationDetail:getBdsInstanceIdentityConfigurationUpstConfigurationDetail": { "properties": { "masterEncryptionKeyId": { "type": "string", "description": "Master Encryption key used for encrypting token exchange keytab.\n" }, "vaultId": { "type": "string", "description": "The instance OCID of the node, which is the resource from which the node backup was acquired.\n" } }, "type": "object", "required": [ "masterEncryptionKeyId", "vaultId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationsFilter:getBdsInstanceIdentityConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfiguration:getBdsInstanceIdentityConfigurationsIdentityConfiguration": { "properties": { "activateIamUserSyncConfigurationTrigger": { "type": "string" }, "activateUpstConfigurationTrigger": { "type": "string" }, "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "clusterAdminPassword": { "type": "string", "secret": true }, "confidentialApplicationId": { "type": "string", "description": "identity domain confidential application ID for the identity config\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "iamUserSyncConfigurationDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfigurationDetail:getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfigurationDetail" } }, "iamUserSyncConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfiguration:getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfiguration" }, "description": "Information about the IAM user sync configuration.\n" }, "id": { "type": "string", "description": "The id of the identity config\n" }, "identityDomainId": { "type": "string", "description": "Identity domain to use for identity config\n" }, "refreshConfidentialApplicationTrigger": { "type": "string" }, "refreshUpstTokenExchangeKeytabTrigger": { "type": "string" }, "state": { "type": "string", "description": "The state of the identity config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" }, "upstConfigurationDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfigurationDetail:getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfigurationDetail" } }, "upstConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfiguration:getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfiguration" }, "description": "Information about the UPST configuration.\n" } }, "type": "object", "required": [ "activateIamUserSyncConfigurationTrigger", "activateUpstConfigurationTrigger", "bdsInstanceId", "clusterAdminPassword", "confidentialApplicationId", "displayName", "iamUserSyncConfigurations", "iamUserSyncConfigurationDetails", "id", "identityDomainId", "refreshConfidentialApplicationTrigger", "refreshUpstTokenExchangeKeytabTrigger", "state", "timeCreated", "timeUpdated", "upstConfigurations", "upstConfigurationDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfiguration:getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfiguration": { "properties": { "isPosixAttributesAdditionRequired": { "type": "boolean", "description": "whether to append POSIX attributes to IAM users\n" }, "state": { "type": "string", "description": "The state of the identity config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "isPosixAttributesAdditionRequired", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfigurationDetail:getBdsInstanceIdentityConfigurationsIdentityConfigurationIamUserSyncConfigurationDetail": { "properties": { "isPosixAttributesAdditionRequired": { "type": "boolean", "description": "whether to append POSIX attributes to IAM users\n" } }, "type": "object", "required": [ "isPosixAttributesAdditionRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfiguration:getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfiguration": { "properties": { "keytabContent": { "type": "string", "description": "The kerberos keytab content used for creating identity propagation trust config, in base64 format\n" }, "masterEncryptionKeyId": { "type": "string", "description": "Master Encryption key used for encrypting token exchange keytab.\n" }, "secretId": { "type": "string", "description": "Secret ID for token exchange keytab\n" }, "state": { "type": "string", "description": "The state of the identity config\n" }, "timeCreated": { "type": "string", "description": "Time when this UPST config was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeTokenExchangeKeytabLastRefreshed": { "type": "string", "description": "Time when the keytab for token exchange principal is last refreshed, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Time when this UPST config was updated, shown as an RFC 3339 formatted datetime string.\n" }, "tokenExchangePrincipalName": { "type": "string", "description": "Token exchange kerberos Principal name in cluster\n" }, "vaultId": { "type": "string", "description": "The instance OCID of the node, which is the resource from which the node backup was acquired.\n" } }, "type": "object", "required": [ "keytabContent", "masterEncryptionKeyId", "secretId", "state", "timeCreated", "timeTokenExchangeKeytabLastRefreshed", "timeUpdated", "tokenExchangePrincipalName", "vaultId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfigurationDetail:getBdsInstanceIdentityConfigurationsIdentityConfigurationUpstConfigurationDetail": { "properties": { "masterEncryptionKeyId": { "type": "string", "description": "Master Encryption key used for encrypting token exchange keytab.\n" }, "vaultId": { "type": "string", "description": "The instance OCID of the node, which is the resource from which the node backup was acquired.\n" } }, "type": "object", "required": [ "masterEncryptionKeyId", "vaultId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceKafkaBrokerNode:getBdsInstanceKafkaBrokerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfKafkaNodes": { "type": "integer" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceKafkaBrokerNodeShapeConfig:getBdsInstanceKafkaBrokerNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfKafkaNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceKafkaBrokerNodeShapeConfig:getBdsInstanceKafkaBrokerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceListOsPatchesFilter:getBdsInstanceListOsPatchesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceListOsPatchesOsPatch:getBdsInstanceListOsPatchesOsPatch": { "properties": { "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "osPatchVersion": { "type": "string", "description": "Patch version of the os patch.\n" }, "releaseDate": { "type": "string", "description": "The time when the OS patch was released.\n" } }, "type": "object", "required": [ "bdsInstanceId", "osPatchVersion", "releaseDate" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceMasterNode:getBdsInstanceMasterNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceMasterNodeShapeConfig:getBdsInstanceMasterNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceMasterNodeShapeConfig:getBdsInstanceMasterNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceMetastoreConfigsBdsMetastoreConfiguration:getBdsInstanceMetastoreConfigsBdsMetastoreConfiguration": { "properties": { "activateTrigger": { "type": "integer" }, "bdsApiKeyId": { "type": "string", "description": "The ID of the API key that is associated with the external metastore in the metastore configuration\n" }, "bdsApiKeyPassphrase": { "type": "string", "secret": true }, "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "clusterAdminPassword": { "type": "string", "secret": true }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "id": { "type": "string", "description": "The ID of the metastore configuration\n" }, "metastoreId": { "type": "string", "description": "The OCID of the Data Catalog metastore in the metastore configuration\n" }, "metastoreType": { "type": "string", "description": "The type of the metastore in the metastore configuration\n" }, "state": { "type": "string", "description": "The lifecycle state of the metastore in the metastore configuration\n" }, "timeCreated": { "type": "string", "description": "The time when the configuration was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the configuration was updated, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "activateTrigger", "bdsApiKeyId", "bdsApiKeyPassphrase", "bdsInstanceId", "clusterAdminPassword", "displayName", "id", "metastoreId", "metastoreType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceMetastoreConfigsFilter:getBdsInstanceMetastoreConfigsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceNetworkConfig:getBdsInstanceNetworkConfig": { "properties": { "cidrBlock": { "type": "string", "description": "The CIDR IP address block of the VCN.\n" }, "isNatGatewayRequired": { "type": "boolean", "description": "A boolean flag whether to configure a NAT gateway.\n" } }, "type": "object", "required": [ "cidrBlock", "isNatGatewayRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNode:getBdsInstanceNode": { "properties": { "attachedBlockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceNodeAttachedBlockVolume:getBdsInstanceNodeAttachedBlockVolume" }, "description": "The list of block volumes attached to a given node.\n" }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain in which the node is running.\n" }, "displayName": { "type": "string", "description": "The name of the node.\n" }, "faultDomain": { "type": "string", "description": "The name of the fault domain in which the node is running.\n" }, "hostname": { "type": "string", "description": "The fully-qualified hostname (FQDN) of the node.\n" }, "imageId": { "type": "string", "description": "The OCID of the image from which the node was created.\n" }, "instanceId": { "type": "string", "description": "The OCID of the underlying Oracle Cloud Infrastructure Compute instance.\n" }, "ipAddress": { "type": "string", "description": "IP address of the node.\n" }, "isRebootRequired": { "type": "boolean", "description": "Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.\n" }, "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nodeType": { "type": "string", "description": "Cluster node type.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" }, "osVersion": { "type": "string", "description": "BDS-assigned Operating System version for the node.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "sshFingerprint": { "type": "string", "description": "The fingerprint of the SSH key used for node access.\n" }, "state": { "type": "string", "description": "The state of the cluster.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeMaintenanceRebootDue": { "type": "string", "description": "The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.\n" } }, "type": "object", "required": [ "attachedBlockVolumes", "availabilityDomain", "displayName", "faultDomain", "hostname", "imageId", "instanceId", "ipAddress", "isRebootRequired", "localDisksTotalSizeInGbs", "memoryInGbs", "nodeType", "nvmes", "ocpus", "odhVersion", "osVersion", "shape", "sshFingerprint", "state", "subnetId", "timeCreated", "timeMaintenanceRebootDue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeAttachedBlockVolume:getBdsInstanceNodeAttachedBlockVolume": { "properties": { "volumeAttachmentId": { "type": "string", "description": "The OCID of the volume attachment.\n" }, "volumeSizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" } }, "type": "object", "required": [ "volumeAttachmentId", "volumeSizeInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeBackupConfigurationLevelTypeDetail:getBdsInstanceNodeBackupConfigurationLevelTypeDetail": { "properties": { "levelType": { "type": "string", "description": "Type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "nodeHostName": { "type": "string", "description": "Host name of the node to create backup configuration.\n" }, "nodeType": { "type": "string", "description": "Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created.\n" } }, "type": "object", "required": [ "levelType", "nodeHostName", "nodeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeBackupConfigurationsFilter:getBdsInstanceNodeBackupConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceNodeBackupConfigurationsNodeBackupConfiguration:getBdsInstanceNodeBackupConfigurationsNodeBackupConfiguration": { "properties": { "backupType": { "type": "string", "description": "Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.\n" }, "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "id": { "type": "string", "description": "The id of the NodeBackupConfiguration defined under BDS resources, not OCID.\n" }, "levelTypeDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceNodeBackupConfigurationsNodeBackupConfigurationLevelTypeDetail:getBdsInstanceNodeBackupConfigurationsNodeBackupConfigurationLevelTypeDetail" }, "description": "Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "numberOfBackupsToRetain": { "type": "integer", "description": "Number of backup copies to retain.\n" }, "schedule": { "type": "string", "description": "Day/time recurrence (specified following RFC 5545) at which to trigger the backup process. Currently only DAILY, WEEKLY and MONTHLY frequency is supported. Days of the week are specified using BYDAY field. Time of the day is specified using BYHOUR. Other fields are not supported.\n" }, "state": { "type": "string", "description": "The state of the NodeBackupConfiguration configuration.\n" }, "timeCreated": { "type": "string", "description": "The time the NodeBackupConfiguration was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the NodeBackupConfiguration was updated, shown as an RFC 3339 formatted datetime string.\n" }, "timezone": { "type": "string", "description": "The time zone of the execution schedule, in IANA time zone database name format\n" } }, "type": "object", "required": [ "backupType", "bdsInstanceId", "displayName", "id", "levelTypeDetails", "numberOfBackupsToRetain", "schedule", "state", "timeCreated", "timeUpdated", "timezone" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeBackupConfigurationsNodeBackupConfigurationLevelTypeDetail:getBdsInstanceNodeBackupConfigurationsNodeBackupConfigurationLevelTypeDetail": { "properties": { "levelType": { "type": "string", "description": "Type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "nodeHostName": { "type": "string", "description": "Host name of the node to create backup configuration.\n" }, "nodeType": { "type": "string", "description": "Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created.\n" } }, "type": "object", "required": [ "levelType", "nodeHostName", "nodeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeBackupsFilter:getBdsInstanceNodeBackupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceNodeBackupsNodeBackup:getBdsInstanceNodeBackupsNodeBackup": { "properties": { "backupTriggerType": { "type": "string", "description": "type based on how backup action was initiated.\n" }, "backupType": { "type": "string", "description": "Incremental backup type includes only the changes since the last backup. Full backup type includes all changes since the volume was created.\n" }, "displayName": { "type": "string", "description": "The display name belonged to the node backup.\n" }, "id": { "type": "string", "description": "The id of the node backup.\n" }, "nodeBackupConfigId": { "type": "string", "description": "The ID of the nodeBackupConfiguration if the NodeBackup is automatically created by applying the configuration.\n" }, "nodeHostName": { "type": "string", "description": "The node host name belonged to a node that has a node backup.\n" }, "nodeInstanceId": { "type": "string", "description": "The instance OCID of the node, which is the resource from which the node backup was acquired.\n" }, "state": { "type": "string", "description": "The state of the Node's Backup.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "backupTriggerType", "backupType", "displayName", "id", "nodeBackupConfigId", "nodeHostName", "nodeInstanceId", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeReplaceConfigurationLevelTypeDetail:getBdsInstanceNodeReplaceConfigurationLevelTypeDetail": { "properties": { "levelType": { "type": "string", "description": "Type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "nodeHostName": { "type": "string", "description": "Host name of the node to create backup configuration.\n" }, "nodeType": { "type": "string", "description": "Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created.\n" } }, "type": "object", "required": [ "levelType", "nodeHostName", "nodeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeReplaceConfigurationsFilter:getBdsInstanceNodeReplaceConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceNodeReplaceConfigurationsNodeReplaceConfiguration:getBdsInstanceNodeReplaceConfigurationsNodeReplaceConfiguration": { "properties": { "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "clusterAdminPassword": { "type": "string", "secret": true }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "durationInMinutes": { "type": "integer", "description": "This value is the minimum period of time to wait for metric emission before triggering node replacement. The value is in minutes.\n" }, "id": { "type": "string", "description": "The id of the NodeReplaceConfiguration defined under BDS resources, not OCID.\n" }, "levelTypeDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceNodeReplaceConfigurationsNodeReplaceConfigurationLevelTypeDetail:getBdsInstanceNodeReplaceConfigurationsNodeReplaceConfigurationLevelTypeDetail" }, "description": "Details of the type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "metricType": { "type": "string", "description": "Type of compute instance health metric to use for node replacement\n" }, "secretId": { "type": "string", "description": "The secretId for the clusterAdminPassword.\n" }, "state": { "type": "string", "description": "The state of the NodeReplaceConfiguration.\n" }, "timeCreated": { "type": "string", "description": "The time the NodeReplaceConfiguration was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the NodeReplaceConfiguration was updated, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "bdsInstanceId", "clusterAdminPassword", "displayName", "durationInMinutes", "id", "levelTypeDetails", "metricType", "secretId", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceNodeReplaceConfigurationsNodeReplaceConfigurationLevelTypeDetail:getBdsInstanceNodeReplaceConfigurationsNodeReplaceConfigurationLevelTypeDetail": { "properties": { "levelType": { "type": "string", "description": "Type of level used to trigger the creation of a new node backup configuration or node replacement configuration.\n" }, "nodeHostName": { "type": "string", "description": "Host name of the node to create backup configuration.\n" }, "nodeType": { "type": "string", "description": "Type of the node or nodes of the node backup configuration or node replacement configuration which are going to be created.\n" } }, "type": "object", "required": [ "levelType", "nodeHostName", "nodeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancePatchHistoriesFilter:getBdsInstancePatchHistoriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstancePatchHistoriesPatchHistory:getBdsInstancePatchHistoriesPatchHistory": { "properties": { "patchType": { "type": "string", "description": "The type of a BDS patch history entity.\n" }, "state": { "type": "string", "description": "The status of the patch.\n" }, "timeUpdated": { "type": "string", "description": "The time when the patch history was last updated.\n" }, "version": { "type": "string", "description": "The version of the patch.\n" } }, "type": "object", "required": [ "patchType", "state", "timeUpdated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancePatchesFilter:getBdsInstancePatchesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstancePatchesPatch:getBdsInstancePatchesPatch": { "properties": { "timeReleased": { "type": "string", "description": "The time when the patch was released.\n" }, "version": { "type": "string", "description": "The version of the patch.\n" } }, "type": "object", "required": [ "timeReleased", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceResourcePrincipalConfigurationsFilter:getBdsInstanceResourcePrincipalConfigurationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceResourcePrincipalConfigurationsResourcePrincipalConfiguration:getBdsInstanceResourcePrincipalConfigurationsResourcePrincipalConfiguration": { "properties": { "bdsInstanceId": { "type": "string", "description": "The OCID of the cluster.\n" }, "clusterAdminPassword": { "type": "string", "secret": true }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "forceRefreshResourcePrincipalTrigger": { "type": "integer" }, "id": { "type": "string", "description": "The id of the ResourcePrincipalConfiguration defined under BDS resources, not OCID.\n" }, "secretId": { "type": "string", "description": "The secretId for the clusterAdminPassword.\n" }, "sessionTokenLifeSpanDurationInHours": { "type": "integer", "description": "Life span in hours of each resource principal session token.\n" }, "state": { "type": "string", "description": "The state of the ResourcePrincipalConfiguration.\n" }, "timeCreated": { "type": "string", "description": "The time the ResourcePrincipalConfiguration was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeTokenExpiry": { "type": "string", "description": "the time the resource principal session token will expired, shown as an rfc 3339 formatted datetime string.\n" }, "timeTokenRefreshed": { "type": "string", "description": "the time the resource principal session token was refreshed, shown as an rfc 3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the ResourcePrincipalConfiguration was updated, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "bdsInstanceId", "clusterAdminPassword", "displayName", "forceRefreshResourcePrincipalTrigger", "id", "secretId", "sessionTokenLifeSpanDurationInHours", "state", "timeCreated", "timeTokenExpiry", "timeTokenRefreshed", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceSoftwareUpdatesFilter:getBdsInstanceSoftwareUpdatesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:BigDataService/getBdsInstanceSoftwareUpdatesSoftwareUpdateCollection:getBdsInstanceSoftwareUpdatesSoftwareUpdateCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceSoftwareUpdatesSoftwareUpdateCollectionItem:getBdsInstanceSoftwareUpdatesSoftwareUpdateCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceSoftwareUpdatesSoftwareUpdateCollectionItem:getBdsInstanceSoftwareUpdatesSoftwareUpdateCollectionItem": { "properties": { "softwareUpdateKey": { "type": "string", "description": "Unique identifier of a given software update\n" }, "softwareUpdateType": { "type": "string", "description": "type of current software update.\n* Big Data Service's micro service. BDS version will be changed after upgrade.\n" }, "softwareUpdateVersion": { "type": "string", "description": "The version of the software update.\n" }, "state": { "type": "string", "description": "The lifecycle state of the software update.\n" }, "timeDue": { "type": "string", "description": "The due date for the software update. Big Data Service will be updated automatically after this date.\n" }, "timeReleased": { "type": "string", "description": "The time when the software update was released.\n" } }, "type": "object", "required": [ "softwareUpdateKey", "softwareUpdateType", "softwareUpdateVersion", "state", "timeDue", "timeReleased" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceStartClusterShapeConfig:getBdsInstanceStartClusterShapeConfig": { "properties": { "nodeTypeShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig:getBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig" } } }, "type": "object", "required": [ "nodeTypeShapeConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig:getBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig": { "properties": { "nodeType": { "type": "string", "description": "Cluster node type.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" } }, "type": "object", "required": [ "nodeType", "shape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceUtilNode:getBdsInstanceUtilNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceUtilNodeShapeConfig:getBdsInstanceUtilNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceUtilNodeShapeConfig:getBdsInstanceUtilNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceWorkerNode:getBdsInstanceWorkerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstanceWorkerNodeShapeConfig:getBdsInstanceWorkerNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstanceWorkerNodeShapeConfig:getBdsInstanceWorkerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstance:getBdsInstancesBdsInstance": { "properties": { "bdsClusterVersionSummaries": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceBdsClusterVersionSummary:getBdsInstancesBdsInstanceBdsClusterVersionSummary" }, "description": "Cluster version details including bds and odh version information.\n" }, "bootstrapScriptUrl": { "type": "string", "description": "pre-authenticated URL of the bootstrap script in Object Store that can be downloaded and executed.\n" }, "cloudSqlDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceCloudSqlDetail:getBdsInstancesBdsInstanceCloudSqlDetail" }, "description": "The information about added Cloud SQL capability\n" }, "clusterAdminPassword": { "type": "string", "secret": true }, "clusterDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceClusterDetail:getBdsInstancesBdsInstanceClusterDetail" }, "description": "Specific info about a Hadoop cluster\n" }, "clusterProfile": { "type": "string", "description": "Profile of the Big Data Service cluster.\n" }, "clusterPublicKey": { "type": "string" }, "clusterVersion": { "type": "string", "description": "Version of the Hadoop distribution.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "computeOnlyWorkerNodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceComputeOnlyWorkerNode:getBdsInstancesBdsInstanceComputeOnlyWorkerNode" } }, "createdBy": { "type": "string", "description": "The user who created the cluster.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For example, `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "edgeNodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceEdgeNode:getBdsInstancesBdsInstanceEdgeNode" } }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. For example, `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the Big Data Service resource.\n" }, "ignoreExistingNodesShapes": { "type": "array", "items": { "type": "string" } }, "isCloudSqlConfigured": { "type": "boolean", "description": "Boolean flag specifying whether or not Cloud SQL should be configured.\n" }, "isForceRemoveEnabled": { "type": "boolean" }, "isForceStopJobs": { "type": "boolean" }, "isHighAvailability": { "type": "boolean", "description": "Boolean flag specifying whether or not the cluster is highly available (HA)\n" }, "isKafkaConfigured": { "type": "boolean", "description": "Boolean flag specifying whether or not Kafka should be configured.\n" }, "isSecretReused": { "type": "boolean", "description": "Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations.\n" }, "isSecure": { "type": "boolean", "description": "Boolean flag specifying whether or not the cluster should be set up as secure.\n" }, "kafkaBrokerNodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceKafkaBrokerNode:getBdsInstancesBdsInstanceKafkaBrokerNode" } }, "kerberosRealmName": { "type": "string" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Key Management master encryption key.\n" }, "masterNodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceMasterNode:getBdsInstancesBdsInstanceMasterNode" } }, "networkConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceNetworkConfig:getBdsInstancesBdsInstanceNetworkConfig" }, "description": "Additional configuration of the user's network.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceNode:getBdsInstancesBdsInstanceNode" }, "description": "The list of nodes in the cluster.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "numberOfNodesRequiringMaintenanceReboot": { "type": "integer", "description": "Number of nodes that require a maintenance reboot\n" }, "osPatchVersion": { "type": "string" }, "removeNode": { "type": "string" }, "removeNodes": { "type": "array", "items": { "type": "string" } }, "secretId": { "type": "string", "description": "The secretId for the clusterAdminPassword.\n" }, "startClusterShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceStartClusterShapeConfig:getBdsInstancesBdsInstanceStartClusterShapeConfig" } }, "state": { "type": "string", "description": "The state of the cluster.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeEarliestCertificateExpiration": { "type": "string", "description": "The earliest time of certificate expiration date across the certificates of all current nodes under this cluster.\n" }, "timeUpdated": { "type": "string", "description": "The time the cluster was updated, shown as an RFC 3339 formatted datetime string.\n" }, "utilNodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceUtilNode:getBdsInstancesBdsInstanceUtilNode" } }, "workerNodes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceWorkerNode:getBdsInstancesBdsInstanceWorkerNode" } } }, "type": "object", "required": [ "bdsClusterVersionSummaries", "bootstrapScriptUrl", "cloudSqlDetails", "clusterAdminPassword", "clusterDetails", "clusterProfile", "clusterPublicKey", "clusterVersion", "compartmentId", "computeOnlyWorkerNodes", "createdBy", "definedTags", "displayName", "edgeNodes", "freeformTags", "id", "ignoreExistingNodesShapes", "isCloudSqlConfigured", "isForceRemoveEnabled", "isForceStopJobs", "isHighAvailability", "isKafkaConfigured", "isSecretReused", "isSecure", "kafkaBrokerNodes", "kerberosRealmName", "kmsKeyId", "masterNodes", "networkConfigs", "nodes", "numberOfNodes", "numberOfNodesRequiringMaintenanceReboot", "osPatchVersion", "removeNode", "removeNodes", "secretId", "startClusterShapeConfigs", "state", "timeCreated", "timeEarliestCertificateExpiration", "timeUpdated", "utilNodes", "workerNodes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceBdsClusterVersionSummary:getBdsInstancesBdsInstanceBdsClusterVersionSummary": { "properties": { "bdsVersion": { "type": "string", "description": "Big Data Service version installed in the cluster.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" } }, "type": "object", "required": [ "bdsVersion", "odhVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceCloudSqlDetail:getBdsInstancesBdsInstanceCloudSqlDetail": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "ipAddress": { "type": "string", "description": "IP address of the node.\n" }, "isKerberosMappedToDatabaseUsers": { "type": "boolean", "description": "Boolean flag specifying whether or not Kerberos principals are mapped to database users.\n" }, "kerberosDetails": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceCloudSqlDetailKerberosDetail:getBdsInstancesBdsInstanceCloudSqlDetailKerberosDetail" }, "description": "Details about the Kerberos principals.\n" }, "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "ipAddress", "isKerberosMappedToDatabaseUsers", "kerberosDetails", "memoryInGbs", "nvmes", "ocpus", "shape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceCloudSqlDetailKerberosDetail:getBdsInstancesBdsInstanceCloudSqlDetailKerberosDetail": { "properties": { "keytabFile": { "type": "string", "description": "Location of the keytab file\n" }, "principalName": { "type": "string", "description": "Name of the Kerberos principal.\n" } }, "type": "object", "required": [ "keytabFile", "principalName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceClusterDetail:getBdsInstancesBdsInstanceClusterDetail": { "properties": { "ambariUrl": { "type": "string", "description": "The URL of Ambari\n" }, "bdCellVersion": { "type": "string", "description": "Cloud SQL cell version.\n" }, "bdaVersion": { "type": "string", "description": "BDA version installed in the cluster\n" }, "bdmVersion": { "type": "string", "description": "Big Data Manager version installed in the cluster.\n" }, "bdsVersion": { "type": "string", "description": "Big Data Service version installed in the cluster.\n" }, "bigDataManagerUrl": { "type": "string", "description": "The URL of Big Data Manager.\n" }, "clouderaManagerUrl": { "type": "string", "description": "The URL of Cloudera Manager\n" }, "csqlCellVersion": { "type": "string", "description": "Big Data SQL version.\n" }, "dbVersion": { "type": "string", "description": "Cloud SQL query server database version.\n" }, "hueServerUrl": { "type": "string", "description": "The URL of the Hue server.\n" }, "jupyterHubUrl": { "type": "string", "description": "The URL of the Jupyterhub.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" }, "osVersion": { "type": "string", "description": "BDS-assigned Operating System version for the node.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeRefreshed": { "type": "string", "description": "The time the cluster was automatically or manually refreshed, shown as an RFC 3339 formatted datetime string.\n" } }, "type": "object", "required": [ "ambariUrl", "bdCellVersion", "bdaVersion", "bdmVersion", "bdsVersion", "bigDataManagerUrl", "clouderaManagerUrl", "csqlCellVersion", "dbVersion", "hueServerUrl", "jupyterHubUrl", "odhVersion", "osVersion", "timeCreated", "timeRefreshed" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceComputeOnlyWorkerNode:getBdsInstancesBdsInstanceComputeOnlyWorkerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceComputeOnlyWorkerNodeShapeConfig:getBdsInstancesBdsInstanceComputeOnlyWorkerNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceComputeOnlyWorkerNodeShapeConfig:getBdsInstancesBdsInstanceComputeOnlyWorkerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceEdgeNode:getBdsInstancesBdsInstanceEdgeNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceEdgeNodeShapeConfig:getBdsInstancesBdsInstanceEdgeNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceEdgeNodeShapeConfig:getBdsInstancesBdsInstanceEdgeNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceKafkaBrokerNode:getBdsInstancesBdsInstanceKafkaBrokerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfKafkaNodes": { "type": "integer" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceKafkaBrokerNodeShapeConfig:getBdsInstancesBdsInstanceKafkaBrokerNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfKafkaNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceKafkaBrokerNodeShapeConfig:getBdsInstancesBdsInstanceKafkaBrokerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceMasterNode:getBdsInstancesBdsInstanceMasterNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceMasterNodeShapeConfig:getBdsInstancesBdsInstanceMasterNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceMasterNodeShapeConfig:getBdsInstancesBdsInstanceMasterNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceNetworkConfig:getBdsInstancesBdsInstanceNetworkConfig": { "properties": { "cidrBlock": { "type": "string", "description": "The CIDR IP address block of the VCN.\n" }, "isNatGatewayRequired": { "type": "boolean", "description": "A boolean flag whether to configure a NAT gateway.\n" } }, "type": "object", "required": [ "cidrBlock", "isNatGatewayRequired" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceNode:getBdsInstancesBdsInstanceNode": { "properties": { "attachedBlockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceNodeAttachedBlockVolume:getBdsInstancesBdsInstanceNodeAttachedBlockVolume" }, "description": "The list of block volumes attached to a given node.\n" }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain in which the node is running.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "faultDomain": { "type": "string", "description": "The name of the fault domain in which the node is running.\n" }, "hostname": { "type": "string", "description": "The fully-qualified hostname (FQDN) of the node.\n" }, "imageId": { "type": "string", "description": "The OCID of the image from which the node was created.\n" }, "instanceId": { "type": "string", "description": "The OCID of the underlying Oracle Cloud Infrastructure Compute instance.\n" }, "ipAddress": { "type": "string", "description": "IP address of the node.\n" }, "isRebootRequired": { "type": "boolean", "description": "Indicates if the node requires a reboot to either reflect the latest os kernel or take actions for maintenance reboot.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "The aggregate size of all local disks, in gigabytes. If the instance does not have any local disks, this field is null.\n" }, "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nodeType": { "type": "string", "description": "Cluster node type.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" }, "odhVersion": { "type": "string", "description": "Version of the ODH (Oracle Distribution including Apache Hadoop) for the node.\n" }, "osVersion": { "type": "string", "description": "BDS-assigned Operating System version for the node.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "sshFingerprint": { "type": "string", "description": "The fingerprint of the SSH key used for node access.\n" }, "state": { "type": "string", "description": "The state of the cluster.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created, shown as an RFC 3339 formatted datetime string.\n" }, "timeMaintenanceRebootDue": { "type": "string", "description": "The date and time the instance is expected to be stopped / started, in the format defined by RFC3339.\n" } }, "type": "object", "required": [ "attachedBlockVolumes", "availabilityDomain", "displayName", "faultDomain", "hostname", "imageId", "instanceId", "ipAddress", "isRebootRequired", "localDisksTotalSizeInGbs", "memoryInGbs", "nodeType", "nvmes", "ocpus", "odhVersion", "osVersion", "shape", "sshFingerprint", "state", "subnetId", "timeCreated", "timeMaintenanceRebootDue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceNodeAttachedBlockVolume:getBdsInstancesBdsInstanceNodeAttachedBlockVolume": { "properties": { "volumeAttachmentId": { "type": "string", "description": "The OCID of the volume attachment.\n" }, "volumeSizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" } }, "type": "object", "required": [ "volumeAttachmentId", "volumeSizeInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceStartClusterShapeConfig:getBdsInstancesBdsInstanceStartClusterShapeConfig": { "properties": { "nodeTypeShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig:getBdsInstancesBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig" } } }, "type": "object", "required": [ "nodeTypeShapeConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig:getBdsInstancesBdsInstanceStartClusterShapeConfigNodeTypeShapeConfig": { "properties": { "nodeType": { "type": "string", "description": "Cluster node type.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" } }, "type": "object", "required": [ "nodeType", "shape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceUtilNode:getBdsInstancesBdsInstanceUtilNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceUtilNodeShapeConfig:getBdsInstancesBdsInstanceUtilNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceUtilNodeShapeConfig:getBdsInstancesBdsInstanceUtilNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceWorkerNode:getBdsInstancesBdsInstanceWorkerNode": { "properties": { "blockVolumeSizeInGbs": { "type": "string", "description": "The size of block volume in GB that needs to be attached to a given node. All the necessary details needed for attachment are managed by service itself.\n" }, "numberOfNodes": { "type": "integer", "description": "The number of nodes that form the cluster.\n" }, "shape": { "type": "string", "description": "Shape of the node.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:BigDataService/getBdsInstancesBdsInstanceWorkerNodeShapeConfig:getBdsInstancesBdsInstanceWorkerNodeShapeConfig" } }, "subnetId": { "type": "string", "description": "The OCID of the subnet in which the node is to be created.\n" } }, "type": "object", "required": [ "blockVolumeSizeInGbs", "numberOfNodes", "shape", "shapeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesBdsInstanceWorkerNodeShapeConfig:getBdsInstancesBdsInstanceWorkerNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "integer", "description": "The total amount of memory available to the node, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "integer", "description": "The total number of OCPUs available to the node.\n" } }, "type": "object", "required": [ "memoryInGbs", "nvmes", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:BigDataService/getBdsInstancesFilter:getBdsInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Blockchain/BlockchainPlatformComponentDetail:BlockchainPlatformComponentDetail": { "properties": { "osns": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/BlockchainPlatformComponentDetailOsn:BlockchainPlatformComponentDetailOsn" }, "description": "List of OSNs\n" }, "peers": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/BlockchainPlatformComponentDetailPeer:BlockchainPlatformComponentDetailPeer" }, "description": "List of Peers\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "osns", "peers" ] } } }, "oci:Blockchain/BlockchainPlatformComponentDetailOsn:BlockchainPlatformComponentDetailOsn": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "ocpuAllocationParams": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/BlockchainPlatformComponentDetailOsnOcpuAllocationParam:BlockchainPlatformComponentDetailOsnOcpuAllocationParam" }, "description": "OCPU allocation parameter\n" }, "osnKey": { "type": "string", "description": "OSN identifier\n" }, "state": { "type": "string", "description": "The current state of the Platform Instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ad", "ocpuAllocationParams", "osnKey", "state" ] } } }, "oci:Blockchain/BlockchainPlatformComponentDetailOsnOcpuAllocationParam:BlockchainPlatformComponentDetailOsnOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ocpuAllocationNumber" ] } } }, "oci:Blockchain/BlockchainPlatformComponentDetailPeer:BlockchainPlatformComponentDetailPeer": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "alias": { "type": "string", "description": "peer alias\n" }, "host": { "type": "string", "description": "Host name of VM\n" }, "ocpuAllocationParams": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/BlockchainPlatformComponentDetailPeerOcpuAllocationParam:BlockchainPlatformComponentDetailPeerOcpuAllocationParam" }, "description": "OCPU allocation parameter\n" }, "peerKey": { "type": "string", "description": "peer identifier\n" }, "role": { "type": "string", "description": "Peer role\n" }, "state": { "type": "string", "description": "The current state of the Platform Instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ad", "alias", "host", "ocpuAllocationParams", "peerKey", "role", "state" ] } } }, "oci:Blockchain/BlockchainPlatformComponentDetailPeerOcpuAllocationParam:BlockchainPlatformComponentDetailPeerOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ocpuAllocationNumber" ] } } }, "oci:Blockchain/BlockchainPlatformHostOcpuUtilizationInfo:BlockchainPlatformHostOcpuUtilizationInfo": { "properties": { "host": { "type": "string", "description": "Host name of VM\n" }, "ocpuCapacityNumber": { "type": "number", "description": "Number of total OCPU capacity on the host\n" }, "ocpuUtilizationNumber": { "type": "number", "description": "Number of OCPU utilized\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "host", "ocpuCapacityNumber", "ocpuUtilizationNumber" ] } } }, "oci:Blockchain/BlockchainPlatformReplicas:BlockchainPlatformReplicas": { "properties": { "caCount": { "type": "integer", "description": "Number of CA replicas\n" }, "consoleCount": { "type": "integer", "description": "Number of console replicas\n" }, "proxyCount": { "type": "integer", "description": "Number of REST proxy replicas\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "caCount", "consoleCount", "proxyCount" ] } } }, "oci:Blockchain/OsnOcpuAllocationParam:OsnOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "(Updatable) Number of OCPU allocation\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ] }, "oci:Blockchain/PeerOcpuAllocationParam:PeerOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "(Updatable) Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ] }, "oci:Blockchain/getBlockchainPlatformComponentDetail:getBlockchainPlatformComponentDetail": { "properties": { "osns": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformComponentDetailOsn:getBlockchainPlatformComponentDetailOsn" }, "description": "List of OSNs\n" }, "peers": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformComponentDetailPeer:getBlockchainPlatformComponentDetailPeer" }, "description": "List of Peers\n" } }, "type": "object", "required": [ "osns", "peers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformComponentDetailOsn:getBlockchainPlatformComponentDetailOsn": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "ocpuAllocationParams": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformComponentDetailOsnOcpuAllocationParam:getBlockchainPlatformComponentDetailOsnOcpuAllocationParam" }, "description": "OCPU allocation parameter\n" }, "osnKey": { "type": "string", "description": "OSN identifier\n" }, "state": { "type": "string", "description": "The current state of the Platform Instance.\n" } }, "type": "object", "required": [ "ad", "ocpuAllocationParams", "osnKey", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformComponentDetailOsnOcpuAllocationParam:getBlockchainPlatformComponentDetailOsnOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformComponentDetailPeer:getBlockchainPlatformComponentDetailPeer": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "alias": { "type": "string", "description": "peer alias\n" }, "host": { "type": "string", "description": "Host name of VM\n" }, "ocpuAllocationParams": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformComponentDetailPeerOcpuAllocationParam:getBlockchainPlatformComponentDetailPeerOcpuAllocationParam" }, "description": "OCPU allocation parameter\n" }, "peerKey": { "type": "string", "description": "peer identifier\n" }, "role": { "type": "string", "description": "Peer role\n" }, "state": { "type": "string", "description": "The current state of the Platform Instance.\n" } }, "type": "object", "required": [ "ad", "alias", "host", "ocpuAllocationParams", "peerKey", "role", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformComponentDetailPeerOcpuAllocationParam:getBlockchainPlatformComponentDetailPeerOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformHostOcpuUtilizationInfo:getBlockchainPlatformHostOcpuUtilizationInfo": { "properties": { "host": { "type": "string", "description": "Host name of VM\n" }, "ocpuCapacityNumber": { "type": "number", "description": "Number of total OCPU capacity on the host\n" }, "ocpuUtilizationNumber": { "type": "number", "description": "Number of OCPU utilized\n" } }, "type": "object", "required": [ "host", "ocpuCapacityNumber", "ocpuUtilizationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformPatchesBlockchainPlatformPatchCollection:getBlockchainPlatformPatchesBlockchainPlatformPatchCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItem:getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItem" }, "description": "Collection of PatchSummary\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItem:getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItem": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItemItem:getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItemItem" }, "description": "Collection of PatchSummary\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItemItem:getBlockchainPlatformPatchesBlockchainPlatformPatchCollectionItemItem": { "properties": { "id": { "type": "string", "description": "patch id\n" }, "patchInfoUrl": { "type": "string", "description": "A URL for the patch specific documentation\n" }, "serviceVersion": { "type": "string", "description": "patch service version\n" }, "timePatchDue": { "type": "string", "description": "patch due date for customer initiated patching\n" } }, "type": "object", "required": [ "id", "patchInfoUrl", "serviceVersion", "timePatchDue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformPatchesFilter:getBlockchainPlatformPatchesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Blockchain/getBlockchainPlatformReplica:getBlockchainPlatformReplica": { "properties": { "caCount": { "type": "integer", "description": "Number of CA replicas\n" }, "consoleCount": { "type": "integer", "description": "Number of console replicas\n" }, "proxyCount": { "type": "integer", "description": "Number of REST proxy replicas\n" } }, "type": "object", "required": [ "caCount", "consoleCount", "proxyCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollection:getBlockchainPlatformsBlockchainPlatformCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItem:getBlockchainPlatformsBlockchainPlatformCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItem:getBlockchainPlatformsBlockchainPlatformCollectionItem": { "properties": { "caCertArchiveText": { "type": "string" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "componentDetails": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetail:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetail" }, "description": "Blockchain Platform component details.\n" }, "computeShape": { "type": "string", "description": "Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM or DIGITAL_ASSETS_MEDIUM or DIGITAL_ASSETS_LARGE or DIGITAL_ASSETS_EXTRA_LARGE\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Platform Instance Description\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "federatedUserId": { "type": "string" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "hostOcpuUtilizationInfos": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemHostOcpuUtilizationInfo:getBlockchainPlatformsBlockchainPlatformCollectionItemHostOcpuUtilizationInfo" }, "description": "List of OcpuUtilization for all hosts\n" }, "id": { "type": "string", "description": "unique identifier that is immutable on creation\n" }, "idcsAccessToken": { "type": "string", "secret": true }, "isByol": { "type": "boolean", "description": "Bring your own license\n" }, "isMultiAd": { "type": "boolean", "description": "True for multi-AD blockchain plaforms, false for single-AD\n" }, "lifecycleDetails": { "type": "string", "description": "An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "loadBalancerShape": { "type": "string", "description": "Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.\n" }, "platformRole": { "type": "string", "description": "Role of platform - FOUNDER or PARTICIPANT\n" }, "platformShapeType": { "type": "string", "description": "Type of Platform shape - DEFAULT or CUSTOM\n" }, "platformVersion": { "type": "string", "description": "Platform Version\n" }, "replicas": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemReplica:getBlockchainPlatformsBlockchainPlatformCollectionItemReplica" }, "description": "Number of replicas of service components like Rest Proxy, CA and Console\n" }, "serviceEndpoint": { "type": "string", "description": "Service endpoint URL, valid post-provisioning\n" }, "serviceVersion": { "type": "string", "description": "The version of the Platform Instance.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "storageSizeInTbs": { "type": "number", "description": "Storage size in TBs\n" }, "storageUsedInTbs": { "type": "number", "description": "Storage used in TBs\n" }, "timeCreated": { "type": "string", "description": "The time the the Platform Instance was created. An RFC3339 formatted datetime string\n" }, "timeUpdated": { "type": "string", "description": "The time the Platform Instance was updated. An RFC3339 formatted datetime string\n" }, "totalOcpuCapacity": { "type": "integer", "description": "Number of total OCPUs allocated to the platform cluster\n" } }, "type": "object", "required": [ "caCertArchiveText", "compartmentId", "componentDetails", "computeShape", "definedTags", "description", "displayName", "federatedUserId", "freeformTags", "hostOcpuUtilizationInfos", "id", "idcsAccessToken", "isByol", "isMultiAd", "lifecycleDetails", "loadBalancerShape", "platformRole", "platformShapeType", "platformVersion", "replicas", "serviceEndpoint", "serviceVersion", "state", "storageSizeInTbs", "storageUsedInTbs", "timeCreated", "timeUpdated", "totalOcpuCapacity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetail:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetail": { "properties": { "osns": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsn:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsn" }, "description": "List of OSNs\n" }, "peers": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeer:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeer" }, "description": "List of Peers\n" } }, "type": "object", "required": [ "osns", "peers" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsn:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsn": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "ocpuAllocationParams": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsnOcpuAllocationParam:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsnOcpuAllocationParam" }, "description": "OCPU allocation parameter\n" }, "osnKey": { "type": "string", "description": "OSN identifier\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } }, "type": "object", "required": [ "ad", "ocpuAllocationParams", "osnKey", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsnOcpuAllocationParam:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailOsnOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeer:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeer": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "alias": { "type": "string", "description": "peer alias\n" }, "host": { "type": "string", "description": "Host name of VM\n" }, "ocpuAllocationParams": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeerOcpuAllocationParam:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeerOcpuAllocationParam" }, "description": "OCPU allocation parameter\n" }, "peerKey": { "type": "string", "description": "peer identifier\n" }, "role": { "type": "string", "description": "Peer role\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } }, "type": "object", "required": [ "ad", "alias", "host", "ocpuAllocationParams", "peerKey", "role", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeerOcpuAllocationParam:getBlockchainPlatformsBlockchainPlatformCollectionItemComponentDetailPeerOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemHostOcpuUtilizationInfo:getBlockchainPlatformsBlockchainPlatformCollectionItemHostOcpuUtilizationInfo": { "properties": { "host": { "type": "string", "description": "Host name of VM\n" }, "ocpuCapacityNumber": { "type": "number", "description": "Number of total OCPU capacity on the host\n" }, "ocpuUtilizationNumber": { "type": "number", "description": "Number of OCPU utilized\n" } }, "type": "object", "required": [ "host", "ocpuCapacityNumber", "ocpuUtilizationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsBlockchainPlatformCollectionItemReplica:getBlockchainPlatformsBlockchainPlatformCollectionItemReplica": { "properties": { "caCount": { "type": "integer", "description": "Number of CA replicas\n" }, "consoleCount": { "type": "integer", "description": "Number of console replicas\n" }, "proxyCount": { "type": "integer", "description": "Number of REST proxy replicas\n" } }, "type": "object", "required": [ "caCount", "consoleCount", "proxyCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getBlockchainPlatformsFilter:getBlockchainPlatformsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Blockchain/getOsnOcpuAllocationParam:getOsnOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getOsnsFilter:getOsnsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Blockchain/getOsnsOsnCollection:getOsnsOsnCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getOsnsOsnCollectionItem:getOsnsOsnCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getOsnsOsnCollectionItem:getOsnsOsnCollectionItem": { "properties": { "ad": { "type": "string", "description": "Availability Domain of OSN\n" }, "blockchainPlatformId": { "type": "string", "description": "Unique service identifier.\n" }, "ocpuAllocationParam": { "$ref": "#/types/oci:Blockchain/getOsnsOsnCollectionItemOcpuAllocationParam:getOsnsOsnCollectionItemOcpuAllocationParam", "description": "OCPU allocation parameter\n" }, "osnKey": { "type": "string", "description": "OSN identifier\n" }, "state": { "type": "string", "description": "The current state of the OSN.\n" } }, "type": "object", "required": [ "ad", "blockchainPlatformId", "ocpuAllocationParam", "osnKey", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getOsnsOsnCollectionItemOcpuAllocationParam:getOsnsOsnCollectionItemOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getPeerOcpuAllocationParam:getPeerOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getPeersFilter:getPeersFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Blockchain/getPeersPeerCollection:getPeersPeerCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Blockchain/getPeersPeerCollectionItem:getPeersPeerCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getPeersPeerCollectionItem:getPeersPeerCollectionItem": { "properties": { "ad": { "type": "string", "description": "Availability Domain of peer\n" }, "alias": { "type": "string", "description": "peer alias\n" }, "blockchainPlatformId": { "type": "string", "description": "Unique service identifier.\n" }, "host": { "type": "string", "description": "Host on which the Peer exists\n" }, "ocpuAllocationParam": { "$ref": "#/types/oci:Blockchain/getPeersPeerCollectionItemOcpuAllocationParam:getPeersPeerCollectionItemOcpuAllocationParam", "description": "OCPU allocation parameter\n" }, "peerKey": { "type": "string", "description": "peer identifier\n" }, "role": { "type": "string", "description": "Peer role\n" }, "state": { "type": "string", "description": "The current state of the peer.\n" } }, "type": "object", "required": [ "ad", "alias", "blockchainPlatformId", "host", "ocpuAllocationParam", "peerKey", "role", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Blockchain/getPeersPeerCollectionItemOcpuAllocationParam:getPeersPeerCollectionItemOcpuAllocationParam": { "properties": { "ocpuAllocationNumber": { "type": "number", "description": "Number of OCPU allocation\n" } }, "type": "object", "required": [ "ocpuAllocationNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/CostAnomalyMonitorCostAlertSubscriptionMap:CostAnomalyMonitorCostAlertSubscriptionMap": { "properties": { "costAlertSubscriptionId": { "type": "string", "description": "(Updatable) The costAlertSubscription ocid which the cost monitor alert maps to.\n" }, "operator": { "type": "string", "description": "(Updatable) The filter operator. Example: 'AND', 'OR'.\n" }, "thresholdAbsoluteValue": { "type": "integer", "description": "(Updatable) The absolute threshold value.\n" }, "thresholdRelativePercent": { "type": "integer", "description": "(Updatable) The relative percentage threshold value.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "costAlertSubscriptionId", "operator", "thresholdAbsoluteValue", "thresholdRelativePercent" ] } } }, "oci:Budget/getAlertRulesAlertRule:getAlertRulesAlertRule": { "properties": { "budgetId": { "type": "string", "description": "The unique budget OCID.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "The description of the alert rule.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the alert rule.\n" }, "message": { "type": "string", "description": "The custom message that will be sent when the alert is triggered.\n" }, "recipients": { "type": "string", "description": "The delimited list of email addresses to receive the alert when it triggers. Delimiter characters can be a comma, space, TAB, or semicolon.\n" }, "state": { "type": "string", "description": "The current state of the resource to filter by.\n" }, "threshold": { "type": "number", "description": "The threshold for triggering the alert. If the thresholdType is PERCENTAGE, the maximum value is 10000.\n" }, "thresholdType": { "type": "string", "description": "The type of threshold.\n" }, "timeCreated": { "type": "string", "description": "The time when the budget was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the budget was updated.\n" }, "type": { "type": "string", "description": "The type of the alert. Valid values are ACTUAL (the alert triggers based on actual usage), or FORECAST (the alert triggers based on predicted usage).\n" }, "version": { "type": "integer", "description": "The version of the alert rule. Starts from 1 and increments by 1.\n" } }, "type": "object", "required": [ "budgetId", "definedTags", "description", "displayName", "freeformTags", "id", "message", "recipients", "state", "threshold", "thresholdType", "timeCreated", "timeUpdated", "type", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getAlertRulesFilter:getAlertRulesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Budget/getBudgetsBudget:getBudgetsBudget": { "properties": { "actualSpend": { "type": "number", "description": "The actual spend in currency for the current budget cycle.\n" }, "alertRuleCount": { "type": "integer", "description": "The total number of alert rules in the budget.\n" }, "amount": { "type": "integer", "description": "The amount of the budget, expressed in the currency of the customer's rate card.\n" }, "budgetProcessingPeriodStartOffset": { "type": "integer", "description": "The number of days offset from the first day of the month, at which the budget processing period starts. In months that have fewer days than this value, processing will begin on the last day of that month. For example, for a value of 12, processing starts every month on the 12th at midnight.\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "The description of the budget.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. This does not have to be unique, and it's changeable. Example: `My new resource`\n" }, "endDate": { "type": "string", "description": "The time when the one-time budget concludes. For example, - `2023-08-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.\n" }, "forecastedSpend": { "type": "number", "description": "The forecasted spend in currency by the end of the current budget cycle.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the budget.\n" }, "processingPeriodType": { "type": "string", "description": "The type of the budget processing period. Valid values are INVOICE, MONTH, and SINGLE_USE.\n" }, "resetPeriod": { "type": "string", "description": "The reset period for the budget.\n" }, "startDate": { "type": "string", "description": "The date when the one-time budget begins. For example, `2023-07-12T16:01:19.847222+05:30`. The date-time format conforms to RFC 3339, and will be truncated to the starting point of the date provided after being converted to UTC time.\n" }, "state": { "type": "string", "description": "The current state of the resource to filter by.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetCompartmentId": { "type": "string", "description": "This is DEPRECATED. For backwards compatability, the property is populated when the targetType is \"COMPARTMENT\", and targets contain the specific target compartment OCID. For all other scenarios, this property will be left empty.\n", "deprecationMessage": "The 'target_compartment_id' field has been deprecated. Please use 'targets' instead." }, "targetType": { "type": "string", "description": "The type of target to filter by:\n* ALL - List all budgets\n* COMPARTMENT - List all budgets with targetType == \"COMPARTMENT\"\n* TAG - List all budgets with targetType == \"TAG\"\n" }, "targets": { "type": "array", "items": { "type": "string" }, "description": "The list of targets on which the budget is applied. If the targetType is \"COMPARTMENT\", the targets contain the list of compartment OCIDs. If the targetType is \"TAG\", the targets contain the list of cost tracking tag identifiers in the form of \"{tagNamespace}.{tagKey}.{tagValue}\".\n" }, "timeCreated": { "type": "string", "description": "The time that the budget was created.\n" }, "timeSpendComputed": { "type": "string", "description": "The time that the budget spend was last computed.\n" }, "timeUpdated": { "type": "string", "description": "The time that the budget was updated.\n" }, "version": { "type": "integer", "description": "The version of the budget. Starts from 1 and increments by 1.\n" } }, "type": "object", "required": [ "actualSpend", "alertRuleCount", "amount", "budgetProcessingPeriodStartOffset", "compartmentId", "definedTags", "description", "displayName", "endDate", "forecastedSpend", "freeformTags", "id", "processingPeriodType", "resetPeriod", "startDate", "state", "systemTags", "targetCompartmentId", "targetType", "targets", "timeCreated", "timeSpendComputed", "timeUpdated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getBudgetsFilter:getBudgetsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Budget/getCostAlertSubscriptionsCostAlertSubscriptionCollection:getCostAlertSubscriptionsCostAlertSubscriptionCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Budget/getCostAlertSubscriptionsCostAlertSubscriptionCollectionItem:getCostAlertSubscriptionsCostAlertSubscriptionCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAlertSubscriptionsCostAlertSubscriptionCollectionItem:getCostAlertSubscriptionsCostAlertSubscriptionCollectionItem": { "properties": { "channels": { "type": "string", "description": "The notification channels string.\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "costAnomalyMonitors": { "type": "string", "description": "List of monitor identifiers\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "The description of the cost alert subscription.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the Cost Alert Subscription.\n" }, "name": { "type": "string", "description": "Unique, non-changeable resource name.\n" }, "state": { "type": "string", "description": "The current state of the cost alert subscription.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time that the cost alert subscription was created.\n" }, "timeUpdated": { "type": "string", "description": "The time that the cost alert subscription was updated.\n" } }, "type": "object", "required": [ "channels", "compartmentId", "costAnomalyMonitors", "definedTags", "description", "freeformTags", "id", "name", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAlertSubscriptionsFilter:getCostAlertSubscriptionsFilter": { "properties": { "name": { "type": "string", "description": "Unique, non-changeable resource name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Budget/getCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollection:getCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Budget/getCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem:getCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem" }, "description": "The list of CostAnomalyEvent Analytic summary.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem:getCostAnomalyEventAnalyticsCostAnomalyEventAnalyticCollectionItem": { "properties": { "averageCostImpact": { "type": "number", "description": "The average cost impact of the anomaly events in the given time period.\n" }, "averageCostVariance": { "type": "number", "description": "The average cost variance of the anomaly events in the given time period.\n" }, "costAnomalyEventAnalyticCount": { "type": "integer", "description": "The number of cost anomaly events in the given time period.\n" } }, "type": "object", "required": [ "averageCostImpact", "averageCostVariance", "costAnomalyEventAnalyticCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyEventAnalyticsFilter:getCostAnomalyEventAnalyticsFilter": { "properties": { "name": { "type": "string", "description": "Unique, non-changeable resource name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Budget/getCostAnomalyEventsCostAnomalyEventCollection:getCostAnomalyEventsCostAnomalyEventCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Budget/getCostAnomalyEventsCostAnomalyEventCollectionItem:getCostAnomalyEventsCostAnomalyEventCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyEventsCostAnomalyEventCollectionItem:getCostAnomalyEventsCostAnomalyEventCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "costAnomalyEventId": { "type": "string" }, "costAnomalyName": { "type": "string", "description": "The name of the associated cost monitor.\n" }, "costImpact": { "type": "number", "description": "cost impact (absolute) of the anomaly event.\n" }, "costMonitorId": { "type": "string", "description": "The OCID of the associated cost monitor.\n" }, "costMonitorName": { "type": "string", "description": "The name of the associated cost monitor.\n" }, "costMonitorType": { "type": "string", "description": "Type of cost monitor\n" }, "costVariancePercentage": { "type": "number", "description": "The cost variance percentage of the detected anomaly.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "feedbackResponse": { "type": "string", "description": "The feedback response for the cost anomaly event.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the Cost Anomaly Event.\n" }, "rootCauseDetail": { "type": "string", "description": "The root cause details of the cost anomaly event.\n" }, "state": { "type": "string", "description": "The current state of the cost anomaly event.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetResourceFilter": { "type": "string", "description": "The filter object to target resources for cost monitor. Cost generated by one or more resources identified by this filter is monitored for anomalous deviations.\n" }, "timeAnomalyEventDate": { "type": "string", "description": "The event date of the anomaly event.\n" }, "timeCreated": { "type": "string", "description": "The created time of the cost anomaly event.\n" }, "timeUpdated": { "type": "string", "description": "The updated time of the cost anomaly event.\n" } }, "type": "object", "required": [ "compartmentId", "costAnomalyEventId", "costAnomalyName", "costImpact", "costMonitorId", "costMonitorName", "costMonitorType", "costVariancePercentage", "definedTags", "feedbackResponse", "freeformTags", "id", "rootCauseDetail", "state", "systemTags", "targetResourceFilter", "timeAnomalyEventDate", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyEventsFilter:getCostAnomalyEventsFilter": { "properties": { "name": { "type": "string", "description": "Unique, non-changeable resource name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Budget/getCostAnomalyMonitorCostAlertSubscriptionMap:getCostAnomalyMonitorCostAlertSubscriptionMap": { "properties": { "costAlertSubscriptionId": { "type": "string", "description": "The costAlertSubscription ocid which the cost monitor alert maps to.\n" }, "operator": { "type": "string", "description": "The filter operator. Example: 'AND', 'OR'.\n" }, "thresholdAbsoluteValue": { "type": "integer", "description": "The absolute threshold value.\n" }, "thresholdRelativePercent": { "type": "integer", "description": "The relative percentage threshold value.\n" } }, "type": "object", "required": [ "costAlertSubscriptionId", "operator", "thresholdAbsoluteValue", "thresholdRelativePercent" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyMonitorsCostAnomalyMonitorCollection:getCostAnomalyMonitorsCostAnomalyMonitorCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Budget/getCostAnomalyMonitorsCostAnomalyMonitorCollectionItem:getCostAnomalyMonitorsCostAnomalyMonitorCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyMonitorsCostAnomalyMonitorCollectionItem:getCostAnomalyMonitorsCostAnomalyMonitorCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "costAlertSubscriptionMaps": { "type": "array", "items": { "$ref": "#/types/oci:Budget/getCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap:getCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap" }, "description": "The mapping of cost monitor to alert subscription along with thresholds.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "The description of the budget.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the Cost Anomaly Monitor.\n" }, "lifecycleDetails": { "type": "string", "description": "The current state details of the cost monitor.\n" }, "name": { "type": "string", "description": "Unique, non-changeable resource name.\n" }, "state": { "type": "string", "description": "The current state of the cost monitor.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetResourceFilter": { "type": "string", "description": "The filter object to target resources for cost monitor. Cost generated by one or more resources identified by this filter is monitored for anomalous deviations.\n" }, "timeCreated": { "type": "string", "description": "The time that the cost monitor was created.\n" }, "timeUpdated": { "type": "string", "description": "The time that the cost monitor was last updated.\n" }, "type": { "type": "string", "description": "Type of cost monitor\n" } }, "type": "object", "required": [ "compartmentId", "costAlertSubscriptionMaps", "definedTags", "description", "freeformTags", "id", "lifecycleDetails", "name", "state", "systemTags", "targetResourceFilter", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap:getCostAnomalyMonitorsCostAnomalyMonitorCollectionItemCostAlertSubscriptionMap": { "properties": { "costAlertSubscriptionId": { "type": "string", "description": "The costAlertSubscription ocid which the cost monitor alert maps to.\n" }, "operator": { "type": "string", "description": "The filter operator. Example: 'AND', 'OR'.\n" }, "thresholdAbsoluteValue": { "type": "integer", "description": "The absolute threshold value.\n" }, "thresholdRelativePercent": { "type": "integer", "description": "The relative percentage threshold value.\n" } }, "type": "object", "required": [ "costAlertSubscriptionId", "operator", "thresholdAbsoluteValue", "thresholdRelativePercent" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Budget/getCostAnomalyMonitorsFilter:getCostAnomalyMonitorsFilter": { "properties": { "name": { "type": "string", "description": "Unique, non-changeable resource name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/OccAvailabilityCatalogDetail:OccAvailabilityCatalogDetail": { "properties": { "availableQuantity": { "type": "string", "description": "The quantity of resource currently available that the customer can request.\n" }, "catalogId": { "type": "string", "description": "The OCID of the availability catalog.\n" }, "dateExpectedCapacityHandover": { "type": "string", "description": "The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.\n" }, "dateFinalCustomerOrder": { "type": "string", "description": "The date by which the customer must place the order to have their capacity requirements met by the customer handover date.\n" }, "demandedQuantity": { "type": "string", "description": "The quantity of resource currently demanded by the customer.\n" }, "namespace": { "type": "string", "description": "The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.\n" }, "resourceName": { "type": "string", "description": "The name of the resource that the customer can request.\n" }, "resourceType": { "type": "string", "description": "The different types of resources against which customers can place capacity requests.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "totalAvailableQuantity": { "type": "string", "description": "The total quantity of resource that the customer can request.\n" }, "unit": { "type": "string", "description": "The unit in which the resource available is measured.\n" }, "workloadType": { "type": "string", "description": "The type of workload (Generic/ROW).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availableQuantity", "catalogId", "dateExpectedCapacityHandover", "dateFinalCustomerOrder", "demandedQuantity", "namespace", "resourceName", "resourceType", "systemTags", "totalAvailableQuantity", "unit", "workloadType" ] } } }, "oci:CapacityManagement/OccAvailabilityCatalogMetadataDetails:OccAvailabilityCatalogMetadataDetails": { "properties": { "formatVersion": { "type": "string", "description": "The version for the format of the catalog file being uploaded.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "formatVersion" ] }, "oci:CapacityManagement/OccCapacityRequestDetail:OccCapacityRequestDetail": { "properties": { "actualHandoverQuantity": { "type": "string", "description": "The actual handed over quantity of resources at the time of request resolution.\n", "willReplaceOnChanges": true }, "associatedOccHandoverResourceBlockLists": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList:OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList" }, "description": "A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name.\n", "willReplaceOnChanges": true }, "availabilityDomain": { "type": "string", "description": "The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests.\n", "willReplaceOnChanges": true }, "dateActualHandover": { "type": "string", "description": "The date on which the actual handover quantity of resources is delivered.\n", "willReplaceOnChanges": true }, "dateExpectedHandover": { "type": "string", "description": "The date on which the latest increment to supplied quantity of resources was delivered.\n", "willReplaceOnChanges": true }, "demandQuantity": { "type": "string", "description": "The number of compute server's with name \u003cresourceName\u003e required by the user.\n", "willReplaceOnChanges": true }, "expectedHandoverQuantity": { "type": "string", "description": "The incremental quantity of resources supplied as the provisioning is underway.\n", "willReplaceOnChanges": true }, "resourceName": { "type": "string", "description": "The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name.\n", "willReplaceOnChanges": true }, "resourceType": { "type": "string", "description": "The type of the resource against which the user wants to place a capacity request.\n", "willReplaceOnChanges": true }, "sourceWorkloadType": { "type": "string", "description": "The WorkloadType from where capacity request are to be transferred.\n", "willReplaceOnChanges": true }, "workloadType": { "type": "string", "description": "The type of the workload (Generic/ROW).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "demandQuantity", "resourceName", "resourceType", "workloadType" ], "language": { "nodejs": { "requiredOutputs": [ "actualHandoverQuantity", "associatedOccHandoverResourceBlockLists", "availabilityDomain", "dateActualHandover", "dateExpectedHandover", "demandQuantity", "expectedHandoverQuantity", "resourceName", "resourceType", "sourceWorkloadType", "workloadType" ] } } }, "oci:CapacityManagement/OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList:OccCapacityRequestDetailAssociatedOccHandoverResourceBlockList": { "properties": { "handoverQuantity": { "type": "string", "description": "The total quantity of the resource that was made available to the customer as part of this resource block\n", "willReplaceOnChanges": true }, "occHandoverResourceBlockId": { "type": "string", "description": "The OCID of the handed over resource block.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "handoverQuantity", "occHandoverResourceBlockId" ] } } }, "oci:CapacityManagement/OccCapacityRequestPatchOperation:OccCapacityRequestPatchOperation": { "properties": { "from": { "type": "string", "description": "(Updatable)\n" }, "operation": { "type": "string", "description": "(Updatable) The operation can be one of these values: `INSERT`, `INSERT_MULTIPLE`, `MERGE`, `MOVE`, `PROHIBIT`, `REMOVE`, `REPLACE`, `REQUIRE`\n" }, "position": { "type": "string", "description": "(Updatable)\n" }, "selectedItem": { "type": "string", "description": "(Updatable)\n" }, "selection": { "type": "string", "description": "(Updatable)\n" }, "value": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable)\n" } }, "type": "object", "required": [ "from", "operation", "selection", "value" ] }, "oci:CapacityManagement/OccCustomerGroupCustomersList:OccCustomerGroupCustomersList": { "properties": { "description": { "type": "string", "description": "The description about the customer group.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "The display name for the customer.\n", "willReplaceOnChanges": true }, "occCustomerGroupId": { "type": "string", "description": "The OCID of the customer group.\n" }, "status": { "type": "string", "description": "To determine whether the customer is enabled/disabled.\n", "willReplaceOnChanges": true }, "tenancyId": { "type": "string", "description": "The OCID of the tenancy belonging to the customer.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "displayName", "tenancyId" ], "language": { "nodejs": { "requiredOutputs": [ "description", "displayName", "occCustomerGroupId", "status", "tenancyId" ] } } }, "oci:CapacityManagement/getInternalNamespaceOccOverviewsFilter:getInternalNamespaceOccOverviewsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalNamespaceOccOverviewsOccOverviewCollection:getInternalNamespaceOccOverviewsOccOverviewCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalNamespaceOccOverviewsOccOverviewCollectionItem:getInternalNamespaceOccOverviewsOccOverviewCollectionItem" }, "description": "An array of overview summary.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalNamespaceOccOverviewsOccOverviewCollectionItem:getInternalNamespaceOccOverviewsOccOverviewCollectionItem": { "properties": { "capacityRequestsBlob": { "type": "string", "description": "A raw json blob containing all the capacity requests corresponding to the resource name\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "periodValue": { "type": "string", "description": "The name of the month along with year for which this summary corresponds to.\n" }, "resourceName": { "type": "string", "description": "The name of the resource for which we have aggregated the value.\n" }, "totalAvailable": { "type": "string", "description": "The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.\n" }, "totalCancelled": { "type": "string", "description": "The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.\n" }, "totalDemanded": { "type": "string", "description": "The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.\n" }, "totalRejected": { "type": "string", "description": "The quantity of the resource which is rejected by Oracle.\n" }, "totalSupplied": { "type": "string", "description": "The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.\n" }, "totalUnfulfilled": { "type": "string", "description": "The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.\n" }, "unit": { "type": "string", "description": "The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.\n" }, "workloadTypeBreakdownBlob": { "type": "string", "description": "A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types\n" } }, "type": "object", "required": [ "capacityRequestsBlob", "compartmentId", "periodValue", "resourceName", "totalAvailable", "totalCancelled", "totalDemanded", "totalRejected", "totalSupplied", "totalUnfulfilled", "unit", "workloadTypeBreakdownBlob" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccAvailabilityCatalogsFilter:getInternalOccAvailabilityCatalogsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollection:getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem:getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem" }, "description": "An array of availability catalogs.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem:getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem": { "properties": { "catalogState": { "type": "string", "description": "Filter the list of availability catalogs based on the catalog state.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Text information about the availability catalog.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the availability catalog to filter the list of availability catalogs.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.\n" }, "metadataDetails": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail:getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail" }, "description": "Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.\n" }, "namespace": { "type": "string", "description": "The namespace by which we would filter the list.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the customer group.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the availability catalog was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the availability catalog was last updated.\n" } }, "type": "object", "required": [ "catalogState", "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "metadataDetails", "namespace", "occCustomerGroupId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail:getInternalOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail": { "properties": { "formatVersion": { "type": "string", "description": "The version for the format of the catalog file being uploaded.\n" } }, "type": "object", "required": [ "formatVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccHandoverResourceBlockDetailsFilter:getInternalOccHandoverResourceBlockDetailsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollection:getInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem:getInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem" }, "description": "An array of details about an occ handover resource block.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem:getInternalOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem": { "properties": { "details": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that contains additional details for a given handover resource. For example for compute namespace this includes host ocid, host serial etc.\n" }, "occResourceHandoverBlockId": { "type": "string", "description": "The OCID of the occResourceHandoverBlock.\n" } }, "type": "object", "required": [ "details", "occResourceHandoverBlockId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccHandoverResourceBlocksFilter:getInternalOccHandoverResourceBlocksFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollection:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem" }, "description": "An array of occ handover resource blocks.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem": { "properties": { "associatedCapacityRequests": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest" }, "description": "A list containing details about the capacity requests against which the resources were provisioned by oracle.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "handoverDate": { "type": "string", "description": "The date on which the resource was handed over to the customer.\n" }, "handoverResourceName": { "type": "string", "description": "A filter to return only the list of resources that match the name provided in this filter.\n" }, "id": { "type": "string", "description": "The OCID of the resource block.\n" }, "namespace": { "type": "string", "description": "The namespace enum value that needs to be passed as a required query parameter.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "placementDetails": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail" }, "description": "Details like building, room and block where the resource was placed after provisioning in the datacenter.\n" }, "totalHandoverQuantity": { "type": "string", "description": "The total quantity of the resource that was made available to the customer by Oracle.\n" } }, "type": "object", "required": [ "associatedCapacityRequests", "compartmentId", "handoverDate", "handoverResourceName", "id", "namespace", "occCustomerGroupId", "placementDetails", "totalHandoverQuantity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest": { "properties": { "handoverQuantity": { "type": "string", "description": "The total quantity of the bare metal hardware that was made available corresponding to the capacity request ocid.\n" }, "occCapacityRequestId": { "type": "string", "description": "The OCID of the capacity request against which the resources were provisioned.\n" } }, "type": "object", "required": [ "handoverQuantity", "occCapacityRequestId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail:getInternalOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain (AD) for which the resources were provisioned.\n" }, "block": { "type": "string", "description": "The block in the datacenter room where the resource was placed.\n" }, "building": { "type": "string", "description": "The datacenter building where the resource was placed.\n" }, "region": { "type": "string", "description": "The name of the region for which the resources were provisioned.\n" }, "room": { "type": "string", "description": "The name of the room in the dataacenter building where the resource was placed.\n" }, "workloadType": { "type": "string", "description": "The type of workload to which these resources were provisioned.\n" } }, "type": "object", "required": [ "availabilityDomain", "block", "building", "region", "room", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesFilter:getInternalOccmDemandSignalCatalogResourcesFilter": { "properties": { "name": { "type": "string", "description": "A query parameter to filter the list of demand signal catalog resource based on the resource name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollection:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItem:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItem" }, "description": "An array of items containing detailed information about a resource's property dependecies.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItem:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the demand signal catalog resource.\n" }, "name": { "type": "string", "description": "A query parameter to filter the list of demand signal catalog resource based on the resource name.\n" }, "namespace": { "type": "string", "description": "The name of the Oracle Cloud Infrastructure service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "occmDemandSignalCatalogId": { "type": "string", "description": "The ocid of demand signal catalog id.\n" }, "region": { "type": "string", "description": "The name of region for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter.\n" }, "resourceProperties": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourceProperty:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourceProperty" }, "description": "A list containing detailed information about a resource's properties.\n" }, "resourcePropertyConstraints": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint" }, "description": "A list containing detailed information about a resource's property constraints.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the demand signal catalog resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetCompartmentId": { "type": "string", "description": "The OCID of the customer tenancy for which this resource will be available for the customer to order against.\n" }, "timeCreated": { "type": "string", "description": "The time when the demand signal catalog resource was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the demand signal catalog resource was last updated.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "freeformTags", "id", "name", "namespace", "occCustomerGroupId", "occmDemandSignalCatalogId", "region", "resourceProperties", "resourcePropertyConstraints", "state", "systemTags", "targetCompartmentId", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourceProperty:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourceProperty": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem" }, "description": "An array of items containing detailed information about a resource's property dependecies.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem" }, "description": "An array of items containing detailed information about a resource's property dependecies.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem": { "properties": { "constraintName": { "type": "string", "description": "The name of demand signal resource's property constraint.\n" }, "constraintValue": { "type": "string", "description": "The value of demand signal resource's property constraint.\n" } }, "type": "object", "required": [ "constraintName", "constraintValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem": { "properties": { "isEditable": { "type": "boolean", "description": "This will indicate if demand signal resource's property is editable.\n" }, "propertyMaxValue": { "type": "string", "description": "The maximum value of demand signal resource's property. This is an optional parameter.\n" }, "propertyMinValue": { "type": "string", "description": "The minimum value of demand signal resource's property. This is an optional parameter.\n" }, "propertyName": { "type": "string", "description": "The name of demand signal resource's property.\n" }, "propertyOptions": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption" }, "description": "Predefined options for demand signal resource's property. This is an optional parameter.\n" }, "propertyUnit": { "type": "string", "description": "Unit for demand signal resource's property.\n" }, "propertyValue": { "type": "string", "description": "Default value of demand signal resource's property.\n" } }, "type": "object", "required": [ "isEditable", "propertyMaxValue", "propertyMinValue", "propertyName", "propertyOptions", "propertyUnit", "propertyValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption:getInternalOccmDemandSignalCatalogResourcesInternalOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption": { "properties": { "optionKey": { "type": "string", "description": "key of a property option like memoryValue, ocpuValue.\n" }, "optionValue": { "type": "string", "description": "value of a property option like 64, 2 fastconnect etc.\n" } }, "type": "object", "required": [ "optionKey", "optionValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogsFilter:getInternalOccmDemandSignalCatalogsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollection:getInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollectionItem:getInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollectionItem:getInternalOccmDemandSignalCatalogsOccmDemandSignalCatalogCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "description of demand signal catalog.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The ocid of demand signal catalog.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the demand signal catalog was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the demand signal catalog was last updated.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "occCustomerGroupId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalDeliveriesFilter:getInternalOccmDemandSignalDeliveriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollection:getInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollectionItem:getInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollectionItem:getInternalOccmDemandSignalDeliveriesInternalOccmDemandSignalDeliveryCollectionItem": { "properties": { "acceptedQuantity": { "type": "string", "description": "The quantity of the resource that Oracle Cloud Infrastructure will supply to the customer.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "demandSignalId": { "type": "string", "description": "The OCID of the demand signal under which this delivery will be grouped.\n" }, "demandSignalItemId": { "type": "string", "description": "The OCID of the demand signal item corresponding to which this delivery is made.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A query parameter to filter the list of demand signals based on it's OCID.\n" }, "justification": { "type": "string", "description": "This field could be used by Oracle Cloud Infrastructure to communicate the reason for accepting or declining the request.\n" }, "lifecycleDetails": { "type": "string", "description": "The enum values corresponding to the various states associated with the delivery resource.\n" }, "notes": { "type": "string", "description": "This field acts as a notes section for operators.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeDelivered": { "type": "string", "description": "The date on which the Oracle Cloud Infrastructure delivered the resource to the customers. The default value for this will be the corresponding demand signal item resource's need by date.\n" } }, "type": "object", "required": [ "acceptedQuantity", "compartmentId", "definedTags", "demandSignalId", "demandSignalItemId", "freeformTags", "id", "justification", "lifecycleDetails", "notes", "occCustomerGroupId", "state", "systemTags", "timeDelivered" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalItemsFilter:getInternalOccmDemandSignalItemsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollection:getInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollectionItem:getInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollectionItem" }, "description": "An array of items containing detailed information about different resource demanded as part of a demand signal.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollectionItem:getInternalOccmDemandSignalItemsInternalOccmDemandSignalItemCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "demandSignalCatalogResourceId": { "type": "string", "description": "The OCID of the corresponding demand signal catalog resource.\n" }, "demandSignalId": { "type": "string", "description": "The OCID of the demand signal under which this item will be grouped.\n" }, "demandSignalNamespace": { "type": "string", "description": "A query parameter to filter the list of demand signal details based on the namespace.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the demand signal resource request.\n" }, "notes": { "type": "string", "description": "This field will serve as notes section for you. You can use this section to convey a message to Oracle Cloud Infrastructure regarding your resource request.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "quantity": { "type": "string", "description": "The quantity of the resource that you want to demand from Oracle Cloud Infrastructure or return to OCI.\n" }, "region": { "type": "string", "description": "The name of region for which you want to request the Oracle Cloud Infrastructure resource.\n" }, "requestType": { "type": "string", "description": "The type of request (DEMAND or RETURN) made against a particular demand signal item.\n" }, "resourceName": { "type": "string", "description": "A query parameter to filter the list of demand signal details based on the resource name.\n" }, "resourceProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of various properties associated with the Oracle Cloud Infrastructure resource.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the demand signal item.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetCompartmentId": { "type": "string", "description": "The ocid of the tenancy for which you want to request the Oracle Cloud Infrastructure resource for. This is an optional parameter.\n" }, "timeNeededBefore": { "type": "string", "description": "the date before which you would ideally like the Oracle Cloud Infrastructure resource to be delivered to you.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "demandSignalCatalogResourceId", "demandSignalId", "demandSignalNamespace", "freeformTags", "id", "notes", "occCustomerGroupId", "quantity", "region", "requestType", "resourceName", "resourceProperties", "state", "systemTags", "targetCompartmentId", "timeNeededBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalsFilter:getInternalOccmDemandSignalsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getInternalOccmDemandSignalsInternalOccmDemandSignalCollection:getInternalOccmDemandSignalsInternalOccmDemandSignalCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getInternalOccmDemandSignalsInternalOccmDemandSignalCollectionItem:getInternalOccmDemandSignalsInternalOccmDemandSignalCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getInternalOccmDemandSignalsInternalOccmDemandSignalCollectionItem:getInternalOccmDemandSignalsInternalOccmDemandSignalCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A short description about the demand signal.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A query parameter to filter the list of demand signals based on it's OCID.\n" }, "lifecycleDetails": { "type": "string", "description": "A query parameter to filter the list of demand signals based on its state.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group ocid by which we would filter the list.\n" }, "occmDemandSignalId": { "type": "string" }, "state": { "type": "string", "description": "The current lifecycle state of the demand signal.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the demand signal was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the demand signal was last updated.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "occCustomerGroupId", "occmDemandSignalId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getNamespaceOccOverviewsFilter:getNamespaceOccOverviewsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getNamespaceOccOverviewsOccOverviewCollection:getNamespaceOccOverviewsOccOverviewCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getNamespaceOccOverviewsOccOverviewCollectionItem:getNamespaceOccOverviewsOccOverviewCollectionItem" }, "description": "An array of overview summary.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getNamespaceOccOverviewsOccOverviewCollectionItem:getNamespaceOccOverviewsOccOverviewCollectionItem": { "properties": { "capacityRequestsBlob": { "type": "string", "description": "A raw json blob containing all the capacity requests corresponding to the resource name\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "periodValue": { "type": "string", "description": "The name of the month along with year for which this summary corresponds to.\n" }, "resourceName": { "type": "string", "description": "The name of the resource for which we have aggregated the value.\n" }, "totalAvailable": { "type": "string", "description": "The quantity of the resource which is available at the end of the period of aggregationDetails model in consideration.\n" }, "totalCancelled": { "type": "string", "description": "The quantity of the resource which is cancelled by the customer. Once the capacity request was submitted, the customer can still cancel it. This field sums up those values.\n" }, "totalDemanded": { "type": "string", "description": "The quantity of the resource which is demanded by customers via capacity requests against the resource name at the end of the time period in consideration for overview.\n" }, "totalRejected": { "type": "string", "description": "The quantity of the resource which is rejected by Oracle.\n" }, "totalSupplied": { "type": "string", "description": "The quantity of the resource which is supplied by Oracle to the customer against the resource name at the end of the time period in consideration.\n" }, "totalUnfulfilled": { "type": "string", "description": "The quantity of the resource which Oracle was unable to supply. For a given capacity request, Oracle sometimes cannot supply the entire value demanded by the customer. In such cases a partial value is provided, thereby leaving behind a portion of unfulfilled values. This field sums that up.\n" }, "unit": { "type": "string", "description": "The unit e.g SERVER in which the above values like totalAvailable, totalSupplied etc is measured.\n" }, "workloadTypeBreakdownBlob": { "type": "string", "description": "A raw json blob containing breakdown of totalAvailable, totalDemanded, totalSupplied, totalRejected, totalCancelled and totalUnfulfilled by workload types\n" } }, "type": "object", "required": [ "capacityRequestsBlob", "compartmentId", "periodValue", "resourceName", "totalAvailable", "totalCancelled", "totalDemanded", "totalRejected", "totalSupplied", "totalUnfulfilled", "unit", "workloadTypeBreakdownBlob" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogDetail:getOccAvailabilityCatalogDetail": { "properties": { "availableQuantity": { "type": "string", "description": "The quantity of resource currently available that the customer can request.\n" }, "catalogId": { "type": "string", "description": "The OCID of the availability catalog.\n" }, "dateExpectedCapacityHandover": { "type": "string", "description": "The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.\n" }, "dateFinalCustomerOrder": { "type": "string", "description": "The date by which the customer must place the order to have their capacity requirements met by the customer handover date.\n" }, "demandedQuantity": { "type": "string", "description": "The quantity of resource currently demanded by the customer.\n" }, "namespace": { "type": "string", "description": "The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.\n" }, "resourceName": { "type": "string", "description": "The name of the resource that the customer can request.\n" }, "resourceType": { "type": "string", "description": "The different types of resources against which customers can place capacity requests.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "totalAvailableQuantity": { "type": "string", "description": "The total quantity of resource that the customer can request.\n" }, "unit": { "type": "string", "description": "The unit in which the resource available is measured.\n" }, "workloadType": { "type": "string", "description": "The type of workload (Generic/ROW).\n" } }, "type": "object", "required": [ "availableQuantity", "catalogId", "dateExpectedCapacityHandover", "dateFinalCustomerOrder", "demandedQuantity", "namespace", "resourceName", "resourceType", "systemTags", "totalAvailableQuantity", "unit", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogMetadataDetail:getOccAvailabilityCatalogMetadataDetail": { "properties": { "formatVersion": { "type": "string", "description": "The version for the format of the catalog file being uploaded.\n" } }, "type": "object", "required": [ "formatVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogOccAvailabilitiesFilter:getOccAvailabilityCatalogOccAvailabilitiesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollection:getOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollectionItem:getOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollectionItem" }, "description": "An array of capacity constraints.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollectionItem:getOccAvailabilityCatalogOccAvailabilitiesOccAvailabilityCollectionItem": { "properties": { "availableQuantity": { "type": "string", "description": "The quantity of resource currently available that the customer can request.\n" }, "catalogId": { "type": "string", "description": "The OCID of the availability catalog.\n" }, "dateExpectedCapacityHandover": { "type": "string", "description": "The capacity handover date of the capacity constraint to filter the list of capacity constraints.\n" }, "dateFinalCustomerOrder": { "type": "string", "description": "The date by which the customer must place the order to have their capacity requirements met by the customer handover date.\n" }, "demandedQuantity": { "type": "string", "description": "The quantity of resource currently demanded by the customer.\n" }, "namespace": { "type": "string", "description": "The name of the Oracle Cloud Infrastructure service in consideration. For example, Compute, Exadata, and so on.\n" }, "resourceName": { "type": "string", "description": "The name of the resource to filter the list of capacity constraints.\n" }, "resourceType": { "type": "string", "description": "Resource type using which the capacity constraints of an availability catalog can be filtered.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "totalAvailableQuantity": { "type": "string", "description": "The total quantity of resource that the customer can request.\n" }, "unit": { "type": "string", "description": "The unit in which the resource available is measured.\n" }, "workloadType": { "type": "string", "description": "Workload type using the resources in an availability catalog can be filtered.\n" } }, "type": "object", "required": [ "availableQuantity", "catalogId", "dateExpectedCapacityHandover", "dateFinalCustomerOrder", "demandedQuantity", "namespace", "resourceName", "resourceType", "systemTags", "totalAvailableQuantity", "unit", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogsFilter:getOccAvailabilityCatalogsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollection:getOccAvailabilityCatalogsOccAvailabilityCatalogCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem:getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem:getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItem": { "properties": { "base64encodedCatalogDetails": { "type": "string" }, "catalogState": { "type": "string", "description": "Filter the list of availability catalogs based on the catalog state.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Text information about the availability catalog.\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemDetail:getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemDetail" }, "description": "Details about capacity available for different resources in catalog.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the availability catalog to filter the list of availability catalogs.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.\n" }, "metadataDetails": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail:getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail" }, "description": "Used for representing the metadata of the catalog. This denotes the version and format of the CSV file for parsing.\n" }, "namespace": { "type": "string", "description": "The namespace by which we would filter the list.\n" }, "occCustomerGroupId": { "type": "string", "description": "The customer group OCID to which the availability catalog belongs.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the availability catalog was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the availability catalog was last updated.\n" } }, "type": "object", "required": [ "base64encodedCatalogDetails", "catalogState", "compartmentId", "definedTags", "description", "details", "displayName", "freeformTags", "id", "lifecycleDetails", "metadataDetails", "namespace", "occCustomerGroupId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemDetail:getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemDetail": { "properties": { "availableQuantity": { "type": "string", "description": "The quantity of resource currently available that the customer can request.\n" }, "catalogId": { "type": "string", "description": "The OCID of the availability catalog.\n" }, "dateExpectedCapacityHandover": { "type": "string", "description": "The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.\n" }, "dateFinalCustomerOrder": { "type": "string", "description": "The date by which the customer must place the order to have their capacity requirements met by the customer handover date.\n" }, "demandedQuantity": { "type": "string", "description": "The quantity of resource currently demanded by the customer.\n" }, "namespace": { "type": "string", "description": "The namespace by which we would filter the list.\n" }, "resourceName": { "type": "string", "description": "The name of the resource that the customer can request.\n" }, "resourceType": { "type": "string", "description": "The different types of resources against which customers can place capacity requests.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "totalAvailableQuantity": { "type": "string", "description": "The total quantity of resource that the customer can request.\n" }, "unit": { "type": "string", "description": "The unit in which the resource available is measured.\n" }, "workloadType": { "type": "string", "description": "The type of workload (Generic/ROW).\n" } }, "type": "object", "required": [ "availableQuantity", "catalogId", "dateExpectedCapacityHandover", "dateFinalCustomerOrder", "demandedQuantity", "namespace", "resourceName", "resourceType", "systemTags", "totalAvailableQuantity", "unit", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail:getOccAvailabilityCatalogsOccAvailabilityCatalogCollectionItemMetadataDetail": { "properties": { "formatVersion": { "type": "string", "description": "The version for the format of the catalog file being uploaded.\n" } }, "type": "object", "required": [ "formatVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestDetail:getOccCapacityRequestDetail": { "properties": { "actualHandoverQuantity": { "type": "string", "description": "The actual handed over quantity of resources at the time of request resolution.\n" }, "associatedOccHandoverResourceBlockLists": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCapacityRequestDetailAssociatedOccHandoverResourceBlockList:getOccCapacityRequestDetailAssociatedOccHandoverResourceBlockList" }, "description": "A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests.\n" }, "dateActualHandover": { "type": "string", "description": "The date on which the actual handover quantity of resources is delivered.\n" }, "dateExpectedHandover": { "type": "string", "description": "The date on which the latest increment to supplied quantity of resources was delivered.\n" }, "demandQuantity": { "type": "string", "description": "The number of compute server's with name \u003cresourceName\u003e required by the user.\n" }, "expectedHandoverQuantity": { "type": "string", "description": "The incremental quantity of resources supplied as the provisioning is underway.\n" }, "resourceName": { "type": "string", "description": "The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name.\n" }, "resourceType": { "type": "string", "description": "The type of the resource against which the user wants to place a capacity request.\n" }, "sourceWorkloadType": { "type": "string", "description": "The WorkloadType from where capacity request are to be transferred.\n" }, "workloadType": { "type": "string", "description": "The type of the workload (Generic/ROW).\n" } }, "type": "object", "required": [ "actualHandoverQuantity", "associatedOccHandoverResourceBlockLists", "availabilityDomain", "dateActualHandover", "dateExpectedHandover", "demandQuantity", "expectedHandoverQuantity", "resourceName", "resourceType", "sourceWorkloadType", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestDetailAssociatedOccHandoverResourceBlockList:getOccCapacityRequestDetailAssociatedOccHandoverResourceBlockList": { "properties": { "handoverQuantity": { "type": "string", "description": "The total quantity of the resource that was made available to the customer as part of this resource block\n" }, "occHandoverResourceBlockId": { "type": "string", "description": "The OCID of the handed over resource block.\n" } }, "type": "object", "required": [ "handoverQuantity", "occHandoverResourceBlockId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestPatchOperation:getOccCapacityRequestPatchOperation": { "properties": { "from": { "type": "string" }, "operation": { "type": "string" }, "position": { "type": "string" }, "selectedItem": { "type": "string" }, "selection": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "from", "operation", "position", "selectedItem", "selection", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestsFilter:getOccCapacityRequestsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollection:getOccCapacityRequestsOccCapacityRequestCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItem:getOccCapacityRequestsOccCapacityRequestCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItem:getOccCapacityRequestsOccCapacityRequestCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "dateExpectedCapacityHandover": { "type": "string", "description": "The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Meaningful text about the capacity request.\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItemDetail:getOccCapacityRequestsOccCapacityRequestCollectionItemDetail" }, "description": "A list of resources requested as part of this request\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.\n" }, "namespace": { "type": "string", "description": "The namespace by which we would filter the list.\n" }, "occAvailabilityCatalogId": { "type": "string", "description": "A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created.\n" }, "occCustomerGroupId": { "type": "string", "description": "The OCID of the customer group to which this customer belongs to.\n" }, "patchOperations": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItemPatchOperation:getOccCapacityRequestsOccCapacityRequestCollectionItemPatchOperation" } }, "region": { "type": "string", "description": "The name of the region for which the capacity request was made.\n" }, "requestState": { "type": "string", "description": "The different states the capacity request goes through.\n" }, "requestType": { "type": "string", "description": "A filter to return only the resources that match the request type. The match is not case sensitive.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the capacity request was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the capacity request was updated.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "dateExpectedCapacityHandover", "definedTags", "description", "details", "displayName", "freeformTags", "id", "lifecycleDetails", "namespace", "occAvailabilityCatalogId", "occCustomerGroupId", "patchOperations", "region", "requestState", "requestType", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItemDetail:getOccCapacityRequestsOccCapacityRequestCollectionItemDetail": { "properties": { "actualHandoverQuantity": { "type": "string", "description": "The actual handed over quantity of resources at the time of request resolution.\n" }, "associatedOccHandoverResourceBlockLists": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItemDetailAssociatedOccHandoverResourceBlockList:getOccCapacityRequestsOccCapacityRequestCollectionItemDetailAssociatedOccHandoverResourceBlockList" }, "description": "A list containing details about occHandoverResourceBlocks which were handed over for the corresponding resource name.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the resource which is to be transferred. Note that this is only required for Capacity Request Transfer requests.\n" }, "dateActualHandover": { "type": "string", "description": "The date on which the actual handover quantity of resources is delivered.\n" }, "dateExpectedHandover": { "type": "string", "description": "The date on which the latest increment to supplied quantity of resources was delivered.\n" }, "demandQuantity": { "type": "string", "description": "The number of compute server's with name \u003cresourceName\u003e required by the user.\n" }, "expectedHandoverQuantity": { "type": "string", "description": "The incremental quantity of resources supplied as the provisioning is underway.\n" }, "resourceName": { "type": "string", "description": "The name of the COMPUTE server shape for which the request is made. Do not use CAPACITY_CONSTRAINT as the resource name.\n" }, "resourceType": { "type": "string", "description": "The type of the resource against which the user wants to place a capacity request.\n" }, "sourceWorkloadType": { "type": "string", "description": "The WorkloadType from where capacity request are to be transferred.\n" }, "workloadType": { "type": "string", "description": "The type of the workload (Generic/ROW).\n" } }, "type": "object", "required": [ "actualHandoverQuantity", "associatedOccHandoverResourceBlockLists", "availabilityDomain", "dateActualHandover", "dateExpectedHandover", "demandQuantity", "expectedHandoverQuantity", "resourceName", "resourceType", "sourceWorkloadType", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItemDetailAssociatedOccHandoverResourceBlockList:getOccCapacityRequestsOccCapacityRequestCollectionItemDetailAssociatedOccHandoverResourceBlockList": { "properties": { "handoverQuantity": { "type": "string", "description": "The total quantity of the resource that was made available to the customer as part of this resource block\n" }, "occHandoverResourceBlockId": { "type": "string", "description": "The OCID of the handed over resource block.\n" } }, "type": "object", "required": [ "handoverQuantity", "occHandoverResourceBlockId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCapacityRequestsOccCapacityRequestCollectionItemPatchOperation:getOccCapacityRequestsOccCapacityRequestCollectionItemPatchOperation": { "properties": { "from": { "type": "string" }, "operation": { "type": "string" }, "position": { "type": "string" }, "selectedItem": { "type": "string" }, "selection": { "type": "string" }, "value": { "type": "object", "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "from", "operation", "position", "selectedItem", "selection", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCustomerGroupCustomersList:getOccCustomerGroupCustomersList": { "properties": { "description": { "type": "string", "description": "The description about the customer group.\n" }, "displayName": { "type": "string", "description": "The display name of the customer group.\n" }, "occCustomerGroupId": { "type": "string", "description": "The OCID of the customer group.\n" }, "status": { "type": "string", "description": "To determine whether the customer group is enabled/disabled.\n" }, "tenancyId": { "type": "string", "description": "The OCID of the tenancy belonging to the customer.\n" } }, "type": "object", "required": [ "description", "displayName", "occCustomerGroupId", "status", "tenancyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCustomerGroupsFilter:getOccCustomerGroupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccCustomerGroupsOccCustomerGroupCollection:getOccCustomerGroupsOccCustomerGroupCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCustomerGroupsOccCustomerGroupCollectionItem:getOccCustomerGroupsOccCustomerGroupCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCustomerGroupsOccCustomerGroupCollectionItem:getOccCustomerGroupsOccCustomerGroupCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "customersLists": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList:getOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList" }, "description": "A list containing all the customers that belong to this customer group\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "The description about the customer group.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "status": { "type": "string", "description": "A query filter to return the list result based on status.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the customer group was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the customer group was last updated.\n" } }, "type": "object", "required": [ "compartmentId", "customersLists", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "status", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList:getOccCustomerGroupsOccCustomerGroupCollectionItemCustomersList": { "properties": { "description": { "type": "string", "description": "The description about the customer group.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "occCustomerGroupId": { "type": "string", "description": "The OCID of the customer group.\n" }, "status": { "type": "string", "description": "A query filter to return the list result based on status.\n" }, "tenancyId": { "type": "string", "description": "The OCID of the tenancy belonging to the customer.\n" } }, "type": "object", "required": [ "description", "displayName", "occCustomerGroupId", "status", "tenancyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccHandoverResourceBlockDetailsFilter:getOccHandoverResourceBlockDetailsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollection:getOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem:getOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem" }, "description": "An array of details about an occ handover resource block.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem:getOccHandoverResourceBlockDetailsOccHandoverResourceBlockDetailCollectionItem": { "properties": { "details": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map that contains additional details for a given handover resource. For example for compute namespace this includes host ocid, host serial etc.\n" }, "occResourceHandoverBlockId": { "type": "string", "description": "The OCID of the occResourceHandoverBlock.\n" } }, "type": "object", "required": [ "details", "occResourceHandoverBlockId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccHandoverResourceBlocksFilter:getOccHandoverResourceBlocksFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollection:getOccHandoverResourceBlocksOccHandoverResourceBlockCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem:getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem" }, "description": "An array of occ handover resource blocks.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem:getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItem": { "properties": { "associatedCapacityRequests": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest:getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest" }, "description": "A list containing details about the capacity requests against which the resources were provisioned by oracle.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment or tenancy in which resources are to be listed.\n" }, "handoverDate": { "type": "string", "description": "The date on which the resource was handed over to the customer.\n" }, "handoverResourceName": { "type": "string", "description": "A filter to return only the list of resources that match the name provided in this filter.\n" }, "id": { "type": "string", "description": "The OCID of the resource block.\n" }, "namespace": { "type": "string", "description": "The namespace by which we would filter the list.\n" }, "occCustomerGroupId": { "type": "string", "description": "The OCID of the customer group for which the resources were provisioned.\n" }, "placementDetails": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail:getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail" }, "description": "Details like building, room and block where the resource was placed after provisioning in the datacenter.\n" }, "totalHandoverQuantity": { "type": "string", "description": "The total quantity of the resource that was made available to the customer by Oracle.\n" } }, "type": "object", "required": [ "associatedCapacityRequests", "compartmentId", "handoverDate", "handoverResourceName", "id", "namespace", "occCustomerGroupId", "placementDetails", "totalHandoverQuantity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest:getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemAssociatedCapacityRequest": { "properties": { "handoverQuantity": { "type": "string", "description": "The total quantity of the bare metal hardware that was made available corresponding to the capacity request ocid.\n" }, "occCapacityRequestId": { "type": "string", "description": "The OCID of the capacity request against which the resources were provisioned.\n" } }, "type": "object", "required": [ "handoverQuantity", "occCapacityRequestId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail:getOccHandoverResourceBlocksOccHandoverResourceBlockCollectionItemPlacementDetail": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain (AD) for which the resources were provisioned.\n" }, "block": { "type": "string", "description": "The block in the datacenter room where the resource was placed.\n" }, "building": { "type": "string", "description": "The datacenter building where the resource was placed.\n" }, "region": { "type": "string", "description": "The name of the region for which the resources were provisioned.\n" }, "room": { "type": "string", "description": "The name of the room in the dataacenter building where the resource was placed.\n" }, "workloadType": { "type": "string", "description": "The type of workload to which these resources were provisioned.\n" } }, "type": "object", "required": [ "availabilityDomain", "block", "building", "region", "room", "workloadType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesFilter:getOccmDemandSignalCatalogResourcesFilter": { "properties": { "name": { "type": "string", "description": "A query parameter to filter the list of demand signal catalog resource based on the resource name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollection:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItem:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItem" }, "description": "An array of items containing detailed information about a resource's property dependecies.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItem:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the demand signal catalog resource.\n" }, "name": { "type": "string", "description": "A query parameter to filter the list of demand signal catalog resource based on the resource name.\n" }, "namespace": { "type": "string", "description": "The name of the Oracle Cloud Infrastructure service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc.\n" }, "region": { "type": "string", "description": "The name of region for which you want to request the Oracle Cloud Infrastructure resource. This is an optional parameter.\n" }, "resourceProperties": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourceProperty:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourceProperty" }, "description": "A list containing detailed information about a resource's properties.\n" }, "resourcePropertyConstraints": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint" }, "description": "A list containing detailed information about a resource's property constraints.\n" }, "state": { "type": "string", "description": "The current lifecycles state of the demand signal catalog resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetCompartmentId": { "type": "string", "description": "The OCID of the customer tenancy for which this resource will be available for the customer to order against.\n" }, "timeCreated": { "type": "string", "description": "The time when the demand signal catalog resource was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the demand signal catalog resource was last updated.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "freeformTags", "id", "name", "namespace", "region", "resourceProperties", "resourcePropertyConstraints", "state", "systemTags", "targetCompartmentId", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourceProperty:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourceProperty": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem" }, "description": "An array of items containing detailed information about a resource's property dependecies.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraint": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem" }, "description": "An array of items containing detailed information about a resource's property dependecies.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyConstraintItem": { "properties": { "constraintName": { "type": "string", "description": "The name of demand signal resource's property constraint.\n" }, "constraintValue": { "type": "string", "description": "The value of demand signal resource's property constraint.\n" } }, "type": "object", "required": [ "constraintName", "constraintValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItem": { "properties": { "isEditable": { "type": "boolean", "description": "This will indicate if demand signal resource's property is editable.\n" }, "propertyMaxValue": { "type": "string", "description": "The maximum value of demand signal resource's property. This is an optional parameter.\n" }, "propertyMinValue": { "type": "string", "description": "The minimum value of demand signal resource's property. This is an optional parameter.\n" }, "propertyName": { "type": "string", "description": "The name of demand signal resource's property.\n" }, "propertyOptions": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption" }, "description": "Predefined options for demand signal resource's property. This is an optional parameter.\n" }, "propertyUnit": { "type": "string", "description": "Unit for demand signal resource's property.\n" }, "propertyValue": { "type": "string", "description": "Default value of demand signal resource's property.\n" } }, "type": "object", "required": [ "isEditable", "propertyMaxValue", "propertyMinValue", "propertyName", "propertyOptions", "propertyUnit", "propertyValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption:getOccmDemandSignalCatalogResourcesOccmDemandSignalCatalogResourceCollectionItemResourcePropertyItemPropertyOption": { "properties": { "optionKey": { "type": "string", "description": "key of a property option like memoryValue, ocpuValue.\n" }, "optionValue": { "type": "string", "description": "value of a property option like 64, 2 fastconnect etc.\n" } }, "type": "object", "required": [ "optionKey", "optionValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalDeliveriesFilter:getOccmDemandSignalDeliveriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollection:getOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollectionItem:getOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollectionItem" }, "description": "An array of items containing detailed information about demand signal delivery resources.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollectionItem:getOccmDemandSignalDeliveriesOccmDemandSignalDeliveryCollectionItem": { "properties": { "acceptedQuantity": { "type": "string", "description": "The quantity of the resource that Oracle Cloud Infrastructure will supply to the customer.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "demandSignalId": { "type": "string", "description": "The OCID of the demand signal under which this delivery will be grouped.\n" }, "demandSignalItemId": { "type": "string", "description": "The OCID of the demand signal item corresponding to which this delivery is made.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A query parameter to filter the list of demand signals based on it's OCID.\n" }, "justification": { "type": "string", "description": "This field could be used by Oracle Cloud Infrastructure to communicate the reason for accepting or declining the request.\n" }, "lifecycleDetails": { "type": "string", "description": "The enum values corresponding to the various states associated with the delivery resource.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeDelivered": { "type": "string", "description": "The date on which the Oracle Cloud Infrastructure delivered the resource to the customers.\n" } }, "type": "object", "required": [ "acceptedQuantity", "compartmentId", "definedTags", "demandSignalId", "demandSignalItemId", "freeformTags", "id", "justification", "lifecycleDetails", "state", "systemTags", "timeDelivered" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalItemsFilter:getOccmDemandSignalItemsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccmDemandSignalItemsOccmDemandSignalItemCollection:getOccmDemandSignalItemsOccmDemandSignalItemCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalItemsOccmDemandSignalItemCollectionItem:getOccmDemandSignalItemsOccmDemandSignalItemCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalItemsOccmDemandSignalItemCollectionItem:getOccmDemandSignalItemsOccmDemandSignalItemCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain for which you want to request the Oracle Cloud Infrastructure resource.\n" }, "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "demandQuantity": { "type": "string", "description": "The quantity of the resource that you want to demand from OCI.\n" }, "demandSignalCatalogResourceId": { "type": "string", "description": "The OCID of the corresponding demand signal catalog resource.\n" }, "demandSignalId": { "type": "string", "description": "The OCID of the demand signal under which this item will be grouped.\n" }, "demandSignalNamespace": { "type": "string", "description": "A query parameter to filter the list of demand signal details based on the namespace.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the demand signal item.\n" }, "notes": { "type": "string", "description": "This field will serve as notes section for you. You can use this section to convey a message to Oracle Cloud Infrastructure regarding your resource request.\n" }, "region": { "type": "string", "description": "The name of region for which you want to request the Oracle Cloud Infrastructure resource.\n" }, "requestType": { "type": "string", "description": "The type of request (DEMAND or RETURN) made against a particular demand signal item.\n" }, "resourceName": { "type": "string", "description": "A query parameter to filter the list of demand signal details based on the resource name.\n" }, "resourceProperties": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of various properties associated with the Oracle Cloud Infrastructure resource.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetCompartmentId": { "type": "string", "description": "The OCID of the tenancy for which you want to request the Oracle Cloud Infrastructure resource for. This is an optional parameter.\n" }, "timeNeededBefore": { "type": "string", "description": "the date before which you would ideally like the Oracle Cloud Infrastructure resource to be delivered to you.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "demandQuantity", "demandSignalCatalogResourceId", "demandSignalId", "demandSignalNamespace", "freeformTags", "id", "notes", "region", "requestType", "resourceName", "resourceProperties", "state", "systemTags", "targetCompartmentId", "timeNeededBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalsFilter:getOccmDemandSignalsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CapacityManagement/getOccmDemandSignalsOccmDemandSignalCollection:getOccmDemandSignalsOccmDemandSignalCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CapacityManagement/getOccmDemandSignalsOccmDemandSignalCollectionItem:getOccmDemandSignalsOccmDemandSignalCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CapacityManagement/getOccmDemandSignalsOccmDemandSignalCollectionItem:getOccmDemandSignalsOccmDemandSignalCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Meaningful text about the demand signal.\n" }, "displayName": { "type": "string", "description": "A filter to return only the resources that match the entire display name. The match is not case sensitive.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A query parameter to filter the list of demand signals based on it's OCID.\n" }, "lifecycleDetails": { "type": "string", "description": "A query parameter to filter the list of demand signals based on its state.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the demand signal was created.\n" }, "timeUpdated": { "type": "string", "description": "The time when the demand signal was last updated.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfig:CertificateAuthorityCertificateAuthorityConfig": { "properties": { "actionDetails": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfigActionDetails:CertificateAuthorityCertificateAuthorityConfigActionDetails" }, "certificatePem": { "type": "string", "description": "(Updatable) The externally signed certificate (in PEM format) for the imported root CA.\n" }, "configType": { "type": "string", "description": "(Updatable) The origin of the CA.\n" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the private, external issuer CA.\n", "willReplaceOnChanges": true }, "signingAlgorithm": { "type": "string", "description": "The algorithm used to sign public key certificates that the CA issues.\n", "willReplaceOnChanges": true }, "subject": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfigSubject:CertificateAuthorityCertificateAuthorityConfigSubject", "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n", "willReplaceOnChanges": true }, "validity": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfigValidity:CertificateAuthorityCertificateAuthorityConfigValidity", "description": "(Updatable) An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "(Updatable) The name of the CA version. When the value is not null, a name is unique across versions of a given CA.\n" } }, "type": "object", "required": [ "configType" ], "language": { "nodejs": { "requiredOutputs": [ "certificatePem", "configType", "signingAlgorithm", "subject" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfigActionDetails:CertificateAuthorityCertificateAuthorityConfigActionDetails": { "properties": { "actionType": { "type": "string" }, "certificatePem": { "type": "string", "description": "(Updatable) The externally signed certificate (in PEM format) for the imported root CA.\n" } }, "type": "object" }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfigSubject:CertificateAuthorityCertificateAuthorityConfigSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n", "willReplaceOnChanges": true }, "country": { "type": "string", "description": "Country name (RDN C).\n", "willReplaceOnChanges": true }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n", "willReplaceOnChanges": true }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n", "willReplaceOnChanges": true }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n", "willReplaceOnChanges": true }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n", "willReplaceOnChanges": true }, "initials": { "type": "string", "description": "Personal initials.\n", "willReplaceOnChanges": true }, "localityName": { "type": "string", "description": "Locality (RDN L).\n", "willReplaceOnChanges": true }, "organization": { "type": "string", "description": "Organization (RDN O).\n", "willReplaceOnChanges": true }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n", "willReplaceOnChanges": true }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n", "willReplaceOnChanges": true }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n", "willReplaceOnChanges": true }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n", "willReplaceOnChanges": true }, "street": { "type": "string", "description": "Street address (RDN STREET).\n", "willReplaceOnChanges": true }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n", "willReplaceOnChanges": true }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n", "willReplaceOnChanges": true }, "userId": { "type": "string", "description": "User ID (RDN UID).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "commonName" ] }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityConfigValidity:CertificateAuthorityCertificateAuthorityConfigValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "(Updatable) The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "(Updatable) The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter" ] }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRule:CertificateAuthorityCertificateAuthorityRule": { "properties": { "certificateAuthorityMaxValidityDuration": { "type": "string", "description": "(Updatable) A property indicating the maximum validity duration, in days, of subordinate CA's issued by this CA. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "leafCertificateMaxValidityDuration": { "type": "string", "description": "(Updatable) A property indicating the maximum validity duration, in days, of leaf certificates issued by this CA. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "nameConstraint": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRuleNameConstraint:CertificateAuthorityCertificateAuthorityRuleNameConstraint", "description": "A constraint that specifies permitted and excluded namespaces for the hierarchical name forms in certificates that any CA in the certificate chain issues. You can define name constraints on a directory name, DNS address, or IP address. If you have a name constraint, you must define at least one permitted namespace or one excluded namespace. Name constraints cannot be updated.\n" }, "pathLengthConstraint": { "type": "integer", "description": "The number of levels of descendants that this certificate authority (CA) can issue. When set to zero, the CA can issue only leaf certificates. There is no limit if the constraint isn't specified. Path length constraints cannot be updated.\n" }, "ruleType": { "type": "string", "description": "(Updatable) The type of rule, whether an issuance rule that defines the constraints which restricts the hierarchical name forms in certificates or number of levels of descendants that any CA in the certificate chain issues or an issuance expiry rule that governs how long the certificates and CAs issued by the CA are valid.\n" } }, "type": "object", "required": [ "ruleType" ], "language": { "nodejs": { "requiredOutputs": [ "nameConstraint", "pathLengthConstraint", "ruleType" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRuleNameConstraint:CertificateAuthorityCertificateAuthorityRuleNameConstraint": { "properties": { "excludedSubtrees": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree:CertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree" }, "description": "A list that contains excluded (or prohibited) namespaces. If you have a name constraint with no permitted namespaces, you must specify at least one excluded namespace.\n" }, "permittedSubtrees": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree:CertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree" }, "description": "A list that contains permitted namespaces. If you have a name constraint with no excluded namespaces, you must specify at least one permitted namespace.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "excludedSubtrees", "permittedSubtrees" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree:CertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree": { "properties": { "type": { "type": "string", "description": "The type of name constraint.\n" }, "value": { "type": "string", "description": "Name restrictions for the corresponding type of name constraint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type", "value" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree:CertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree": { "properties": { "type": { "type": "string", "description": "The type of name constraint.\n" }, "value": { "type": "string", "description": "Name restrictions for the corresponding type of name constraint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type", "value" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateRevocationListDetails:CertificateAuthorityCertificateRevocationListDetails": { "properties": { "customFormattedUrls": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" }, "objectStorageConfig": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCertificateRevocationListDetailsObjectStorageConfig:CertificateAuthorityCertificateRevocationListDetailsObjectStorageConfig", "description": "(Updatable) The details of the Object Storage bucket configured to store the certificate revocation list (CRL).\n" } }, "type": "object", "required": [ "objectStorageConfig" ], "language": { "nodejs": { "requiredOutputs": [ "customFormattedUrls", "objectStorageConfig" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCertificateRevocationListDetailsObjectStorageConfig:CertificateAuthorityCertificateRevocationListDetailsObjectStorageConfig": { "properties": { "objectStorageBucketName": { "type": "string", "description": "(Updatable) The name of the bucket where the CRL is stored.\n" }, "objectStorageNamespace": { "type": "string", "description": "(Updatable) The tenancy of the bucket where the CRL is stored.\n" }, "objectStorageObjectNameFormat": { "type": "string", "description": "(Updatable) The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" } }, "type": "object", "required": [ "objectStorageBucketName", "objectStorageObjectNameFormat" ], "language": { "nodejs": { "requiredOutputs": [ "objectStorageBucketName", "objectStorageNamespace", "objectStorageObjectNameFormat" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCurrentVersion:CertificateAuthorityCurrentVersion": { "properties": { "certificateAuthorityId": { "type": "string", "description": "The OCID of the CA.\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing CA.\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCurrentVersionRevocationStatus:CertificateAuthorityCurrentVersionRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this CA version.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateAuthorityCurrentVersionValidity:CertificateAuthorityCurrentVersionValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.\n" }, "versionNumber": { "type": "string", "description": "The version number of the CA.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificateAuthorityId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCurrentVersionRevocationStatus:CertificateAuthorityCurrentVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "revocationReason", "timeOfRevocation" ] } } }, "oci:CertificatesManagement/CertificateAuthorityCurrentVersionValidity:CertificateAuthorityCurrentVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ] } } }, "oci:CertificatesManagement/CertificateAuthoritySubject:CertificateAuthoritySubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ] } } }, "oci:CertificatesManagement/CertificateCertificateConfig:CertificateCertificateConfig": { "properties": { "certChainPem": { "type": "string", "description": ", \u003cspan pulumi-lang-nodejs=\"`certificatePem`\" pulumi-lang-dotnet=\"`CertificatePem`\" pulumi-lang-go=\"`certificatePem`\" pulumi-lang-python=\"`certificate_pem`\" pulumi-lang-yaml=\"`certificatePem`\" pulumi-lang-java=\"`certificatePem`\" pulumi-lang-hcl=\"`certificate_pem`\"\u003e`certificatePem`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`privateKeyPem`\" pulumi-lang-dotnet=\"`PrivateKeyPem`\" pulumi-lang-go=\"`privateKeyPem`\" pulumi-lang-python=\"`private_key_pem`\" pulumi-lang-yaml=\"`privateKeyPem`\" pulumi-lang-java=\"`privateKeyPem`\" pulumi-lang-hcl=\"`private_key_pem`\"\u003e`privateKeyPem`\u003c/span\u003e, \u003cspan pulumi-lang-nodejs=\"`privateKeyPemPassphrase`\" pulumi-lang-dotnet=\"`PrivateKeyPemPassphrase`\" pulumi-lang-go=\"`privateKeyPemPassphrase`\" pulumi-lang-python=\"`private_key_pem_passphrase`\" pulumi-lang-yaml=\"`privateKeyPemPassphrase`\" pulumi-lang-java=\"`privateKeyPemPassphrase`\" pulumi-lang-hcl=\"`private_key_pem_passphrase`\"\u003e`privateKeyPemPassphrase`\u003c/span\u003e, and \u003cspan pulumi-lang-nodejs=\"`stage`\" pulumi-lang-dotnet=\"`Stage`\" pulumi-lang-go=\"`stage`\" pulumi-lang-python=\"`stage`\" pulumi-lang-yaml=\"`stage`\" pulumi-lang-java=\"`stage`\" pulumi-lang-hcl=\"`stage`\"\u003e`stage`\u003c/span\u003e can only be used when `config_type=IMPORTED`.\n" }, "certificatePem": { "type": "string", "description": "(Updatable) The leaf certificate (in PEM format).\n" }, "certificateProfileType": { "type": "string", "description": "The name of the profile used to create the certificate, which depends on the type of certificate you need.\n", "willReplaceOnChanges": true }, "configType": { "type": "string", "description": "(Updatable) The origin of the certificate. It must be one of the supported types: MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA, ISSUED_BY_INTERNAL_CA, or IMPORTED.\n" }, "csrPem": { "type": "string", "description": "(Updatable) The certificate signing request (in PEM format).\n" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the private CA.\n", "willReplaceOnChanges": true }, "keyAlgorithm": { "type": "string", "description": "The algorithm to use to create key pairs.\n", "willReplaceOnChanges": true }, "privateKeyPem": { "type": "string", "description": "(Updatable) The private key (in PEM format). This value is sensitive.\n", "secret": true }, "privateKeyPemPassphrase": { "type": "string", "description": "(Updatable) The passphrase for the encrypted private key in PEM format. This value is sensitive.\n", "secret": true }, "signatureAlgorithm": { "type": "string", "description": "The algorithm to use to sign the public key certificate.\n", "willReplaceOnChanges": true }, "stage": { "type": "string", "description": "(Updatable) The rotation stage used for imported certificate version updates. Supported values are `CURRENT` and `PENDING`. Defaults to `CURRENT` when omitted.\n" }, "subject": { "$ref": "#/types/oci:CertificatesManagement/CertificateCertificateConfigSubject:CertificateCertificateConfigSubject", "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n", "willReplaceOnChanges": true }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateCertificateConfigSubjectAlternativeName:CertificateCertificateConfigSubjectAlternativeName" }, "description": "A list of subject alternative names.\n", "willReplaceOnChanges": true }, "validity": { "$ref": "#/types/oci:CertificatesManagement/CertificateCertificateConfigValidity:CertificateCertificateConfigValidity", "description": "(Updatable) An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "(Updatable) A name for the certificate. When the value is not null, a name is unique across versions of a given certificate.\n" } }, "type": "object", "required": [ "configType" ], "language": { "nodejs": { "requiredOutputs": [ "configType", "keyAlgorithm", "signatureAlgorithm", "stage" ] } } }, "oci:CertificatesManagement/CertificateCertificateConfigSubject:CertificateCertificateConfigSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n", "willReplaceOnChanges": true }, "country": { "type": "string", "description": "Country name (RDN C).\n", "willReplaceOnChanges": true }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n", "willReplaceOnChanges": true }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n", "willReplaceOnChanges": true }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n", "willReplaceOnChanges": true }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n", "willReplaceOnChanges": true }, "initials": { "type": "string", "description": "Personal initials.\n", "willReplaceOnChanges": true }, "localityName": { "type": "string", "description": "Locality (RDN L).\n", "willReplaceOnChanges": true }, "organization": { "type": "string", "description": "Organization (RDN O).\n", "willReplaceOnChanges": true }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n", "willReplaceOnChanges": true }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n", "willReplaceOnChanges": true }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n", "willReplaceOnChanges": true }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n", "willReplaceOnChanges": true }, "street": { "type": "string", "description": "Street address (RDN STREET).\n", "willReplaceOnChanges": true }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n", "willReplaceOnChanges": true }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n", "willReplaceOnChanges": true }, "userId": { "type": "string", "description": "User ID (RDN UID).\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "commonName" ] }, "oci:CertificatesManagement/CertificateCertificateConfigSubjectAlternativeName:CertificateCertificateConfigSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The subject alternative name.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type", "value" ] }, "oci:CertificatesManagement/CertificateCertificateConfigValidity:CertificateCertificateConfigValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "(Updatable) The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "(Updatable) The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter" ] }, "oci:CertificatesManagement/CertificateCertificateRevocationListDetail:CertificateCertificateRevocationListDetail": { "properties": { "customFormattedUrls": { "type": "array", "items": { "type": "string" }, "description": "Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" }, "objectStorageConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateCertificateRevocationListDetailObjectStorageConfig:CertificateCertificateRevocationListDetailObjectStorageConfig" }, "description": "The details of the Object Storage bucket configured to store the certificate revocation list (CRL).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customFormattedUrls", "objectStorageConfigs" ] } } }, "oci:CertificatesManagement/CertificateCertificateRevocationListDetailObjectStorageConfig:CertificateCertificateRevocationListDetailObjectStorageConfig": { "properties": { "objectStorageBucketName": { "type": "string", "description": "The name of the bucket where the CRL is stored.\n" }, "objectStorageNamespace": { "type": "string", "description": "The tenancy of the bucket where the CRL is stored.\n" }, "objectStorageObjectNameFormat": { "type": "string", "description": "The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "objectStorageBucketName", "objectStorageNamespace", "objectStorageObjectNameFormat" ] } } }, "oci:CertificatesManagement/CertificateCertificateRule:CertificateCertificateRule": { "properties": { "advanceRenewalPeriod": { "type": "string", "description": "(Updatable) A property specifying the period of time, in days, before the certificate's targeted renewal that the process should occur. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "renewalInterval": { "type": "string", "description": "(Updatable) A property specifying how often, in days, a certificate should be renewed. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "ruleType": { "type": "string", "description": "(Updatable) The type of rule.\n" } }, "type": "object", "required": [ "advanceRenewalPeriod", "renewalInterval", "ruleType" ] }, "oci:CertificatesManagement/CertificateCurrentVersion:CertificateCurrentVersion": { "properties": { "certificateId": { "type": "string", "description": "The OCID of the certificate.\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing certificate authority (CA).\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateCurrentVersionRevocationStatus:CertificateCurrentVersionRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this certificate version.\n" }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateCurrentVersionSubjectAlternativeName:CertificateCurrentVersionSubjectAlternativeName" }, "description": "A list of subject alternative names.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the certificate was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/CertificateCurrentVersionValidity:CertificateCurrentVersionValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate.\n" }, "versionNumber": { "type": "string", "description": "The version number of the certificate.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "certificateId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "subjectAlternativeNames", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ] } } }, "oci:CertificatesManagement/CertificateCurrentVersionRevocationStatus:CertificateCurrentVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "revocationReason", "timeOfRevocation" ] } } }, "oci:CertificatesManagement/CertificateCurrentVersionSubjectAlternativeName:CertificateCurrentVersionSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "type", "value" ] } } }, "oci:CertificatesManagement/CertificateCurrentVersionValidity:CertificateCurrentVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ] } } }, "oci:CertificatesManagement/CertificateSubject:CertificateSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ] } } }, "oci:CertificatesManagement/getAssociationsAssociationCollection:getAssociationsAssociationCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getAssociationsAssociationCollectionItem:getAssociationsAssociationCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getAssociationsAssociationCollectionItem:getAssociationsAssociationCollectionItem": { "properties": { "associatedResourceId": { "type": "string", "description": "A filter that returns only resources that match the given OCID of an associated Oracle Cloud Infrastructure resource.\n" }, "associationType": { "type": "string", "description": "Type of associations to list. If the parameter is set to null, the service lists all types of associations.\n" }, "certificatesResourceId": { "type": "string", "description": "A filter that returns only resources that match the given OCID of a certificate-related resource.\n" }, "compartmentId": { "type": "string", "description": "A filter that returns only resources that match the given compartment OCID.\n" }, "id": { "type": "string", "description": "The OCID of the association.\n" }, "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "state": { "type": "string", "description": "The current lifecycle state of the association.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the association was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "associatedResourceId", "associationType", "certificatesResourceId", "compartmentId", "id", "name", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getAssociationsFilter:getAssociationsFilter": { "properties": { "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CertificatesManagement/getCaBundlesCaBundleCollection:getCaBundlesCaBundleCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCaBundlesCaBundleCollectionItem:getCaBundlesCaBundleCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCaBundlesCaBundleCollectionItem:getCaBundlesCaBundleCollectionItem": { "properties": { "caBundlePem": { "type": "string" }, "compartmentId": { "type": "string", "description": "A filter that returns only resources that match the given compartment OCID.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "A brief description of the CA bundle.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the CA bundle.\n" }, "lifecycleDetails": { "type": "string", "description": "Additional information about the current lifecycle state of the CA bundle.\n" }, "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "state": { "type": "string", "description": "A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the CA bundle was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "caBundlePem", "compartmentId", "definedTags", "description", "freeformTags", "id", "lifecycleDetails", "name", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCaBundlesFilter:getCaBundlesFilter": { "properties": { "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollection:getCertificateAuthoritiesCertificateAuthorityCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItem:getCertificateAuthoritiesCertificateAuthorityCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItem:getCertificateAuthoritiesCertificateAuthorityCollectionItem": { "properties": { "certificateAuthorityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfig:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfig" } }, "certificateAuthorityRules": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRule:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRule" }, "description": "An optional list of rules that control how the CA is used and managed.\n" }, "certificateRevocationListDetails": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetail:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetail" }, "description": "The details of the certificate revocation list (CRL).\n" }, "compartmentId": { "type": "string", "description": "A filter that returns only resources that match the given compartment OCID.\n" }, "configType": { "type": "string", "description": "The origin of the CA.\n" }, "currentVersions": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersion:getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersion" }, "description": "The metadata details of the certificate authority (CA) version. This summary object does not contain the CA contents.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A brief description of the CA.\n" }, "externalKeyDescription": { "type": "string", "description": "For externally managed CAs, a description of the externally managed key. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The OCID of the CA.\n" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure Vault key used to encrypt the CA.\n" }, "lifecycleDetails": { "type": "string", "description": "Additional information about the current CA lifecycle state.\n" }, "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "signingAlgorithm": { "type": "string", "description": "The algorithm used to sign public key certificates that the CA issues.\n" }, "state": { "type": "string", "description": "A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "subjects": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemSubject:getCertificateAuthoritiesCertificateAuthorityCollectionItemSubject" }, "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "certificateAuthorityConfigs", "certificateAuthorityRules", "certificateRevocationListDetails", "compartmentId", "configType", "currentVersions", "definedTags", "description", "externalKeyDescription", "freeformTags", "id", "issuerCertificateAuthorityId", "kmsKeyId", "lifecycleDetails", "name", "signingAlgorithm", "state", "subjects", "timeCreated", "timeOfDeletion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfig:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfig": { "properties": { "actionDetails": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigActionDetail:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigActionDetail" } }, "certificatePem": { "type": "string" }, "configType": { "type": "string", "description": "The origin of the CA.\n" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs.\n" }, "signingAlgorithm": { "type": "string", "description": "The algorithm used to sign public key certificates that the CA issues.\n" }, "subjects": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigSubject:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigSubject" }, "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigValidity:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.\n" } }, "type": "object", "required": [ "actionDetails", "certificatePem", "configType", "issuerCertificateAuthorityId", "signingAlgorithm", "subjects", "validities", "versionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigActionDetail:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigActionDetail": { "properties": { "actionType": { "type": "string" }, "certificatePem": { "type": "string" } }, "type": "object", "required": [ "actionType", "certificatePem" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigSubject:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigValidity:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityConfigValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRule:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRule": { "properties": { "certificateAuthorityMaxValidityDuration": { "type": "string", "description": "A property indicating the maximum validity duration, in days, of subordinate CA's issued by this CA. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "leafCertificateMaxValidityDuration": { "type": "string", "description": "A property indicating the maximum validity duration, in days, of leaf certificates issued by this CA. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "nameConstraints": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraint:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraint" }, "description": "A constraint that specifies permitted and excluded namespaces for the hierarchical name forms in certificates that any CA in the certificate chain issues. You can define name constraints on a directory name, DNS address, or IP address. If you have a name constraint, you must define at least one permitted namespace or one excluded namespace. Name constraints cannot be updated.\n" }, "pathLengthConstraint": { "type": "integer", "description": "The number of levels of descendants that this certificate authority (CA) can issue. When set to zero, the CA can issue only leaf certificates. There is no limit if the constraint isn't specified. Path length constraints cannot be updated.\n" }, "ruleType": { "type": "string", "description": "The type of rule, whether an issuance rule that defines the constraints which restricts the hierarchical name forms in certificates or number of levels of descendants that any CA in the certificate chain issues or an issuance expiry rule that governs how long the certificates and CAs issued by the CA are valid.\n" } }, "type": "object", "required": [ "certificateAuthorityMaxValidityDuration", "leafCertificateMaxValidityDuration", "nameConstraints", "pathLengthConstraint", "ruleType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraint:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraint": { "properties": { "excludedSubtrees": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintExcludedSubtree:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintExcludedSubtree" }, "description": "A list that contains excluded (or prohibited) namespaces. If you have a name constraint with no permitted namespaces, you must specify at least one excluded namespace.\n" }, "permittedSubtrees": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintPermittedSubtree:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintPermittedSubtree" }, "description": "A list that contains permitted namespaces. If you have a name constraint with no excluded namespaces, you must specify at least one permitted namespace.\n" } }, "type": "object", "required": [ "excludedSubtrees", "permittedSubtrees" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintExcludedSubtree:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintExcludedSubtree": { "properties": { "type": { "type": "string", "description": "The type of name constraint.\n" }, "value": { "type": "string", "description": "Name restrictions for the corresponding type of name constraint.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintPermittedSubtree:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateAuthorityRuleNameConstraintPermittedSubtree": { "properties": { "type": { "type": "string", "description": "The type of name constraint.\n" }, "value": { "type": "string", "description": "Name restrictions for the corresponding type of name constraint.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetail:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetail": { "properties": { "customFormattedUrls": { "type": "array", "items": { "type": "string" }, "description": "Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" }, "objectStorageConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetailObjectStorageConfig:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetailObjectStorageConfig" }, "description": "The details of the Object Storage bucket configured to store the certificate revocation list (CRL).\n" } }, "type": "object", "required": [ "customFormattedUrls", "objectStorageConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetailObjectStorageConfig:getCertificateAuthoritiesCertificateAuthorityCollectionItemCertificateRevocationListDetailObjectStorageConfig": { "properties": { "objectStorageBucketName": { "type": "string", "description": "The name of the bucket where the CRL is stored.\n" }, "objectStorageNamespace": { "type": "string", "description": "The tenancy of the bucket where the CRL is stored.\n" }, "objectStorageObjectNameFormat": { "type": "string", "description": "The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" } }, "type": "object", "required": [ "objectStorageBucketName", "objectStorageNamespace", "objectStorageObjectNameFormat" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersion:getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersion": { "properties": { "certificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs.\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing CA.\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionRevocationStatus:getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this CA version.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionValidity:getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.\n" }, "versionNumber": { "type": "string", "description": "The version number of the CA.\n" } }, "type": "object", "required": [ "certificateAuthorityId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionRevocationStatus:getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionValidity:getCertificateAuthoritiesCertificateAuthorityCollectionItemCurrentVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesCertificateAuthorityCollectionItemSubject:getCertificateAuthoritiesCertificateAuthorityCollectionItemSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritiesFilter:getCertificateAuthoritiesFilter": { "properties": { "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfig:getCertificateAuthorityCertificateAuthorityConfig": { "properties": { "actionDetails": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfigActionDetail:getCertificateAuthorityCertificateAuthorityConfigActionDetail" } }, "certificatePem": { "type": "string" }, "configType": { "type": "string", "description": "The origin of the CA.\n" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the parent CA that issued this CA. If this is the root CA, then this value is null.\n" }, "signingAlgorithm": { "type": "string", "description": "The algorithm used to sign public key certificates that the CA issues.\n" }, "subjects": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfigSubject:getCertificateAuthorityCertificateAuthorityConfigSubject" }, "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfigValidity:getCertificateAuthorityCertificateAuthorityConfigValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.\n" } }, "type": "object", "required": [ "actionDetails", "certificatePem", "configType", "issuerCertificateAuthorityId", "signingAlgorithm", "subjects", "validities", "versionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfigActionDetail:getCertificateAuthorityCertificateAuthorityConfigActionDetail": { "properties": { "actionType": { "type": "string" }, "certificatePem": { "type": "string" } }, "type": "object", "required": [ "actionType", "certificatePem" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfigSubject:getCertificateAuthorityCertificateAuthorityConfigSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityConfigValidity:getCertificateAuthorityCertificateAuthorityConfigValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRule:getCertificateAuthorityCertificateAuthorityRule": { "properties": { "certificateAuthorityMaxValidityDuration": { "type": "string", "description": "A property indicating the maximum validity duration, in days, of subordinate CA's issued by this CA. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "leafCertificateMaxValidityDuration": { "type": "string", "description": "A property indicating the maximum validity duration, in days, of leaf certificates issued by this CA. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "nameConstraints": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRuleNameConstraint:getCertificateAuthorityCertificateAuthorityRuleNameConstraint" }, "description": "A constraint that specifies permitted and excluded namespaces for the hierarchical name forms in certificates that any CA in the certificate chain issues. You can define name constraints on a directory name, DNS address, or IP address. If you have a name constraint, you must define at least one permitted namespace or one excluded namespace. Name constraints cannot be updated.\n" }, "pathLengthConstraint": { "type": "integer", "description": "The number of levels of descendants that this certificate authority (CA) can issue. When set to zero, the CA can issue only leaf certificates. There is no limit if the constraint isn't specified. Path length constraints cannot be updated.\n" }, "ruleType": { "type": "string", "description": "The type of rule, whether an issuance rule that defines the constraints which restricts the hierarchical name forms in certificates or number of levels of descendants that any CA in the certificate chain issues or an issuance expiry rule that governs how long the certificates and CAs issued by the CA are valid.\n" } }, "type": "object", "required": [ "certificateAuthorityMaxValidityDuration", "leafCertificateMaxValidityDuration", "nameConstraints", "pathLengthConstraint", "ruleType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRuleNameConstraint:getCertificateAuthorityCertificateAuthorityRuleNameConstraint": { "properties": { "excludedSubtrees": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree:getCertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree" }, "description": "A list that contains excluded (or prohibited) namespaces. If you have a name constraint with no permitted namespaces, you must specify at least one excluded namespace.\n" }, "permittedSubtrees": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree:getCertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree" }, "description": "A list that contains permitted namespaces. If you have a name constraint with no excluded namespaces, you must specify at least one permitted namespace.\n" } }, "type": "object", "required": [ "excludedSubtrees", "permittedSubtrees" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree:getCertificateAuthorityCertificateAuthorityRuleNameConstraintExcludedSubtree": { "properties": { "type": { "type": "string", "description": "The type of name constraint.\n" }, "value": { "type": "string", "description": "Name restrictions for the corresponding type of name constraint.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree:getCertificateAuthorityCertificateAuthorityRuleNameConstraintPermittedSubtree": { "properties": { "type": { "type": "string", "description": "The type of name constraint.\n" }, "value": { "type": "string", "description": "Name restrictions for the corresponding type of name constraint.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateRevocationListDetail:getCertificateAuthorityCertificateRevocationListDetail": { "properties": { "customFormattedUrls": { "type": "array", "items": { "type": "string" }, "description": "Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" }, "objectStorageConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCertificateRevocationListDetailObjectStorageConfig:getCertificateAuthorityCertificateRevocationListDetailObjectStorageConfig" }, "description": "The details of the Object Storage bucket configured to store the certificate revocation list (CRL).\n" } }, "type": "object", "required": [ "customFormattedUrls", "objectStorageConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCertificateRevocationListDetailObjectStorageConfig:getCertificateAuthorityCertificateRevocationListDetailObjectStorageConfig": { "properties": { "objectStorageBucketName": { "type": "string", "description": "The name of the bucket where the CRL is stored.\n" }, "objectStorageNamespace": { "type": "string", "description": "The tenancy of the bucket where the CRL is stored.\n" }, "objectStorageObjectNameFormat": { "type": "string", "description": "The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" } }, "type": "object", "required": [ "objectStorageBucketName", "objectStorageNamespace", "objectStorageObjectNameFormat" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCurrentVersion:getCertificateAuthorityCurrentVersion": { "properties": { "certificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA).\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing CA.\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCurrentVersionRevocationStatus:getCertificateAuthorityCurrentVersionRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this CA version.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the CA was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityCurrentVersionValidity:getCertificateAuthorityCurrentVersionValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.\n" }, "versionNumber": { "type": "string", "description": "The version number of the CA.\n" } }, "type": "object", "required": [ "certificateAuthorityId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCurrentVersionRevocationStatus:getCertificateAuthorityCurrentVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityCurrentVersionValidity:getCertificateAuthorityCurrentVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthoritySubject:getCertificateAuthoritySubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionRevocationStatus:getCertificateAuthorityVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionSubjectAlternativeName:getCertificateAuthorityVersionSubjectAlternativeName": { "properties": { "type": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionValidity:getCertificateAuthorityVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollection:getCertificateAuthorityVersionsCertificateAuthorityVersionCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItem:getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItem" }, "description": "A list of certificate authority version summary objects.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItem:getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItem": { "properties": { "certificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA).\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing CA.\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemRevocationStatus:getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this CA version.\n" }, "timeCreated": { "type": "string", "description": "A optional property indicating when the CA version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the CA version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemValidity:getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the CA version. When this value is not null, the name is unique across CA versions for a given CA.\n" }, "versionNumber": { "type": "string", "description": "A filter that returns only resources that match the specified version number. The default value is 0, which means that this filter is not applied.\n" } }, "type": "object", "required": [ "certificateAuthorityId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemRevocationStatus:getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemValidity:getCertificateAuthorityVersionsCertificateAuthorityVersionCollectionItemValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateAuthorityVersionsFilter:getCertificateAuthorityVersionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CertificatesManagement/getCertificateCertificateConfig:getCertificateCertificateConfig": { "properties": { "certChainPem": { "type": "string" }, "certificatePem": { "type": "string" }, "certificateProfileType": { "type": "string", "description": "The name of the profile used to create the certificate, which depends on the type of certificate you need.\n" }, "configType": { "type": "string", "description": "The origin of the certificate. It must be one of the supported types: MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA, ISSUED_BY_INTERNAL_CA, or IMPORTED.\n" }, "csrPem": { "type": "string" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA) that issued the certificate.\n" }, "keyAlgorithm": { "type": "string", "description": "The algorithm used to create key pairs.\n" }, "privateKeyPem": { "type": "string", "secret": true }, "privateKeyPemPassphrase": { "type": "string", "secret": true }, "signatureAlgorithm": { "type": "string", "description": "The algorithm used to sign the public key certificate.\n" }, "stage": { "type": "string" }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCertificateConfigSubjectAlternativeName:getCertificateCertificateConfigSubjectAlternativeName" }, "description": "A list of subject alternative names.\n" }, "subjects": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCertificateConfigSubject:getCertificateCertificateConfigSubject" }, "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCertificateConfigValidity:getCertificateCertificateConfigValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate.\n" } }, "type": "object", "required": [ "certChainPem", "certificatePem", "certificateProfileType", "configType", "csrPem", "issuerCertificateAuthorityId", "keyAlgorithm", "privateKeyPem", "privateKeyPemPassphrase", "signatureAlgorithm", "stage", "subjects", "subjectAlternativeNames", "validities", "versionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCertificateConfigSubject:getCertificateCertificateConfigSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCertificateConfigSubjectAlternativeName:getCertificateCertificateConfigSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCertificateConfigValidity:getCertificateCertificateConfigValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCertificateRevocationListDetail:getCertificateCertificateRevocationListDetail": { "properties": { "customFormattedUrls": { "type": "array", "items": { "type": "string" }, "description": "Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" }, "objectStorageConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCertificateRevocationListDetailObjectStorageConfig:getCertificateCertificateRevocationListDetailObjectStorageConfig" }, "description": "The details of the Object Storage bucket configured to store the certificate revocation list (CRL).\n" } }, "type": "object", "required": [ "customFormattedUrls", "objectStorageConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCertificateRevocationListDetailObjectStorageConfig:getCertificateCertificateRevocationListDetailObjectStorageConfig": { "properties": { "objectStorageBucketName": { "type": "string", "description": "The name of the bucket where the CRL is stored.\n" }, "objectStorageNamespace": { "type": "string", "description": "The tenancy of the bucket where the CRL is stored.\n" }, "objectStorageObjectNameFormat": { "type": "string", "description": "The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" } }, "type": "object", "required": [ "objectStorageBucketName", "objectStorageNamespace", "objectStorageObjectNameFormat" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCertificateRule:getCertificateCertificateRule": { "properties": { "advanceRenewalPeriod": { "type": "string", "description": "A property specifying the period of time, in days, before the certificate's targeted renewal that the process should occur. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "renewalInterval": { "type": "string", "description": "A property specifying how often, in days, a certificate should be renewed. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "ruleType": { "type": "string", "description": "The type of rule.\n" } }, "type": "object", "required": [ "advanceRenewalPeriod", "renewalInterval", "ruleType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCurrentVersion:getCertificateCurrentVersion": { "properties": { "certificateId": { "type": "string", "description": "The OCID of the certificate.\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing certificate authority (CA).\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCurrentVersionRevocationStatus:getCertificateCurrentVersionRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this certificate version.\n" }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCurrentVersionSubjectAlternativeName:getCertificateCurrentVersionSubjectAlternativeName" }, "description": "A list of subject alternative names.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the certificate was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateCurrentVersionValidity:getCertificateCurrentVersionValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate.\n" }, "versionNumber": { "type": "string", "description": "The version number of the certificate.\n" } }, "type": "object", "required": [ "certificateId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "subjectAlternativeNames", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCurrentVersionRevocationStatus:getCertificateCurrentVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCurrentVersionSubjectAlternativeName:getCertificateCurrentVersionSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateCurrentVersionValidity:getCertificateCurrentVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateSubject:getCertificateSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionRevocationStatus:getCertificateVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionSubjectAlternativeName:getCertificateVersionSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionValidity:getCertificateVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollection:getCertificateVersionsCertificateVersionCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItem:getCertificateVersionsCertificateVersionCollectionItem" }, "description": "A list of certificate version summary objects.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItem:getCertificateVersionsCertificateVersionCollectionItem": { "properties": { "certificateId": { "type": "string", "description": "The OCID of the certificate.\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing certificate authority (CA).\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItemRevocationStatus:getCertificateVersionsCertificateVersionCollectionItemRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "A unique certificate identifier used in certificate revocation tracking, formatted as octets. Example: `03 AC FC FA CC B3 CB 02 B8 F8 DE F5 85 E7 7B FF`\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this certificate version.\n" }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItemSubjectAlternativeName:getCertificateVersionsCertificateVersionCollectionItemSubjectAlternativeName" }, "description": "A list of subject alternative names.\n" }, "timeCreated": { "type": "string", "description": "A optional property indicating the time when the certificate version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItemValidity:getCertificateVersionsCertificateVersionCollectionItemValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate.\n" }, "versionNumber": { "type": "string", "description": "A filter that returns only resources that match the specified version number. The default value is 0, which means that this filter is not applied.\n" } }, "type": "object", "required": [ "certificateId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "subjectAlternativeNames", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItemRevocationStatus:getCertificateVersionsCertificateVersionCollectionItemRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItemSubjectAlternativeName:getCertificateVersionsCertificateVersionCollectionItemSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionsCertificateVersionCollectionItemValidity:getCertificateVersionsCertificateVersionCollectionItemValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificateVersionsFilter:getCertificateVersionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CertificatesManagement/getCertificatesCertificateCollection:getCertificatesCertificateCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItem:getCertificatesCertificateCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItem:getCertificatesCertificateCollectionItem": { "properties": { "certificateConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfig:getCertificatesCertificateCollectionItemCertificateConfig" } }, "certificateProfileType": { "type": "string", "description": "The name of the profile used to create the certificate, which depends on the type of certificate you need.\n" }, "certificateRevocationListDetails": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateRevocationListDetail:getCertificatesCertificateCollectionItemCertificateRevocationListDetail" }, "description": "The details of the certificate revocation list (CRL).\n" }, "certificateRules": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateRule:getCertificatesCertificateCollectionItemCertificateRule" }, "description": "A list of rules that control how the certificate is used and managed.\n" }, "compartmentId": { "type": "string", "description": "A filter that returns only resources that match the given compartment OCID.\n" }, "configType": { "type": "string", "description": "The origin of the certificate. It must be one of the supported types: MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA, ISSUED_BY_INTERNAL_CA, or IMPORTED.\n" }, "currentVersionNumber": { "type": "string" }, "currentVersions": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersion:getCertificatesCertificateCollectionItemCurrentVersion" }, "description": "The details of the certificate version. This object does not contain the certificate contents.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "A brief description of the certificate. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the certificate.\n" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs.\n" }, "keyAlgorithm": { "type": "string", "description": "The algorithm used to create key pairs.\n" }, "lifecycleDetails": { "type": "string", "description": "Additional information about the current lifecycle state of the certificate.\n" }, "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "signatureAlgorithm": { "type": "string", "description": "The algorithm used to sign the public key certificate.\n" }, "state": { "type": "string", "description": "A filter that returns only resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "subjects": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemSubject:getCertificatesCertificateCollectionItemSubject" }, "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the certificate was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "certificateConfigs", "certificateProfileType", "certificateRevocationListDetails", "certificateRules", "compartmentId", "configType", "currentVersions", "currentVersionNumber", "definedTags", "description", "freeformTags", "id", "issuerCertificateAuthorityId", "keyAlgorithm", "lifecycleDetails", "name", "signatureAlgorithm", "state", "subjects", "timeCreated", "timeOfDeletion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfig:getCertificatesCertificateCollectionItemCertificateConfig": { "properties": { "certChainPem": { "type": "string" }, "certificatePem": { "type": "string" }, "certificateProfileType": { "type": "string", "description": "The name of the profile used to create the certificate, which depends on the type of certificate you need.\n" }, "configType": { "type": "string", "description": "The origin of the certificate. It must be one of the supported types: MANAGED_EXTERNALLY_ISSUED_BY_INTERNAL_CA, ISSUED_BY_INTERNAL_CA, or IMPORTED.\n" }, "csrPem": { "type": "string" }, "issuerCertificateAuthorityId": { "type": "string", "description": "The OCID of the certificate authority (CA). If the parameter is set to null, the service lists all CAs.\n" }, "keyAlgorithm": { "type": "string", "description": "The algorithm used to create key pairs.\n" }, "privateKeyPem": { "type": "string", "secret": true }, "privateKeyPemPassphrase": { "type": "string", "secret": true }, "signatureAlgorithm": { "type": "string", "description": "The algorithm used to sign the public key certificate.\n" }, "stage": { "type": "string" }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfigSubjectAlternativeName:getCertificatesCertificateCollectionItemCertificateConfigSubjectAlternativeName" }, "description": "A list of subject alternative names.\n" }, "subjects": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfigSubject:getCertificatesCertificateCollectionItemCertificateConfigSubject" }, "description": "The subject of the certificate, which is a distinguished name that identifies the entity that owns the public key in the certificate.\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfigValidity:getCertificatesCertificateCollectionItemCertificateConfigValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate.\n" } }, "type": "object", "required": [ "certChainPem", "certificatePem", "certificateProfileType", "configType", "csrPem", "issuerCertificateAuthorityId", "keyAlgorithm", "privateKeyPem", "privateKeyPemPassphrase", "signatureAlgorithm", "stage", "subjects", "subjectAlternativeNames", "validities", "versionName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfigSubject:getCertificatesCertificateCollectionItemCertificateConfigSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfigSubjectAlternativeName:getCertificatesCertificateCollectionItemCertificateConfigSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateConfigValidity:getCertificatesCertificateCollectionItemCertificateConfigValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateRevocationListDetail:getCertificatesCertificateCollectionItemCertificateRevocationListDetail": { "properties": { "customFormattedUrls": { "type": "array", "items": { "type": "string" }, "description": "Optional CRL access points, expressed using a format where the version number of the issuing CA is inserted wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" }, "objectStorageConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateRevocationListDetailObjectStorageConfig:getCertificatesCertificateCollectionItemCertificateRevocationListDetailObjectStorageConfig" }, "description": "The details of the Object Storage bucket configured to store the certificate revocation list (CRL).\n" } }, "type": "object", "required": [ "customFormattedUrls", "objectStorageConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateRevocationListDetailObjectStorageConfig:getCertificatesCertificateCollectionItemCertificateRevocationListDetailObjectStorageConfig": { "properties": { "objectStorageBucketName": { "type": "string", "description": "The name of the bucket where the CRL is stored.\n" }, "objectStorageNamespace": { "type": "string", "description": "The tenancy of the bucket where the CRL is stored.\n" }, "objectStorageObjectNameFormat": { "type": "string", "description": "The object name in the bucket where the CRL is stored, expressed using a format where the version number of the issuing CA is inserted as part of the Object Storage object name wherever you include a pair of curly braces. This versioning scheme helps avoid collisions when new CA versions are created. For example, myCrlFileIssuedFromCAVersion{}.crl becomes myCrlFileIssuedFromCAVersion2.crl for CA version 2.\n" } }, "type": "object", "required": [ "objectStorageBucketName", "objectStorageNamespace", "objectStorageObjectNameFormat" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCertificateRule:getCertificatesCertificateCollectionItemCertificateRule": { "properties": { "advanceRenewalPeriod": { "type": "string", "description": "A property specifying the period of time, in days, before the certificate's targeted renewal that the process should occur. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "renewalInterval": { "type": "string", "description": "A property specifying how often, in days, a certificate should be renewed. Expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601#Time_intervals) format.\n" }, "ruleType": { "type": "string", "description": "The type of rule.\n" } }, "type": "object", "required": [ "advanceRenewalPeriod", "renewalInterval", "ruleType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersion:getCertificatesCertificateCollectionItemCurrentVersion": { "properties": { "certificateId": { "type": "string", "description": "The OCID of the certificate. If the parameter is set to null, the service lists all certificates.\n" }, "issuerCaVersionNumber": { "type": "string", "description": "The version number of the issuing certificate authority (CA).\n" }, "revocationStatuses": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersionRevocationStatus:getCertificatesCertificateCollectionItemCurrentVersionRevocationStatus" }, "description": "The current revocation status of the entity.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stages": { "type": "array", "items": { "type": "string" }, "description": "A list of rotation states for this certificate version.\n" }, "subjectAlternativeNames": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersionSubjectAlternativeName:getCertificatesCertificateCollectionItemCurrentVersionSubjectAlternativeName" }, "description": "A list of subject alternative names.\n" }, "timeCreated": { "type": "string", "description": "A property indicating when the certificate was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfDeletion": { "type": "string", "description": "An optional property indicating when to delete the certificate version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "validities": { "type": "array", "items": { "$ref": "#/types/oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersionValidity:getCertificatesCertificateCollectionItemCurrentVersionValidity" }, "description": "An object that describes a period of time during which an entity is valid. If this is not provided when you create a certificate, the validity of the issuing CA is used.\n" }, "versionName": { "type": "string", "description": "The name of the certificate version. When the value is not null, a name is unique across versions of a given certificate.\n" }, "versionNumber": { "type": "string", "description": "The version number of the certificate.\n" } }, "type": "object", "required": [ "certificateId", "issuerCaVersionNumber", "revocationStatuses", "serialNumber", "stages", "subjectAlternativeNames", "timeCreated", "timeOfDeletion", "validities", "versionName", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersionRevocationStatus:getCertificatesCertificateCollectionItemCurrentVersionRevocationStatus": { "properties": { "revocationReason": { "type": "string", "description": "The reason the certificate or certificate authority (CA) was revoked.\n" }, "timeOfRevocation": { "type": "string", "description": "The time when the entity was revoked, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "revocationReason", "timeOfRevocation" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersionSubjectAlternativeName:getCertificatesCertificateCollectionItemCurrentVersionSubjectAlternativeName": { "properties": { "type": { "type": "string", "description": "The subject alternative name type. Currently only DNS domain or host names and IP addresses are supported.\n" }, "value": { "type": "string", "description": "The subject alternative name.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemCurrentVersionValidity:getCertificatesCertificateCollectionItemCurrentVersionValidity": { "properties": { "timeOfValidityNotAfter": { "type": "string", "description": "The date on which the certificate validity period ends, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" }, "timeOfValidityNotBefore": { "type": "string", "description": "The date on which the certificate validity period begins, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2019-04-03T21:10:29.600Z`\n" } }, "type": "object", "required": [ "timeOfValidityNotAfter", "timeOfValidityNotBefore" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesCertificateCollectionItemSubject:getCertificatesCertificateCollectionItemSubject": { "properties": { "commonName": { "type": "string", "description": "Common name or fully-qualified domain name (RDN CN).\n" }, "country": { "type": "string", "description": "Country name (RDN C).\n" }, "distinguishedNameQualifier": { "type": "string", "description": "Distinguished name qualifier(RDN DNQ).\n" }, "domainComponent": { "type": "string", "description": "Domain component (RDN DC).\n" }, "generationQualifier": { "type": "string", "description": "Personal generational qualifier (for example, Sr., Jr. 3rd, or IV).\n" }, "givenName": { "type": "string", "description": "Personal given name (RDN G or GN).\n" }, "initials": { "type": "string", "description": "Personal initials.\n" }, "localityName": { "type": "string", "description": "Locality (RDN L).\n" }, "organization": { "type": "string", "description": "Organization (RDN O).\n" }, "organizationalUnit": { "type": "string", "description": "Organizational unit (RDN OU).\n" }, "pseudonym": { "type": "string", "description": "Subject pseudonym.\n" }, "serialNumber": { "type": "string", "description": "Unique subject identifier, which is not the same as the certificate serial number (RDN SERIALNUMBER).\n" }, "stateOrProvinceName": { "type": "string", "description": "State or province name (RDN ST or S).\n" }, "street": { "type": "string", "description": "Street address (RDN STREET).\n" }, "surname": { "type": "string", "description": "Personal surname (RDN SN).\n" }, "title": { "type": "string", "description": "Title (RDN T or TITLE).\n" }, "userId": { "type": "string", "description": "User ID (RDN UID).\n" } }, "type": "object", "required": [ "commonName", "country", "distinguishedNameQualifier", "domainComponent", "generationQualifier", "givenName", "initials", "localityName", "organization", "organizationalUnit", "pseudonym", "serialNumber", "stateOrProvinceName", "street", "surname", "title", "userId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CertificatesManagement/getCertificatesFilter:getCertificatesFilter": { "properties": { "name": { "type": "string", "description": "A filter that returns only resources that match the specified name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/AgentPluginList:AgentPluginList": { "properties": { "agentId": { "type": "string", "description": "Agent identifier.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "name": { "type": "string", "description": "Plugin identifier, which can be renamed.\n" }, "pluginVersion": { "type": "string", "description": "Plugin version.\n" }, "state": { "type": "string", "description": "The current state of the Agent.\n" }, "timeCreated": { "type": "string", "description": "The time when the Agent was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the Agent was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentId", "definedTags", "freeformTags", "lifecycleDetails", "name", "pluginVersion", "state", "timeCreated", "timeUpdated" ] } } }, "oci:CloudBridge/AssetAttachedEbsVolumesCost:AssetAttachedEbsVolumesCost": { "properties": { "amount": { "type": "number", "description": "(Updatable) Monthly costs for maintenance of this asset.\n" }, "currencyCode": { "type": "string", "description": "(Updatable) Currency code\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "amount", "currencyCode" ] } } }, "oci:CloudBridge/AssetAwsEbs:AssetAwsEbs": { "properties": { "attachments": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEbsAttachment:AssetAwsEbsAttachment" }, "description": "(Updatable) Information about the volume attachments.\n" }, "availabilityZone": { "type": "string", "description": "(Updatable) The Availability Zone for the volume.\n" }, "iops": { "type": "integer", "description": "(Updatable) The number of I/O operations per second.\n" }, "isEncrypted": { "type": "boolean", "description": "(Updatable) Indicates whether the volume is encrypted.\n" }, "isMultiAttachEnabled": { "type": "boolean", "description": "(Updatable) Indicates whether Amazon EBS Multi-Attach is enabled.\n" }, "sizeInGiBs": { "type": "integer", "description": "(Updatable) The size of the volume, in GiBs.\n" }, "status": { "type": "string", "description": "(Updatable) The volume state.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEbsTag:AssetAwsEbsTag" }, "description": "(Updatable) Any tags assigned to the volume.\n" }, "throughput": { "type": "integer", "description": "(Updatable) The throughput that the volume supports, in MiB/s.\n" }, "volumeKey": { "type": "string", "description": "(Updatable) The ID of the volume.\n" }, "volumeType": { "type": "string", "description": "(Updatable) The volume type.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachments", "availabilityZone", "iops", "isEncrypted", "isMultiAttachEnabled", "sizeInGiBs", "status", "tags", "throughput", "volumeKey", "volumeType" ] } } }, "oci:CloudBridge/AssetAwsEbsAttachment:AssetAwsEbsAttachment": { "properties": { "device": { "type": "string", "description": "(Updatable) The device name.\n" }, "instanceKey": { "type": "string", "description": "(Updatable) The ID of the instance.\n" }, "isDeleteOnTermination": { "type": "boolean", "description": "(Updatable) Indicates whether the EBS volume is deleted on instance termination.\n" }, "status": { "type": "string", "description": "(Updatable) The attachment state of the volume.\n" }, "volumeKey": { "type": "string", "description": "(Updatable) The ID of the volume.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "device", "instanceKey", "isDeleteOnTermination", "status", "volumeKey" ] } } }, "oci:CloudBridge/AssetAwsEbsTag:AssetAwsEbsTag": { "properties": { "key": { "type": "string", "description": "(Updatable) The key of the tag.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:CloudBridge/AssetAwsEc2:AssetAwsEc2": { "properties": { "architecture": { "type": "string", "description": "(Updatable) The architecture of the image.\n" }, "areElasticInferenceAcceleratorsPresent": { "type": "boolean", "description": "(Updatable) Indicates if the elastic inference accelerators attached to an instance\n" }, "bootMode": { "type": "string", "description": "(Updatable) The boot mode of the instance.\n" }, "capacityReservationKey": { "type": "string", "description": "(Updatable) The ID of the Capacity Reservation.\n" }, "imageKey": { "type": "string", "description": "(Updatable) The ID of the AMI used to launch the instance.\n" }, "instanceKey": { "type": "string", "description": "(Updatable) The ID of the instance.\n" }, "instanceLifecycle": { "type": "string", "description": "(Updatable) Indicates whether this is a Spot Instance or a Scheduled Instance.\n" }, "instanceType": { "type": "string", "description": "(Updatable) The instance type.\n" }, "ipAddress": { "type": "string", "description": "(Updatable) The public IPv4 address, or the Carrier IP address assigned to the instance.\n" }, "ipv6address": { "type": "string", "description": "(Updatable) The IPv6 address assigned to the instance.\n" }, "isEnclaveOptions": { "type": "boolean", "description": "(Updatable) Indicates whether the instance is enabled for AWS Nitro Enclaves.\n" }, "isHibernationOptions": { "type": "boolean", "description": "(Updatable) Indicates whether the instance is enabled for hibernation.\n" }, "isSourceDestCheck": { "type": "boolean", "description": "(Updatable) Indicates whether source/destination checking is enabled.\n" }, "isSpotInstance": { "type": "boolean", "description": "(Updatable) If the request is a Spot Instance request, this value will be true.\n" }, "kernelKey": { "type": "string", "description": "(Updatable) The kernel associated with this instance, if applicable.\n" }, "licenses": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The license configurations for the instance.\n" }, "maintenanceOptions": { "type": "string", "description": "(Updatable) Provides information on the recovery and maintenance options of your instance.\n" }, "monitoring": { "type": "string", "description": "(Updatable) The monitoring for the instance.\n" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2NetworkInterface:AssetAwsEc2NetworkInterface" }, "description": "(Updatable) The network interfaces for the instance.\n" }, "placement": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2Placement:AssetAwsEc2Placement", "description": "(Updatable) Describes the placement of an instance.\n" }, "privateDnsName": { "type": "string", "description": "(Updatable) (IPv4 only) The private DNS hostname name assigned to the instance.\n" }, "privateIpAddress": { "type": "string", "description": "(Updatable) The private IPv4 address assigned to the instance.\n" }, "rootDeviceName": { "type": "string", "description": "(Updatable) The device name of the root device volume.\n" }, "rootDeviceType": { "type": "string", "description": "(Updatable) The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.\n" }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2SecurityGroup:AssetAwsEc2SecurityGroup" }, "description": "(Updatable) The security groups for the instance.\n" }, "sriovNetSupport": { "type": "string", "description": "(Updatable) Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.\n" }, "state": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2State:AssetAwsEc2State", "description": "(Updatable) Describes the current state of an instance.\n" }, "subnetKey": { "type": "string", "description": "(Updatable) EC2-VPC The ID of the subnet in which the instance is running.\n" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2Tag:AssetAwsEc2Tag" }, "description": "(Updatable) Any tags assigned to the instance.\n" }, "timeLaunch": { "type": "string", "description": "(Updatable) The time the instance was launched.\n" }, "tpmSupport": { "type": "string", "description": "(Updatable) If the instance is configured for NitroTPM support, the value is v2.0.\n" }, "virtualizationType": { "type": "string", "description": "(Updatable) The virtualization type of the instance.\n" }, "vpcKey": { "type": "string", "description": "(Updatable) EC2-VPC The ID of the VPC in which the instance is running.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "architecture", "areElasticInferenceAcceleratorsPresent", "bootMode", "capacityReservationKey", "imageKey", "instanceKey", "instanceLifecycle", "instanceType", "ipAddress", "ipv6address", "isEnclaveOptions", "isHibernationOptions", "isSourceDestCheck", "isSpotInstance", "kernelKey", "licenses", "maintenanceOptions", "monitoring", "networkInterfaces", "placement", "privateDnsName", "privateIpAddress", "rootDeviceName", "rootDeviceType", "securityGroups", "sriovNetSupport", "state", "subnetKey", "tags", "timeLaunch", "tpmSupport", "virtualizationType", "vpcKey" ] } } }, "oci:CloudBridge/AssetAwsEc2NetworkInterface:AssetAwsEc2NetworkInterface": { "properties": { "association": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2NetworkInterfaceAssociation:AssetAwsEc2NetworkInterfaceAssociation", "description": "(Updatable) Describes association information for an Elastic IP address (IPv4).\n" }, "attachment": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2NetworkInterfaceAttachment:AssetAwsEc2NetworkInterfaceAttachment", "description": "(Updatable) Describes a network interface attachment.\n" }, "description": { "type": "string", "description": "(Updatable) The description.\n" }, "interfaceType": { "type": "string", "description": "(Updatable) The type of network interface.\n" }, "ipv4prefixes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The IPv4 delegated prefixes that are assigned to the network interface.\n" }, "ipv6addresses": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The IPv6 addresses associated with the network interface.\n" }, "ipv6prefixes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The IPv6 delegated prefixes that are assigned to the network interface.\n" }, "isSourceDestCheck": { "type": "boolean", "description": "(Updatable) Indicates whether source/destination checking is enabled.\n" }, "macAddress": { "type": "string", "description": "(Updatable) The MAC address.\n" }, "networkInterfaceKey": { "type": "string", "description": "(Updatable) The ID of the network interface.\n" }, "ownerKey": { "type": "string", "description": "(Updatable) The ID of the AWS account that created the network interface.\n" }, "privateIpAddresses": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2NetworkInterfacePrivateIpAddress:AssetAwsEc2NetworkInterfacePrivateIpAddress" }, "description": "(Updatable) The private IPv4 addresses associated with the network interface.\n" }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2NetworkInterfaceSecurityGroup:AssetAwsEc2NetworkInterfaceSecurityGroup" }, "description": "(Updatable) The security groups.\n" }, "status": { "type": "string", "description": "(Updatable) The status of the network interface.\n" }, "subnetKey": { "type": "string", "description": "(Updatable) The ID of the subnet.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "association", "attachment", "description", "interfaceType", "ipv4prefixes", "ipv6addresses", "ipv6prefixes", "isSourceDestCheck", "macAddress", "networkInterfaceKey", "ownerKey", "privateIpAddresses", "securityGroups", "status", "subnetKey" ] } } }, "oci:CloudBridge/AssetAwsEc2NetworkInterfaceAssociation:AssetAwsEc2NetworkInterfaceAssociation": { "properties": { "carrierIp": { "type": "string", "description": "(Updatable) The carrier IP address associated with the network interface.\n" }, "customerOwnedIp": { "type": "string", "description": "(Updatable) The customer-owned IP address associated with the network interface.\n" }, "ipOwnerKey": { "type": "string", "description": "(Updatable) The ID of the owner of the Elastic IP address.\n" }, "publicDnsName": { "type": "string", "description": "(Updatable) The public DNS name.\n" }, "publicIp": { "type": "string", "description": "(Updatable) The public IP address or Elastic IP address bound to the network interface.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "carrierIp", "customerOwnedIp", "ipOwnerKey", "publicDnsName", "publicIp" ] } } }, "oci:CloudBridge/AssetAwsEc2NetworkInterfaceAttachment:AssetAwsEc2NetworkInterfaceAttachment": { "properties": { "attachmentKey": { "type": "string", "description": "(Updatable) The ID of the network interface attachment.\n" }, "deviceIndex": { "type": "integer", "description": "(Updatable) The index of the device on the instance for the network interface attachment.\n" }, "isDeleteOnTermination": { "type": "boolean", "description": "(Updatable) Indicates whether the network interface is deleted when the instance is terminated.\n" }, "networkCardIndex": { "type": "integer", "description": "(Updatable) The index of the network card.\n" }, "status": { "type": "string", "description": "(Updatable) The attachment state.\n" }, "timeAttach": { "type": "string", "description": "(Updatable) The timestamp when the attachment initiated.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachmentKey", "deviceIndex", "isDeleteOnTermination", "networkCardIndex", "status", "timeAttach" ] } } }, "oci:CloudBridge/AssetAwsEc2NetworkInterfacePrivateIpAddress:AssetAwsEc2NetworkInterfacePrivateIpAddress": { "properties": { "association": { "$ref": "#/types/oci:CloudBridge/AssetAwsEc2NetworkInterfacePrivateIpAddressAssociation:AssetAwsEc2NetworkInterfacePrivateIpAddressAssociation", "description": "(Updatable) Describes association information for an Elastic IP address (IPv4).\n" }, "isPrimary": { "type": "boolean", "description": "(Updatable) Indicates whether this IPv4 address is the primary private IP address of the network interface.\n" }, "privateDnsName": { "type": "string", "description": "(Updatable) The private IPv4 DNS name.\n" }, "privateIpAddress": { "type": "string", "description": "(Updatable) The private IPv4 address of the network interface.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "association", "isPrimary", "privateDnsName", "privateIpAddress" ] } } }, "oci:CloudBridge/AssetAwsEc2NetworkInterfacePrivateIpAddressAssociation:AssetAwsEc2NetworkInterfacePrivateIpAddressAssociation": { "properties": { "carrierIp": { "type": "string", "description": "(Updatable) The carrier IP address associated with the network interface.\n" }, "customerOwnedIp": { "type": "string", "description": "(Updatable) The customer-owned IP address associated with the network interface.\n" }, "ipOwnerKey": { "type": "string", "description": "(Updatable) The ID of the owner of the Elastic IP address.\n" }, "publicDnsName": { "type": "string", "description": "(Updatable) The public DNS name.\n" }, "publicIp": { "type": "string", "description": "(Updatable) The public IP address or Elastic IP address bound to the network interface.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "carrierIp", "customerOwnedIp", "ipOwnerKey", "publicDnsName", "publicIp" ] } } }, "oci:CloudBridge/AssetAwsEc2NetworkInterfaceSecurityGroup:AssetAwsEc2NetworkInterfaceSecurityGroup": { "properties": { "groupKey": { "type": "string", "description": "(Updatable) The ID of the security group.\n" }, "groupName": { "type": "string", "description": "(Updatable) The name of the security group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "groupKey", "groupName" ] } } }, "oci:CloudBridge/AssetAwsEc2Placement:AssetAwsEc2Placement": { "properties": { "affinity": { "type": "string", "description": "(Updatable) The affinity setting for the instance on the Dedicated Host.\n" }, "availabilityZone": { "type": "string", "description": "(Updatable) The Availability Zone of the instance.\n" }, "groupName": { "type": "string", "description": "(Updatable) The name of the placement group the instance is in.\n" }, "hostKey": { "type": "string", "description": "(Updatable) The ID of the Dedicated Host on which the instance resides.\n" }, "hostResourceGroupArn": { "type": "string", "description": "(Updatable) The ARN of the host resource group in which to launch the instances.\n" }, "partitionNumber": { "type": "integer", "description": "(Updatable) The number of the partition that the instance is in.\n" }, "spreadDomain": { "type": "string", "description": "(Updatable) Reserved for future use.\n" }, "tenancy": { "type": "string", "description": "(Updatable) The tenancy of the instance (if the instance is running in a VPC).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "affinity", "availabilityZone", "groupName", "hostKey", "hostResourceGroupArn", "partitionNumber", "spreadDomain", "tenancy" ] } } }, "oci:CloudBridge/AssetAwsEc2SecurityGroup:AssetAwsEc2SecurityGroup": { "properties": { "groupKey": { "type": "string", "description": "(Updatable) The ID of the security group.\n" }, "groupName": { "type": "string", "description": "(Updatable) The name of the security group.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "groupKey", "groupName" ] } } }, "oci:CloudBridge/AssetAwsEc2State:AssetAwsEc2State": { "properties": { "code": { "type": "integer", "description": "(Updatable) The state of the instance as a 16-bit unsigned integer.\n" }, "name": { "type": "string", "description": "(Updatable) The current state of the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "code", "name" ] } } }, "oci:CloudBridge/AssetAwsEc2Tag:AssetAwsEc2Tag": { "properties": { "key": { "type": "string", "description": "(Updatable) The key of the tag.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the tag.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:CloudBridge/AssetAwsEc2cost:AssetAwsEc2cost": { "properties": { "amount": { "type": "number", "description": "(Updatable) Monthly costs for maintenance of this asset.\n" }, "currencyCode": { "type": "string", "description": "(Updatable) Currency code\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "amount", "currencyCode" ] } } }, "oci:CloudBridge/AssetCompute:AssetCompute": { "properties": { "connectedNetworks": { "type": "integer", "description": "(Updatable) Number of connected networks.\n" }, "coresCount": { "type": "integer", "description": "(Updatable) Number of CPUs.\n" }, "cpuModel": { "type": "string", "description": "(Updatable) CPU model name.\n" }, "description": { "type": "string", "description": "(Updatable) Information about the asset.\n" }, "disks": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetComputeDisk:AssetComputeDisk" }, "description": "(Updatable) Lists the set of disks belonging to the virtual machine. This list is unordered.\n" }, "disksCount": { "type": "integer", "description": "(Updatable) Number of disks.\n" }, "dnsName": { "type": "string", "description": "(Updatable) Fully Qualified DNS Name.\n" }, "firmware": { "type": "string", "description": "(Updatable) Information about firmware type for this virtual machine.\n" }, "gpuDevices": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetComputeGpuDevice:AssetComputeGpuDevice" }, "description": "(Updatable) List of GPU devices attached to a virtual machine.\n" }, "gpuDevicesCount": { "type": "integer", "description": "(Updatable) Number of GPU devices.\n" }, "guestState": { "type": "string", "description": "(Updatable) Guest state.\n" }, "hardwareVersion": { "type": "string", "description": "(Updatable) Hardware version.\n" }, "hostName": { "type": "string", "description": "(Updatable) Host name of the VM.\n" }, "isPmemEnabled": { "type": "boolean", "description": "(Updatable) Whether Pmem is enabled. Decides if NVDIMMs are used as a permanent memory.\n" }, "isTpmEnabled": { "type": "boolean", "description": "(Updatable) Whether Trusted Platform Module (TPM) is enabled.\n" }, "latencySensitivity": { "type": "string", "description": "(Updatable) Latency sensitivity.\n" }, "memoryInMbs": { "type": "string", "description": "(Updatable) Memory size in MBs.\n" }, "nics": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetComputeNic:AssetComputeNic" }, "description": "(Updatable) List of network ethernet cards attached to a virtual machine.\n" }, "nicsCount": { "type": "integer", "description": "(Updatable) Number of network ethernet cards.\n" }, "nvdimmController": { "$ref": "#/types/oci:CloudBridge/AssetComputeNvdimmController:AssetComputeNvdimmController", "description": "(Updatable) The asset's NVDIMM configuration.\n" }, "nvdimms": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetComputeNvdimm:AssetComputeNvdimm" }, "description": "(Updatable) The properties of the NVDIMMs attached to a virtual machine.\n" }, "operatingSystem": { "type": "string", "description": "(Updatable) Operating system.\n" }, "operatingSystemVersion": { "type": "string", "description": "(Updatable) Operating system version.\n" }, "pmemInMbs": { "type": "string", "description": "(Updatable) Pmem size in MBs.\n" }, "powerState": { "type": "string", "description": "(Updatable) The current power state of the virtual machine.\n" }, "primaryIp": { "type": "string", "description": "(Updatable) Primary IP address of the compute instance.\n" }, "scsiController": { "$ref": "#/types/oci:CloudBridge/AssetComputeScsiController:AssetComputeScsiController", "description": "(Updatable) The assets SCSI controller.\n" }, "storageProvisionedInMbs": { "type": "string", "description": "(Updatable) Provision storage size in MBs.\n" }, "threadsPerCoreCount": { "type": "integer", "description": "(Updatable) Number of threads per core.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "connectedNetworks", "coresCount", "cpuModel", "description", "disks", "disksCount", "dnsName", "firmware", "gpuDevices", "gpuDevicesCount", "guestState", "hardwareVersion", "hostName", "isPmemEnabled", "isTpmEnabled", "latencySensitivity", "memoryInMbs", "nics", "nicsCount", "nvdimmController", "nvdimms", "operatingSystem", "operatingSystemVersion", "pmemInMbs", "powerState", "primaryIp", "scsiController", "storageProvisionedInMbs", "threadsPerCoreCount" ] } } }, "oci:CloudBridge/AssetComputeDisk:AssetComputeDisk": { "properties": { "bootOrder": { "type": "integer", "description": "(Updatable) Order of boot volumes.\n" }, "isCbtEnabled": { "type": "boolean", "description": "(Updatable) Indicates that CBT (change disk tracking) is enabled for this virtual disk.\n" }, "location": { "type": "string", "description": "(Updatable) Location of the boot/data volume.\n" }, "name": { "type": "string", "description": "(Updatable) Disk name.\n" }, "persistentMode": { "type": "string", "description": "(Updatable) The disk persistent mode.\n" }, "sizeInMbs": { "type": "string", "description": "(Updatable) The size of the volume in MBs.\n" }, "uuid": { "type": "string", "description": "(Updatable) Disk UUID for the virtual disk, if available.\n" }, "uuidLun": { "type": "string", "description": "(Updatable) Disk UUID LUN for the virtual disk, if available.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootOrder", "isCbtEnabled", "location", "name", "persistentMode", "sizeInMbs", "uuid", "uuidLun" ] } } }, "oci:CloudBridge/AssetComputeGpuDevice:AssetComputeGpuDevice": { "properties": { "coresCount": { "type": "integer", "description": "(Updatable) Number of GPU cores.\n" }, "description": { "type": "string", "description": "(Updatable) GPU device description.\n" }, "manufacturer": { "type": "string", "description": "(Updatable) The manufacturer of GPU.\n" }, "memoryInMbs": { "type": "string", "description": "(Updatable) GPU memory size in MBs.\n" }, "name": { "type": "string", "description": "(Updatable) GPU device name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "coresCount", "description", "manufacturer", "memoryInMbs", "name" ] } } }, "oci:CloudBridge/AssetComputeNic:AssetComputeNic": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of IP addresses.\n" }, "label": { "type": "string", "description": "(Updatable) Provides a label and summary information for the device.\n" }, "macAddress": { "type": "string", "description": "(Updatable) Mac address of the VM.\n" }, "macAddressType": { "type": "string", "description": "(Updatable) Mac address type.\n" }, "networkName": { "type": "string", "description": "(Updatable) Network name.\n" }, "switchName": { "type": "string", "description": "(Updatable) Switch name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipAddresses", "label", "macAddress", "macAddressType", "networkName", "switchName" ] } } }, "oci:CloudBridge/AssetComputeNvdimm:AssetComputeNvdimm": { "properties": { "controllerKey": { "type": "integer", "description": "(Updatable) Controller key.\n" }, "label": { "type": "string", "description": "(Updatable) Provides a label and summary information for the device.\n" }, "unitNumber": { "type": "integer", "description": "(Updatable) The unit number of NVDIMM.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "controllerKey", "label", "unitNumber" ] } } }, "oci:CloudBridge/AssetComputeNvdimmController:AssetComputeNvdimmController": { "properties": { "busNumber": { "type": "integer", "description": "(Updatable) Bus number.\n" }, "label": { "type": "string", "description": "(Updatable) Provides a label and summary information for the device.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "busNumber", "label" ] } } }, "oci:CloudBridge/AssetComputeScsiController:AssetComputeScsiController": { "properties": { "label": { "type": "string", "description": "(Updatable) Provides a label and summary information for the device.\n" }, "sharedBus": { "type": "string", "description": "(Updatable) Shared bus.\n" }, "unitNumber": { "type": "integer", "description": "(Updatable) The unit number of the SCSI controller.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "label", "sharedBus", "unitNumber" ] } } }, "oci:CloudBridge/AssetSourceDiscoveryCredentials:AssetSourceDiscoveryCredentials": { "properties": { "secretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret in a vault. If the type of the credentials is `BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ \"username\": \"\u003cUser\u003e\", \"password\": \"example-password\" }`. If the type of the credentials is `API_KEY`, the secret must contain the accessKeyId and secretAccessKey in JSON format, which is in the form of `{ \"accessKeyId\": \"\u003cAccessKey\u003e\", \"secretAccessKey\": \"\u003cAccessKeyValue\u003e\" }`.\n" }, "type": { "type": "string", "description": "(Updatable) Authentication type\n" } }, "type": "object", "required": [ "secretId", "type" ] }, "oci:CloudBridge/AssetSourceReplicationCredentials:AssetSourceReplicationCredentials": { "properties": { "secretId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret in a vault. If the type of the credentials is `BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ \"username\": \"\u003cUser\u003e\", \"password\": \"example-password\" }`. If the type of the credentials is `API_KEY`, the secret must contain the accessKeyId and secretAccessKey in JSON format, which is in the form of `{ \"accessKeyId\": \"\u003cAccessKey\u003e\", \"secretAccessKey\": \"\u003cAccessKeyValue\u003e\" }`.\n" }, "type": { "type": "string", "description": "(Updatable) Authentication type\n" } }, "type": "object", "required": [ "secretId", "type" ] }, "oci:CloudBridge/AssetVm:AssetVm": { "properties": { "hypervisorHost": { "type": "string", "description": "(Updatable) Host name/IP address of VM on which the host is running.\n" }, "hypervisorVendor": { "type": "string", "description": "(Updatable) Hypervisor vendor.\n" }, "hypervisorVersion": { "type": "string", "description": "(Updatable) Hypervisor version.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "hypervisorHost", "hypervisorVendor", "hypervisorVersion" ] } } }, "oci:CloudBridge/AssetVmwareVcenter:AssetVmwareVcenter": { "properties": { "dataCenter": { "type": "string", "description": "(Updatable) Data center name.\n" }, "vcenterKey": { "type": "string", "description": "(Updatable) vCenter unique key.\n" }, "vcenterVersion": { "type": "string", "description": "(Updatable) Dot-separated version string.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dataCenter", "vcenterKey", "vcenterVersion" ] } } }, "oci:CloudBridge/AssetVmwareVm:AssetVmwareVm": { "properties": { "cluster": { "type": "string", "description": "(Updatable) Cluster name.\n" }, "customerFields": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) Customer fields.\n" }, "customerTags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/AssetVmwareVmCustomerTag:AssetVmwareVmCustomerTag" }, "description": "(Updatable) Customer defined tags.\n" }, "faultToleranceBandwidth": { "type": "integer", "description": "(Updatable) Fault tolerance bandwidth.\n" }, "faultToleranceSecondaryLatency": { "type": "integer", "description": "(Updatable) Fault tolerance to secondary latency.\n" }, "faultToleranceState": { "type": "string", "description": "(Updatable) Fault tolerance state.\n" }, "instanceUuid": { "type": "string", "description": "(Updatable) vCenter-specific identifier of the virtual machine.\n" }, "isDisksCbtEnabled": { "type": "boolean", "description": "(Updatable) Indicates that change tracking is supported for virtual disks of this virtual machine. However, even if change tracking is supported, it might not be available for all disks of the virtual machine.\n" }, "isDisksUuidEnabled": { "type": "boolean", "description": "(Updatable) Whether changed block tracking for this VM's disk is active.\n" }, "path": { "type": "string", "description": "(Updatable) Path directory of the asset.\n" }, "vmwareToolsStatus": { "type": "string", "description": "(Updatable) VMware tools status.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cluster", "customerFields", "customerTags", "faultToleranceBandwidth", "faultToleranceSecondaryLatency", "faultToleranceState", "instanceUuid", "isDisksCbtEnabled", "isDisksUuidEnabled", "path", "vmwareToolsStatus" ] } } }, "oci:CloudBridge/AssetVmwareVmCustomerTag:AssetVmwareVmCustomerTag": { "properties": { "description": { "type": "string", "description": "(Updatable) The tag description.\n" }, "name": { "type": "string", "description": "(Updatable) The tag name.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "description", "name" ] } } }, "oci:CloudBridge/getAgentDependenciesAgentDependencyCollection:getAgentDependenciesAgentDependencyCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAgentDependenciesAgentDependencyCollectionItem:getAgentDependenciesAgentDependencyCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAgentDependenciesAgentDependencyCollectionItem:getAgentDependenciesAgentDependencyCollectionItem": { "properties": { "bucket": { "type": "string", "description": "Object storage bucket where the Agent dependency is uploaded.\n" }, "checksum": { "type": "string", "description": "The checksum associated with the dependency object returned by Object Storage.\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "dependencyName": { "type": "string", "description": "Name of the dependency type. This should match the whitelisted enum of dependency names.\n" }, "dependencyVersion": { "type": "string", "description": "Version of the Agent dependency.\n" }, "description": { "type": "string", "description": "Description about the Agent dependency.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "eTag": { "type": "string", "description": "The eTag associated with the dependency object returned by Object Storage.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "namespace": { "type": "string", "description": "Object storage namespace associated with the customer's tenancy.\n" }, "object": { "type": "string", "description": "Name of the dependency object uploaded by the customer.\n" }, "state": { "type": "string", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the AgentDependency was created. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "bucket", "checksum", "compartmentId", "definedTags", "dependencyName", "dependencyVersion", "description", "displayName", "eTag", "freeformTags", "id", "lifecycleDetails", "namespace", "object", "state", "systemTags", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAgentDependenciesFilter:getAgentDependenciesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getAgentPluginList:getAgentPluginList": { "properties": { "agentId": { "type": "string", "description": "Unique Agent identifier path parameter.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "name": { "type": "string", "description": "Plugin identifier, which can be renamed.\n" }, "pluginVersion": { "type": "string", "description": "Plugin version.\n" }, "state": { "type": "string", "description": "The current state of the Agent.\n" }, "timeCreated": { "type": "string", "description": "The time when the Agent was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the Agent was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "agentId", "definedTags", "freeformTags", "lifecycleDetails", "name", "pluginVersion", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAgentsAgentCollection:getAgentsAgentCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAgentsAgentCollectionItem:getAgentsAgentCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAgentsAgentCollectionItem:getAgentsAgentCollectionItem": { "properties": { "agentPubKey": { "type": "string", "description": "Resource principal public key.\n" }, "agentType": { "type": "string", "description": "Type of the Agent.\n" }, "agentVersion": { "type": "string", "description": "Agent identifier.\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "environmentId": { "type": "string", "description": "A filter to return only resources that match the given environment ID.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "heartBeatStatus": { "type": "string", "description": "The current heartbeat status of the Agent based on its timeLastSyncReceived value.\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "osVersion": { "type": "string", "description": "OS version.\n" }, "pluginLists": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAgentsAgentCollectionItemPluginList:getAgentsAgentCollectionItemPluginList" }, "description": "List of plugins associated with the agent.\n" }, "state": { "type": "string", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the Agent was created. An RFC3339 formatted datetime string.\n" }, "timeExpireAgentKeyInMs": { "type": "string", "description": "The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.\n" }, "timeLastSyncReceived": { "type": "string", "description": "The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the Agent was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "agentPubKey", "agentType", "agentVersion", "compartmentId", "definedTags", "displayName", "environmentId", "freeformTags", "heartBeatStatus", "id", "lifecycleDetails", "osVersion", "pluginLists", "state", "systemTags", "timeCreated", "timeExpireAgentKeyInMs", "timeLastSyncReceived", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAgentsAgentCollectionItemPluginList:getAgentsAgentCollectionItemPluginList": { "properties": { "agentId": { "type": "string", "description": "A filter to return only resources that match the given Agent ID.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "name": { "type": "string", "description": "Plugin identifier, which can be renamed.\n" }, "pluginVersion": { "type": "string", "description": "Plugin version.\n" }, "state": { "type": "string", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState.\n" }, "timeCreated": { "type": "string", "description": "The time when the Agent was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the Agent was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "agentId", "definedTags", "freeformTags", "lifecycleDetails", "name", "pluginVersion", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAgentsFilter:getAgentsFilter": { "properties": { "name": { "type": "string", "description": "Plugin identifier, which can be renamed.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getApplianceImageItem:getApplianceImageItem": { "properties": { "checksum": { "type": "string", "description": "The checksum of the image file.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "downloadUrl": { "type": "string", "description": "The URL from which the appliance image can be downloaded.\n" }, "fileName": { "type": "string", "description": "The name of the appliance Image file.\n" }, "format": { "type": "string", "description": "The file format of the image file.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation.\n" }, "platform": { "type": "string", "description": "The virtualization platform that the image file supports.\n" }, "sizeInMbs": { "type": "string", "description": "The size of the image file in megabytes.\n" }, "state": { "type": "string", "description": "The current state of the appliance image.\n" }, "timeCreated": { "type": "string", "description": "The time when the appliance image was created.An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the appliance image was last updated. An RFC3339 formatted datetime string.\n" }, "version": { "type": "string", "description": "The version of the image file.\n" } }, "type": "object", "required": [ "checksum", "definedTags", "displayName", "downloadUrl", "fileName", "format", "freeformTags", "id", "platform", "sizeInMbs", "state", "timeCreated", "timeUpdated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getApplianceImagesApplianceImageCollection:getApplianceImagesApplianceImageCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getApplianceImagesApplianceImageCollectionItem:getApplianceImagesApplianceImageCollectionItem" }, "description": "List of appliance images.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getApplianceImagesApplianceImageCollectionItem:getApplianceImagesApplianceImageCollectionItem": { "properties": { "checksum": { "type": "string", "description": "The checksum of the image file.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "downloadUrl": { "type": "string", "description": "The URL from which the appliance image can be downloaded.\n" }, "fileName": { "type": "string", "description": "The name of the appliance Image file.\n" }, "format": { "type": "string", "description": "The file format of the image file.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation.\n" }, "platform": { "type": "string", "description": "The virtualization platform that the image file supports.\n" }, "sizeInMbs": { "type": "string", "description": "The size of the image file in megabytes.\n" }, "state": { "type": "string", "description": "The current state of the appliance image.\n" }, "timeCreated": { "type": "string", "description": "The time when the appliance image was created.An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the appliance image was last updated. An RFC3339 formatted datetime string.\n" }, "version": { "type": "string", "description": "The version of the image file.\n" } }, "type": "object", "required": [ "checksum", "definedTags", "displayName", "downloadUrl", "fileName", "format", "freeformTags", "id", "platform", "sizeInMbs", "state", "timeCreated", "timeUpdated", "version" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getApplianceImagesFilter:getApplianceImagesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getAssetAttachedEbsVolumesCost:getAssetAttachedEbsVolumesCost": { "properties": { "amount": { "type": "number" }, "currencyCode": { "type": "string" } }, "type": "object", "required": [ "amount", "currencyCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEb:getAssetAwsEb": { "properties": { "attachments": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEbAttachment:getAssetAwsEbAttachment" } }, "availabilityZone": { "type": "string" }, "iops": { "type": "integer" }, "isEncrypted": { "type": "boolean" }, "isMultiAttachEnabled": { "type": "boolean" }, "sizeInGiBs": { "type": "integer" }, "status": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEbTag:getAssetAwsEbTag" } }, "throughput": { "type": "integer" }, "volumeKey": { "type": "string" }, "volumeType": { "type": "string" } }, "type": "object", "required": [ "attachments", "availabilityZone", "iops", "isEncrypted", "isMultiAttachEnabled", "sizeInGiBs", "status", "tags", "throughput", "volumeKey", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEbAttachment:getAssetAwsEbAttachment": { "properties": { "device": { "type": "string" }, "instanceKey": { "type": "string" }, "isDeleteOnTermination": { "type": "boolean" }, "status": { "type": "string" }, "volumeKey": { "type": "string" } }, "type": "object", "required": [ "device", "instanceKey", "isDeleteOnTermination", "status", "volumeKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEbTag:getAssetAwsEbTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2:getAssetAwsEc2": { "properties": { "architecture": { "type": "string" }, "areElasticInferenceAcceleratorsPresent": { "type": "boolean" }, "bootMode": { "type": "string" }, "capacityReservationKey": { "type": "string" }, "imageKey": { "type": "string" }, "instanceKey": { "type": "string" }, "instanceLifecycle": { "type": "string" }, "instanceType": { "type": "string" }, "ipAddress": { "type": "string" }, "ipv6address": { "type": "string" }, "isEnclaveOptions": { "type": "boolean" }, "isHibernationOptions": { "type": "boolean" }, "isSourceDestCheck": { "type": "boolean" }, "isSpotInstance": { "type": "boolean" }, "kernelKey": { "type": "string" }, "licenses": { "type": "array", "items": { "type": "string" } }, "maintenanceOptions": { "type": "string" }, "monitoring": { "type": "string" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2NetworkInterface:getAssetAwsEc2NetworkInterface" } }, "placements": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2Placement:getAssetAwsEc2Placement" } }, "privateDnsName": { "type": "string" }, "privateIpAddress": { "type": "string" }, "rootDeviceName": { "type": "string" }, "rootDeviceType": { "type": "string" }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2SecurityGroup:getAssetAwsEc2SecurityGroup" } }, "sriovNetSupport": { "type": "string" }, "states": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2State:getAssetAwsEc2State" }, "description": "The current state of the asset.\n" }, "subnetKey": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2Tag:getAssetAwsEc2Tag" } }, "timeLaunch": { "type": "string" }, "tpmSupport": { "type": "string" }, "virtualizationType": { "type": "string" }, "vpcKey": { "type": "string" } }, "type": "object", "required": [ "architecture", "areElasticInferenceAcceleratorsPresent", "bootMode", "capacityReservationKey", "imageKey", "instanceKey", "instanceLifecycle", "instanceType", "ipAddress", "ipv6address", "isEnclaveOptions", "isHibernationOptions", "isSourceDestCheck", "isSpotInstance", "kernelKey", "licenses", "maintenanceOptions", "monitoring", "networkInterfaces", "placements", "privateDnsName", "privateIpAddress", "rootDeviceName", "rootDeviceType", "securityGroups", "sriovNetSupport", "states", "subnetKey", "tags", "timeLaunch", "tpmSupport", "virtualizationType", "vpcKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2NetworkInterface:getAssetAwsEc2NetworkInterface": { "properties": { "associations": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2NetworkInterfaceAssociation:getAssetAwsEc2NetworkInterfaceAssociation" } }, "attachments": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2NetworkInterfaceAttachment:getAssetAwsEc2NetworkInterfaceAttachment" } }, "description": { "type": "string", "description": "The tag description.\n" }, "interfaceType": { "type": "string" }, "ipv4prefixes": { "type": "array", "items": { "type": "string" } }, "ipv6addresses": { "type": "array", "items": { "type": "string" } }, "ipv6prefixes": { "type": "array", "items": { "type": "string" } }, "isSourceDestCheck": { "type": "boolean" }, "macAddress": { "type": "string", "description": "Mac address of the VM.\n" }, "networkInterfaceKey": { "type": "string" }, "ownerKey": { "type": "string" }, "privateIpAddresses": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2NetworkInterfacePrivateIpAddress:getAssetAwsEc2NetworkInterfacePrivateIpAddress" } }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2NetworkInterfaceSecurityGroup:getAssetAwsEc2NetworkInterfaceSecurityGroup" } }, "status": { "type": "string" }, "subnetKey": { "type": "string" } }, "type": "object", "required": [ "associations", "attachments", "description", "interfaceType", "ipv4prefixes", "ipv6addresses", "ipv6prefixes", "isSourceDestCheck", "macAddress", "networkInterfaceKey", "ownerKey", "privateIpAddresses", "securityGroups", "status", "subnetKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2NetworkInterfaceAssociation:getAssetAwsEc2NetworkInterfaceAssociation": { "properties": { "carrierIp": { "type": "string" }, "customerOwnedIp": { "type": "string" }, "ipOwnerKey": { "type": "string" }, "publicDnsName": { "type": "string" }, "publicIp": { "type": "string" } }, "type": "object", "required": [ "carrierIp", "customerOwnedIp", "ipOwnerKey", "publicDnsName", "publicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2NetworkInterfaceAttachment:getAssetAwsEc2NetworkInterfaceAttachment": { "properties": { "attachmentKey": { "type": "string" }, "deviceIndex": { "type": "integer" }, "isDeleteOnTermination": { "type": "boolean" }, "networkCardIndex": { "type": "integer" }, "status": { "type": "string" }, "timeAttach": { "type": "string" } }, "type": "object", "required": [ "attachmentKey", "deviceIndex", "isDeleteOnTermination", "networkCardIndex", "status", "timeAttach" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2NetworkInterfacePrivateIpAddress:getAssetAwsEc2NetworkInterfacePrivateIpAddress": { "properties": { "associations": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetAwsEc2NetworkInterfacePrivateIpAddressAssociation:getAssetAwsEc2NetworkInterfacePrivateIpAddressAssociation" } }, "isPrimary": { "type": "boolean" }, "privateDnsName": { "type": "string" }, "privateIpAddress": { "type": "string" } }, "type": "object", "required": [ "associations", "isPrimary", "privateDnsName", "privateIpAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2NetworkInterfacePrivateIpAddressAssociation:getAssetAwsEc2NetworkInterfacePrivateIpAddressAssociation": { "properties": { "carrierIp": { "type": "string" }, "customerOwnedIp": { "type": "string" }, "ipOwnerKey": { "type": "string" }, "publicDnsName": { "type": "string" }, "publicIp": { "type": "string" } }, "type": "object", "required": [ "carrierIp", "customerOwnedIp", "ipOwnerKey", "publicDnsName", "publicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2NetworkInterfaceSecurityGroup:getAssetAwsEc2NetworkInterfaceSecurityGroup": { "properties": { "groupKey": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object", "required": [ "groupKey", "groupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2Placement:getAssetAwsEc2Placement": { "properties": { "affinity": { "type": "string" }, "availabilityZone": { "type": "string" }, "groupName": { "type": "string" }, "hostKey": { "type": "string" }, "hostResourceGroupArn": { "type": "string" }, "partitionNumber": { "type": "integer" }, "spreadDomain": { "type": "string" }, "tenancy": { "type": "string" } }, "type": "object", "required": [ "affinity", "availabilityZone", "groupName", "hostKey", "hostResourceGroupArn", "partitionNumber", "spreadDomain", "tenancy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2SecurityGroup:getAssetAwsEc2SecurityGroup": { "properties": { "groupKey": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object", "required": [ "groupKey", "groupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2State:getAssetAwsEc2State": { "properties": { "code": { "type": "integer" }, "name": { "type": "string", "description": "The tag name.\n" } }, "type": "object", "required": [ "code", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2Tag:getAssetAwsEc2Tag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetAwsEc2cost:getAssetAwsEc2cost": { "properties": { "amount": { "type": "number" }, "currencyCode": { "type": "string" } }, "type": "object", "required": [ "amount", "currencyCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetCompute:getAssetCompute": { "properties": { "connectedNetworks": { "type": "integer", "description": "Number of connected networks.\n" }, "coresCount": { "type": "integer", "description": "Number of GPU cores.\n" }, "cpuModel": { "type": "string", "description": "CPU model name.\n" }, "description": { "type": "string", "description": "The tag description.\n" }, "disks": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetComputeDisk:getAssetComputeDisk" }, "description": "Lists the set of disks belonging to the virtual machine. This list is unordered.\n" }, "disksCount": { "type": "integer", "description": "Number of disks.\n" }, "dnsName": { "type": "string", "description": "Fully Qualified DNS Name.\n" }, "firmware": { "type": "string", "description": "Information about firmware type for this virtual machine.\n" }, "gpuDevices": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetComputeGpuDevice:getAssetComputeGpuDevice" }, "description": "List of GPU devices attached to a virtual machine.\n" }, "gpuDevicesCount": { "type": "integer", "description": "Number of GPU devices.\n" }, "guestState": { "type": "string", "description": "Guest state.\n" }, "hardwareVersion": { "type": "string", "description": "Hardware version.\n" }, "hostName": { "type": "string", "description": "Host name of the VM.\n" }, "isPmemEnabled": { "type": "boolean", "description": "Whether Pmem is enabled. Decides if NVDIMMs are used as a permanent memory.\n" }, "isTpmEnabled": { "type": "boolean", "description": "Whether Trusted Platform Module (TPM) is enabled.\n" }, "latencySensitivity": { "type": "string", "description": "Latency sensitivity.\n" }, "memoryInMbs": { "type": "string", "description": "Memory size in MBs.\n" }, "nics": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetComputeNic:getAssetComputeNic" }, "description": "List of network ethernet cards attached to a virtual machine.\n" }, "nicsCount": { "type": "integer", "description": "Number of network ethernet cards.\n" }, "nvdimmControllers": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetComputeNvdimmController:getAssetComputeNvdimmController" }, "description": "The asset's NVDIMM configuration.\n" }, "nvdimms": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetComputeNvdimm:getAssetComputeNvdimm" }, "description": "The properties of the NVDIMMs attached to a virtual machine.\n" }, "operatingSystem": { "type": "string", "description": "Operating system.\n" }, "operatingSystemVersion": { "type": "string", "description": "Operating system version.\n" }, "pmemInMbs": { "type": "string", "description": "Pmem size in MBs.\n" }, "powerState": { "type": "string", "description": "The current power state of the virtual machine.\n" }, "primaryIp": { "type": "string", "description": "Primary IP address of the compute instance.\n" }, "scsiControllers": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetComputeScsiController:getAssetComputeScsiController" }, "description": "The assets SCSI controller.\n" }, "storageProvisionedInMbs": { "type": "string", "description": "Provision storage size in MBs.\n" }, "threadsPerCoreCount": { "type": "integer", "description": "Number of threads per core.\n" } }, "type": "object", "required": [ "connectedNetworks", "coresCount", "cpuModel", "description", "disks", "disksCount", "dnsName", "firmware", "gpuDevices", "gpuDevicesCount", "guestState", "hardwareVersion", "hostName", "isPmemEnabled", "isTpmEnabled", "latencySensitivity", "memoryInMbs", "nics", "nicsCount", "nvdimmControllers", "nvdimms", "operatingSystem", "operatingSystemVersion", "pmemInMbs", "powerState", "primaryIp", "scsiControllers", "storageProvisionedInMbs", "threadsPerCoreCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetComputeDisk:getAssetComputeDisk": { "properties": { "bootOrder": { "type": "integer", "description": "Order of boot volumes.\n" }, "isCbtEnabled": { "type": "boolean" }, "location": { "type": "string", "description": "Location of the boot/data volume.\n" }, "name": { "type": "string", "description": "The tag name.\n" }, "persistentMode": { "type": "string", "description": "The disk persistent mode.\n" }, "sizeInMbs": { "type": "string", "description": "The size of the volume in MBs.\n" }, "uuid": { "type": "string", "description": "Disk UUID for the virtual disk, if available.\n" }, "uuidLun": { "type": "string", "description": "Disk UUID LUN for the virtual disk, if available.\n" } }, "type": "object", "required": [ "bootOrder", "isCbtEnabled", "location", "name", "persistentMode", "sizeInMbs", "uuid", "uuidLun" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetComputeGpuDevice:getAssetComputeGpuDevice": { "properties": { "coresCount": { "type": "integer", "description": "Number of GPU cores.\n" }, "description": { "type": "string", "description": "The tag description.\n" }, "manufacturer": { "type": "string", "description": "The manufacturer of GPU.\n" }, "memoryInMbs": { "type": "string", "description": "Memory size in MBs.\n" }, "name": { "type": "string", "description": "The tag name.\n" } }, "type": "object", "required": [ "coresCount", "description", "manufacturer", "memoryInMbs", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetComputeNic:getAssetComputeNic": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses.\n" }, "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" }, "macAddress": { "type": "string", "description": "Mac address of the VM.\n" }, "macAddressType": { "type": "string", "description": "Mac address type.\n" }, "networkName": { "type": "string", "description": "Network name.\n" }, "switchName": { "type": "string", "description": "Switch name.\n" } }, "type": "object", "required": [ "ipAddresses", "label", "macAddress", "macAddressType", "networkName", "switchName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetComputeNvdimm:getAssetComputeNvdimm": { "properties": { "controllerKey": { "type": "integer", "description": "Controller key.\n" }, "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" }, "unitNumber": { "type": "integer", "description": "The unit number of the SCSI controller.\n" } }, "type": "object", "required": [ "controllerKey", "label", "unitNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetComputeNvdimmController:getAssetComputeNvdimmController": { "properties": { "busNumber": { "type": "integer", "description": "Bus number.\n" }, "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" } }, "type": "object", "required": [ "busNumber", "label" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetComputeScsiController:getAssetComputeScsiController": { "properties": { "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" }, "sharedBus": { "type": "string", "description": "Shared bus.\n" }, "unitNumber": { "type": "integer", "description": "The unit number of the SCSI controller.\n" } }, "type": "object", "required": [ "label", "sharedBus", "unitNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourceDiscoveryCredential:getAssetSourceDiscoveryCredential": { "properties": { "secretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ \"username\": \"\u003cVMwareUser\u003e\", \"password\": \"\u003cVMwarePassword\u003e\" }`.\n" }, "type": { "type": "string", "description": "The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.\n" } }, "type": "object", "required": [ "secretId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourceReplicationCredential:getAssetSourceReplicationCredential": { "properties": { "secretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ \"username\": \"\u003cVMwareUser\u003e\", \"password\": \"\u003cVMwarePassword\u003e\" }`.\n" }, "type": { "type": "string", "description": "The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.\n" } }, "type": "object", "required": [ "secretId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourcesAssetSourceCollection:getAssetSourcesAssetSourceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetSourcesAssetSourceCollectionItem:getAssetSourcesAssetSourceCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourcesAssetSourceCollectionItem:getAssetSourcesAssetSourceCollectionItem": { "properties": { "areHistoricalMetricsCollected": { "type": "boolean", "description": "Flag indicating whether historical metrics are collected for assets, originating from this asset source.\n" }, "areRealtimeMetricsCollected": { "type": "boolean", "description": "Flag indicating whether real-time metrics are collected for assets, originating from this asset source.\n" }, "assetsCompartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that is going to be used to create assets.\n" }, "awsAccountKey": { "type": "string" }, "awsRegion": { "type": "string" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "discoveryCredentials": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetSourcesAssetSourceCollectionItemDiscoveryCredential:getAssetSourcesAssetSourceCollectionItemDiscoveryCredential" }, "description": "Credentials for an asset source.\n" }, "discoveryScheduleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an attached discovery schedule.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "environmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the environment.\n" }, "environmentType": { "type": "string", "description": "Specifies if this is the Source or Destination point for migration - different assets may be discovered depending on setting.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.\n" }, "inventoryId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the inventory that will contain created assets.\n" }, "isCostInformationCollected": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "The detailed state of the asset source.\n" }, "olvmEndpoint": { "type": "string", "description": "Endpoint for OLVM asset discovery and replication in the form of ```https://\u003chost\u003e:\u003cport\u003e```\n" }, "replicationCredentials": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetSourcesAssetSourceCollectionItemReplicationCredential:getAssetSourcesAssetSourceCollectionItemReplicationCredential" }, "description": "Credentials for an asset source.\n" }, "state": { "type": "string", "description": "The current state of the asset source.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the asset source was created in the RFC3339 format.\n" }, "timeUpdated": { "type": "string", "description": "The point in time that the asset source was last updated in the RFC3339 format.\n" }, "type": { "type": "string", "description": "The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.\n" }, "vcenterEndpoint": { "type": "string", "description": "Endpoint for VMware asset discovery and replication in the form of ```https://\u003chost\u003e:\u003cport\u003e/sdk```\n" } }, "type": "object", "required": [ "areHistoricalMetricsCollected", "areRealtimeMetricsCollected", "assetsCompartmentId", "awsAccountKey", "awsRegion", "compartmentId", "definedTags", "discoveryCredentials", "discoveryScheduleId", "displayName", "environmentId", "environmentType", "freeformTags", "id", "inventoryId", "isCostInformationCollected", "lifecycleDetails", "olvmEndpoint", "replicationCredentials", "state", "systemTags", "timeCreated", "timeUpdated", "type", "vcenterEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourcesAssetSourceCollectionItemDiscoveryCredential:getAssetSourcesAssetSourceCollectionItemDiscoveryCredential": { "properties": { "secretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ \"username\": \"\u003cVMwareUser\u003e\", \"password\": \"\u003cVMwarePassword\u003e\" }`.\n" }, "type": { "type": "string", "description": "The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.\n" } }, "type": "object", "required": [ "secretId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourcesAssetSourceCollectionItemReplicationCredential:getAssetSourcesAssetSourceCollectionItemReplicationCredential": { "properties": { "secretId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the secret in a vault. If the the type of the credentials is BASIC`, the secret must contain the username and password in JSON format, which is in the form of `{ \"username\": \"\u003cVMwareUser\u003e\", \"password\": \"\u003cVMwarePassword\u003e\" }`.\n" }, "type": { "type": "string", "description": "The type of asset source. Indicates external origin of the assets that are read by assigning this asset source.\n" } }, "type": "object", "required": [ "secretId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetSourcesFilter:getAssetSourcesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getAssetVm:getAssetVm": { "properties": { "hypervisorHost": { "type": "string", "description": "Host name/IP address of VM on which the host is running.\n" }, "hypervisorVendor": { "type": "string", "description": "Hypervisor vendor.\n" }, "hypervisorVersion": { "type": "string", "description": "Hypervisor version.\n" } }, "type": "object", "required": [ "hypervisorHost", "hypervisorVendor", "hypervisorVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetVmwareVcenter:getAssetVmwareVcenter": { "properties": { "dataCenter": { "type": "string", "description": "Data center name.\n" }, "vcenterKey": { "type": "string", "description": "vCenter unique key.\n" }, "vcenterVersion": { "type": "string", "description": "Dot-separated version string.\n" } }, "type": "object", "required": [ "dataCenter", "vcenterKey", "vcenterVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetVmwareVm:getAssetVmwareVm": { "properties": { "cluster": { "type": "string", "description": "Cluster name.\n" }, "customerFields": { "type": "array", "items": { "type": "string" }, "description": "Customer fields.\n" }, "customerTags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetVmwareVmCustomerTag:getAssetVmwareVmCustomerTag" }, "description": "Customer defined tags.\n" }, "faultToleranceBandwidth": { "type": "integer", "description": "Fault tolerance bandwidth.\n" }, "faultToleranceSecondaryLatency": { "type": "integer", "description": "Fault tolerance to secondary latency.\n" }, "faultToleranceState": { "type": "string", "description": "Fault tolerance state.\n" }, "instanceUuid": { "type": "string", "description": "vCenter-specific identifier of the virtual machine.\n" }, "isDisksCbtEnabled": { "type": "boolean", "description": "Indicates that change tracking is supported for virtual disks of this virtual machine. However, even if change tracking is supported, it might not be available for all disks of the virtual machine.\n" }, "isDisksUuidEnabled": { "type": "boolean", "description": "Whether changed block tracking for this VM's disk is active.\n" }, "path": { "type": "string", "description": "Path directory of the asset.\n" }, "vmwareToolsStatus": { "type": "string", "description": "VMware tools status.\n" } }, "type": "object", "required": [ "cluster", "customerFields", "customerTags", "faultToleranceBandwidth", "faultToleranceSecondaryLatency", "faultToleranceState", "instanceUuid", "isDisksCbtEnabled", "isDisksUuidEnabled", "path", "vmwareToolsStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetVmwareVmCustomerTag:getAssetVmwareVmCustomerTag": { "properties": { "description": { "type": "string", "description": "The tag description.\n" }, "name": { "type": "string", "description": "The tag name.\n" } }, "type": "object", "required": [ "description", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollection:getAssetsAssetCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItem:getAssetsAssetCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItem:getAssetsAssetCollectionItem": { "properties": { "assetClassName": { "type": "string", "description": "The name of the asset class.\n" }, "assetClassVersion": { "type": "string", "description": "The version of the asset class.\n" }, "assetDetails": { "type": "string", "description": "The details of the asset.\n" }, "assetSourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of asset source OCID.\n" }, "assetType": { "type": "string", "description": "The type of asset.\n" }, "attachedEbsVolumesCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAttachedEbsVolumesCost:getAssetsAssetCollectionItemAttachedEbsVolumesCost" } }, "awsEbs": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEb:getAssetsAssetCollectionItemAwsEb" } }, "awsEc2costs": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2cost:getAssetsAssetCollectionItemAwsEc2cost" } }, "awsEc2s": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2:getAssetsAssetCollectionItemAwsEc2" } }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemCompute:getAssetsAssetCollectionItemCompute" }, "description": "Compute related properties.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "environmentType": { "type": "string", "description": "Specifies if this is the Source or Destination point for migration - different assets may be discovered depending on setting.\n" }, "externalAssetKey": { "type": "string", "description": "External asset key.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Asset OCID that is immutable on creation.\n" }, "inventoryId": { "type": "string", "description": "Unique Inventory identifier.\n" }, "sourceKey": { "type": "string", "description": "Source key from where the assets originate.\n" }, "state": { "type": "string", "description": "A filter to return only assets whose lifecycleState matches the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the asset was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the asset was updated. An RFC3339 formatted datetime string.\n" }, "vms": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemVm:getAssetsAssetCollectionItemVm" }, "description": "Virtual machine related properties.\n" }, "vmwareVcenters": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemVmwareVcenter:getAssetsAssetCollectionItemVmwareVcenter" }, "description": "VMware vCenter related properties.\n" }, "vmwareVms": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemVmwareVm:getAssetsAssetCollectionItemVmwareVm" }, "description": "VMware virtual machine related properties.\n" } }, "type": "object", "required": [ "assetClassName", "assetClassVersion", "assetDetails", "assetSourceIds", "assetType", "attachedEbsVolumesCosts", "awsEbs", "awsEc2s", "awsEc2costs", "compartmentId", "computes", "definedTags", "displayName", "environmentType", "externalAssetKey", "freeformTags", "id", "inventoryId", "sourceKey", "state", "systemTags", "timeCreated", "timeUpdated", "vms", "vmwareVcenters", "vmwareVms" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAttachedEbsVolumesCost:getAssetsAssetCollectionItemAttachedEbsVolumesCost": { "properties": { "amount": { "type": "number" }, "currencyCode": { "type": "string" } }, "type": "object", "required": [ "amount", "currencyCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEb:getAssetsAssetCollectionItemAwsEb": { "properties": { "attachments": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEbAttachment:getAssetsAssetCollectionItemAwsEbAttachment" } }, "availabilityZone": { "type": "string" }, "iops": { "type": "integer" }, "isEncrypted": { "type": "boolean" }, "isMultiAttachEnabled": { "type": "boolean" }, "sizeInGiBs": { "type": "integer" }, "status": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEbTag:getAssetsAssetCollectionItemAwsEbTag" } }, "throughput": { "type": "integer" }, "volumeKey": { "type": "string" }, "volumeType": { "type": "string" } }, "type": "object", "required": [ "attachments", "availabilityZone", "iops", "isEncrypted", "isMultiAttachEnabled", "sizeInGiBs", "status", "tags", "throughput", "volumeKey", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEbAttachment:getAssetsAssetCollectionItemAwsEbAttachment": { "properties": { "device": { "type": "string" }, "instanceKey": { "type": "string" }, "isDeleteOnTermination": { "type": "boolean" }, "status": { "type": "string" }, "volumeKey": { "type": "string" } }, "type": "object", "required": [ "device", "instanceKey", "isDeleteOnTermination", "status", "volumeKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEbTag:getAssetsAssetCollectionItemAwsEbTag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2:getAssetsAssetCollectionItemAwsEc2": { "properties": { "architecture": { "type": "string" }, "areElasticInferenceAcceleratorsPresent": { "type": "boolean" }, "bootMode": { "type": "string" }, "capacityReservationKey": { "type": "string" }, "imageKey": { "type": "string" }, "instanceKey": { "type": "string" }, "instanceLifecycle": { "type": "string" }, "instanceType": { "type": "string" }, "ipAddress": { "type": "string" }, "ipv6address": { "type": "string" }, "isEnclaveOptions": { "type": "boolean" }, "isHibernationOptions": { "type": "boolean" }, "isSourceDestCheck": { "type": "boolean" }, "isSpotInstance": { "type": "boolean" }, "kernelKey": { "type": "string" }, "licenses": { "type": "array", "items": { "type": "string" } }, "maintenanceOptions": { "type": "string" }, "monitoring": { "type": "string" }, "networkInterfaces": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterface:getAssetsAssetCollectionItemAwsEc2NetworkInterface" } }, "placements": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2Placement:getAssetsAssetCollectionItemAwsEc2Placement" } }, "privateDnsName": { "type": "string" }, "privateIpAddress": { "type": "string" }, "rootDeviceName": { "type": "string" }, "rootDeviceType": { "type": "string" }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2SecurityGroup:getAssetsAssetCollectionItemAwsEc2SecurityGroup" } }, "sriovNetSupport": { "type": "string" }, "states": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2State:getAssetsAssetCollectionItemAwsEc2State" }, "description": "A filter to return only assets whose lifecycleState matches the given lifecycleState.\n" }, "subnetKey": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2Tag:getAssetsAssetCollectionItemAwsEc2Tag" } }, "timeLaunch": { "type": "string" }, "tpmSupport": { "type": "string" }, "virtualizationType": { "type": "string" }, "vpcKey": { "type": "string" } }, "type": "object", "required": [ "architecture", "areElasticInferenceAcceleratorsPresent", "bootMode", "capacityReservationKey", "imageKey", "instanceKey", "instanceLifecycle", "instanceType", "ipAddress", "ipv6address", "isEnclaveOptions", "isHibernationOptions", "isSourceDestCheck", "isSpotInstance", "kernelKey", "licenses", "maintenanceOptions", "monitoring", "networkInterfaces", "placements", "privateDnsName", "privateIpAddress", "rootDeviceName", "rootDeviceType", "securityGroups", "sriovNetSupport", "states", "subnetKey", "tags", "timeLaunch", "tpmSupport", "virtualizationType", "vpcKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterface:getAssetsAssetCollectionItemAwsEc2NetworkInterface": { "properties": { "associations": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAssociation:getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAssociation" } }, "attachments": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAttachment:getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAttachment" } }, "description": { "type": "string", "description": "The tag description.\n" }, "interfaceType": { "type": "string" }, "ipv4prefixes": { "type": "array", "items": { "type": "string" } }, "ipv6addresses": { "type": "array", "items": { "type": "string" } }, "ipv6prefixes": { "type": "array", "items": { "type": "string" } }, "isSourceDestCheck": { "type": "boolean" }, "macAddress": { "type": "string", "description": "Mac address of the VM.\n" }, "networkInterfaceKey": { "type": "string" }, "ownerKey": { "type": "string" }, "privateIpAddresses": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddress:getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddress" } }, "securityGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfaceSecurityGroup:getAssetsAssetCollectionItemAwsEc2NetworkInterfaceSecurityGroup" } }, "status": { "type": "string" }, "subnetKey": { "type": "string" } }, "type": "object", "required": [ "associations", "attachments", "description", "interfaceType", "ipv4prefixes", "ipv6addresses", "ipv6prefixes", "isSourceDestCheck", "macAddress", "networkInterfaceKey", "ownerKey", "privateIpAddresses", "securityGroups", "status", "subnetKey" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAssociation:getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAssociation": { "properties": { "carrierIp": { "type": "string" }, "customerOwnedIp": { "type": "string" }, "ipOwnerKey": { "type": "string" }, "publicDnsName": { "type": "string" }, "publicIp": { "type": "string" } }, "type": "object", "required": [ "carrierIp", "customerOwnedIp", "ipOwnerKey", "publicDnsName", "publicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAttachment:getAssetsAssetCollectionItemAwsEc2NetworkInterfaceAttachment": { "properties": { "attachmentKey": { "type": "string" }, "deviceIndex": { "type": "integer" }, "isDeleteOnTermination": { "type": "boolean" }, "networkCardIndex": { "type": "integer" }, "status": { "type": "string" }, "timeAttach": { "type": "string" } }, "type": "object", "required": [ "attachmentKey", "deviceIndex", "isDeleteOnTermination", "networkCardIndex", "status", "timeAttach" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddress:getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddress": { "properties": { "associations": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddressAssociation:getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddressAssociation" } }, "isPrimary": { "type": "boolean" }, "privateDnsName": { "type": "string" }, "privateIpAddress": { "type": "string" } }, "type": "object", "required": [ "associations", "isPrimary", "privateDnsName", "privateIpAddress" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddressAssociation:getAssetsAssetCollectionItemAwsEc2NetworkInterfacePrivateIpAddressAssociation": { "properties": { "carrierIp": { "type": "string" }, "customerOwnedIp": { "type": "string" }, "ipOwnerKey": { "type": "string" }, "publicDnsName": { "type": "string" }, "publicIp": { "type": "string" } }, "type": "object", "required": [ "carrierIp", "customerOwnedIp", "ipOwnerKey", "publicDnsName", "publicIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2NetworkInterfaceSecurityGroup:getAssetsAssetCollectionItemAwsEc2NetworkInterfaceSecurityGroup": { "properties": { "groupKey": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object", "required": [ "groupKey", "groupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2Placement:getAssetsAssetCollectionItemAwsEc2Placement": { "properties": { "affinity": { "type": "string" }, "availabilityZone": { "type": "string" }, "groupName": { "type": "string" }, "hostKey": { "type": "string" }, "hostResourceGroupArn": { "type": "string" }, "partitionNumber": { "type": "integer" }, "spreadDomain": { "type": "string" }, "tenancy": { "type": "string" } }, "type": "object", "required": [ "affinity", "availabilityZone", "groupName", "hostKey", "hostResourceGroupArn", "partitionNumber", "spreadDomain", "tenancy" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2SecurityGroup:getAssetsAssetCollectionItemAwsEc2SecurityGroup": { "properties": { "groupKey": { "type": "string" }, "groupName": { "type": "string" } }, "type": "object", "required": [ "groupKey", "groupName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2State:getAssetsAssetCollectionItemAwsEc2State": { "properties": { "code": { "type": "integer" }, "name": { "type": "string", "description": "The tag name.\n" } }, "type": "object", "required": [ "code", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2Tag:getAssetsAssetCollectionItemAwsEc2Tag": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemAwsEc2cost:getAssetsAssetCollectionItemAwsEc2cost": { "properties": { "amount": { "type": "number" }, "currencyCode": { "type": "string" } }, "type": "object", "required": [ "amount", "currencyCode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemCompute:getAssetsAssetCollectionItemCompute": { "properties": { "connectedNetworks": { "type": "integer", "description": "Number of connected networks.\n" }, "coresCount": { "type": "integer", "description": "Number of GPU cores.\n" }, "cpuModel": { "type": "string", "description": "CPU model name.\n" }, "description": { "type": "string", "description": "The tag description.\n" }, "disks": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemComputeDisk:getAssetsAssetCollectionItemComputeDisk" }, "description": "Lists the set of disks belonging to the virtual machine. This list is unordered.\n" }, "disksCount": { "type": "integer", "description": "Number of disks.\n" }, "dnsName": { "type": "string", "description": "Fully Qualified DNS Name.\n" }, "firmware": { "type": "string", "description": "Information about firmware type for this virtual machine.\n" }, "gpuDevices": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemComputeGpuDevice:getAssetsAssetCollectionItemComputeGpuDevice" }, "description": "List of GPU devices attached to a virtual machine.\n" }, "gpuDevicesCount": { "type": "integer", "description": "Number of GPU devices.\n" }, "guestState": { "type": "string", "description": "Guest state.\n" }, "hardwareVersion": { "type": "string", "description": "Hardware version.\n" }, "hostName": { "type": "string", "description": "Host name of the VM.\n" }, "isPmemEnabled": { "type": "boolean", "description": "Whether Pmem is enabled. Decides if NVDIMMs are used as a permanent memory.\n" }, "isTpmEnabled": { "type": "boolean", "description": "Whether Trusted Platform Module (TPM) is enabled.\n" }, "latencySensitivity": { "type": "string", "description": "Latency sensitivity.\n" }, "memoryInMbs": { "type": "string", "description": "Memory size in MBs.\n" }, "nics": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemComputeNic:getAssetsAssetCollectionItemComputeNic" }, "description": "List of network ethernet cards attached to a virtual machine.\n" }, "nicsCount": { "type": "integer", "description": "Number of network ethernet cards.\n" }, "nvdimmControllers": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemComputeNvdimmController:getAssetsAssetCollectionItemComputeNvdimmController" }, "description": "The asset's NVDIMM configuration.\n" }, "nvdimms": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemComputeNvdimm:getAssetsAssetCollectionItemComputeNvdimm" }, "description": "The properties of the NVDIMMs attached to a virtual machine.\n" }, "operatingSystem": { "type": "string", "description": "Operating system.\n" }, "operatingSystemVersion": { "type": "string", "description": "Operating system version.\n" }, "pmemInMbs": { "type": "string", "description": "Pmem size in MBs.\n" }, "powerState": { "type": "string", "description": "The current power state of the virtual machine.\n" }, "primaryIp": { "type": "string", "description": "Primary IP address of the compute instance.\n" }, "scsiControllers": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemComputeScsiController:getAssetsAssetCollectionItemComputeScsiController" }, "description": "The assets SCSI controller.\n" }, "storageProvisionedInMbs": { "type": "string", "description": "Provision storage size in MBs.\n" }, "threadsPerCoreCount": { "type": "integer", "description": "Number of threads per core.\n" } }, "type": "object", "required": [ "connectedNetworks", "coresCount", "cpuModel", "description", "disks", "disksCount", "dnsName", "firmware", "gpuDevices", "gpuDevicesCount", "guestState", "hardwareVersion", "hostName", "isPmemEnabled", "isTpmEnabled", "latencySensitivity", "memoryInMbs", "nics", "nicsCount", "nvdimmControllers", "nvdimms", "operatingSystem", "operatingSystemVersion", "pmemInMbs", "powerState", "primaryIp", "scsiControllers", "storageProvisionedInMbs", "threadsPerCoreCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemComputeDisk:getAssetsAssetCollectionItemComputeDisk": { "properties": { "bootOrder": { "type": "integer", "description": "Order of boot volumes.\n" }, "isCbtEnabled": { "type": "boolean" }, "location": { "type": "string", "description": "Location of the boot/data volume.\n" }, "name": { "type": "string", "description": "The tag name.\n" }, "persistentMode": { "type": "string", "description": "The disk persistent mode.\n" }, "sizeInMbs": { "type": "string", "description": "The size of the volume in MBs.\n" }, "uuid": { "type": "string", "description": "Disk UUID for the virtual disk, if available.\n" }, "uuidLun": { "type": "string", "description": "Disk UUID LUN for the virtual disk, if available.\n" } }, "type": "object", "required": [ "bootOrder", "isCbtEnabled", "location", "name", "persistentMode", "sizeInMbs", "uuid", "uuidLun" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemComputeGpuDevice:getAssetsAssetCollectionItemComputeGpuDevice": { "properties": { "coresCount": { "type": "integer", "description": "Number of GPU cores.\n" }, "description": { "type": "string", "description": "The tag description.\n" }, "manufacturer": { "type": "string", "description": "The manufacturer of GPU.\n" }, "memoryInMbs": { "type": "string", "description": "Memory size in MBs.\n" }, "name": { "type": "string", "description": "The tag name.\n" } }, "type": "object", "required": [ "coresCount", "description", "manufacturer", "memoryInMbs", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemComputeNic:getAssetsAssetCollectionItemComputeNic": { "properties": { "ipAddresses": { "type": "array", "items": { "type": "string" }, "description": "List of IP addresses.\n" }, "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" }, "macAddress": { "type": "string", "description": "Mac address of the VM.\n" }, "macAddressType": { "type": "string", "description": "Mac address type.\n" }, "networkName": { "type": "string", "description": "Network name.\n" }, "switchName": { "type": "string", "description": "Switch name.\n" } }, "type": "object", "required": [ "ipAddresses", "label", "macAddress", "macAddressType", "networkName", "switchName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemComputeNvdimm:getAssetsAssetCollectionItemComputeNvdimm": { "properties": { "controllerKey": { "type": "integer", "description": "Controller key.\n" }, "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" }, "unitNumber": { "type": "integer", "description": "The unit number of the SCSI controller.\n" } }, "type": "object", "required": [ "controllerKey", "label", "unitNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemComputeNvdimmController:getAssetsAssetCollectionItemComputeNvdimmController": { "properties": { "busNumber": { "type": "integer", "description": "Bus number.\n" }, "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" } }, "type": "object", "required": [ "busNumber", "label" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemComputeScsiController:getAssetsAssetCollectionItemComputeScsiController": { "properties": { "label": { "type": "string", "description": "Provides a label and summary information for the device.\n" }, "sharedBus": { "type": "string", "description": "Shared bus.\n" }, "unitNumber": { "type": "integer", "description": "The unit number of the SCSI controller.\n" } }, "type": "object", "required": [ "label", "sharedBus", "unitNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemVm:getAssetsAssetCollectionItemVm": { "properties": { "hypervisorHost": { "type": "string", "description": "Host name/IP address of VM on which the host is running.\n" }, "hypervisorVendor": { "type": "string", "description": "Hypervisor vendor.\n" }, "hypervisorVersion": { "type": "string", "description": "Hypervisor version.\n" } }, "type": "object", "required": [ "hypervisorHost", "hypervisorVendor", "hypervisorVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemVmwareVcenter:getAssetsAssetCollectionItemVmwareVcenter": { "properties": { "dataCenter": { "type": "string", "description": "Data center name.\n" }, "vcenterKey": { "type": "string", "description": "vCenter unique key.\n" }, "vcenterVersion": { "type": "string", "description": "Dot-separated version string.\n" } }, "type": "object", "required": [ "dataCenter", "vcenterKey", "vcenterVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemVmwareVm:getAssetsAssetCollectionItemVmwareVm": { "properties": { "cluster": { "type": "string", "description": "Cluster name.\n" }, "customerFields": { "type": "array", "items": { "type": "string" }, "description": "Customer fields.\n" }, "customerTags": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getAssetsAssetCollectionItemVmwareVmCustomerTag:getAssetsAssetCollectionItemVmwareVmCustomerTag" }, "description": "Customer defined tags.\n" }, "faultToleranceBandwidth": { "type": "integer", "description": "Fault tolerance bandwidth.\n" }, "faultToleranceSecondaryLatency": { "type": "integer", "description": "Fault tolerance to secondary latency.\n" }, "faultToleranceState": { "type": "string", "description": "Fault tolerance state.\n" }, "instanceUuid": { "type": "string", "description": "vCenter-specific identifier of the virtual machine.\n" }, "isDisksCbtEnabled": { "type": "boolean", "description": "Indicates that change tracking is supported for virtual disks of this virtual machine. However, even if change tracking is supported, it might not be available for all disks of the virtual machine.\n" }, "isDisksUuidEnabled": { "type": "boolean", "description": "Whether changed block tracking for this VM's disk is active.\n" }, "path": { "type": "string", "description": "Path directory of the asset.\n" }, "vmwareToolsStatus": { "type": "string", "description": "VMware tools status.\n" } }, "type": "object", "required": [ "cluster", "customerFields", "customerTags", "faultToleranceBandwidth", "faultToleranceSecondaryLatency", "faultToleranceState", "instanceUuid", "isDisksCbtEnabled", "isDisksUuidEnabled", "path", "vmwareToolsStatus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsAssetCollectionItemVmwareVmCustomerTag:getAssetsAssetCollectionItemVmwareVmCustomerTag": { "properties": { "description": { "type": "string", "description": "The tag description.\n" }, "name": { "type": "string", "description": "The tag name.\n" } }, "type": "object", "required": [ "description", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getAssetsFilter:getAssetsFilter": { "properties": { "name": { "type": "string", "description": "The tag name.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getDiscoverySchedulesDiscoveryScheduleCollection:getDiscoverySchedulesDiscoveryScheduleCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getDiscoverySchedulesDiscoveryScheduleCollectionItem:getDiscoverySchedulesDiscoveryScheduleCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getDiscoverySchedulesDiscoveryScheduleCollectionItem:getDiscoverySchedulesDiscoveryScheduleCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "executionRecurrences": { "type": "string", "description": "Recurrence specification for the discovery schedule execution.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the discovery schedule.\n" }, "lifecycleDetails": { "type": "string", "description": "The detailed state of the discovery schedule.\n" }, "state": { "type": "string", "description": "The current state of the discovery schedule.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the discovery schedule was created in RFC3339 format.\n" }, "timeUpdated": { "type": "string", "description": "The time when the discovery schedule was last updated in RFC3339 format.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "executionRecurrences", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getDiscoverySchedulesFilter:getDiscoverySchedulesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getEnvironmentsEnvironmentCollection:getEnvironmentsEnvironmentCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getEnvironmentsEnvironmentCollectionItem:getEnvironmentsEnvironmentCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getEnvironmentsEnvironmentCollectionItem:getEnvironmentsEnvironmentCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "state": { "type": "string", "description": "A filter to return only resources where their lifecycleState matches the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the source environment was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the source environment was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getEnvironmentsFilter:getEnvironmentsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getInventoriesFilter:getInventoriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getInventoriesInventoryCollection:getInventoriesInventoryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getInventoriesInventoryCollectionItem:getInventoriesInventoryCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getInventoriesInventoryCollectionItem:getInventoriesInventoryCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "Inventory display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Inventory OCID.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "state": { "type": "string", "description": "A filter to return inventory if the lifecycleState matches the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}`\n" }, "timeCreated": { "type": "string", "description": "The time when the inventory was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the inventory was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getSupportedCloudRegionsFilter:getSupportedCloudRegionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudBridge/getSupportedCloudRegionsSupportedCloudRegionCollection:getSupportedCloudRegionsSupportedCloudRegionCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudBridge/getSupportedCloudRegionsSupportedCloudRegionCollectionItem:getSupportedCloudRegionsSupportedCloudRegionCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudBridge/getSupportedCloudRegionsSupportedCloudRegionCollectionItem:getSupportedCloudRegionsSupportedCloudRegionCollectionItem": { "properties": { "assetSourceType": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" } }, "type": "object", "required": [ "assetSourceType", "name", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/AdhocQueryAdhocQueryDetails:AdhocQueryAdhocQueryDetails": { "properties": { "adhocQueryResources": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/AdhocQueryAdhocQueryDetailsAdhocQueryResource:AdhocQueryAdhocQueryDetailsAdhocQueryResource" }, "description": "Target information in which adhoc query will be run\n", "willReplaceOnChanges": true }, "query": { "type": "string", "description": "The adhoc query expression that is run\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "adhocQueryResources", "query" ] }, "oci:CloudGuard/AdhocQueryAdhocQueryDetailsAdhocQueryResource:AdhocQueryAdhocQueryDetailsAdhocQueryResource": { "properties": { "region": { "type": "string", "description": "Region in which adhoc query needs to be run\n", "willReplaceOnChanges": true }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs on which query needs to be run\n", "willReplaceOnChanges": true }, "resourceType": { "type": "string", "description": "Type of resource\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "resourceIds", "resourceType" ] } } }, "oci:CloudGuard/AdhocQueryAdhocQueryRegionalDetail:AdhocQueryAdhocQueryRegionalDetail": { "properties": { "expectedCount": { "type": "string", "description": "Expected number of instances on which query should run\n" }, "expiredCount": { "type": "string", "description": "Number of instances on which query expired\n" }, "failedCount": { "type": "string", "description": "Number of instances on which query failed\n" }, "region": { "type": "string", "description": "Region name\n" }, "regionalError": { "type": "string", "description": "error message to show if adhoc query fails in a region\n" }, "regionalStatus": { "type": "string", "description": "adhoc query status of the region\n" }, "succeededCount": { "type": "string", "description": "Number of instances on which query succeeded\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "expectedCount", "expiredCount", "failedCount", "region", "regionalError", "regionalStatus", "succeededCount" ] } } }, "oci:CloudGuard/CloudGuardDataSourceDataSourceDetails:CloudGuardDataSourceDataSourceDetails": { "properties": { "additionalEntitiesCount": { "type": "integer", "description": "(Updatable) The additional entities count used for data source query\n" }, "dataSourceFeedProvider": { "type": "string", "description": "(Updatable) Type of data source feed provider (LoggingQuery)\n" }, "description": { "type": "string", "description": "(Updatable) Description text for the query\n" }, "intervalInMinutes": { "type": "integer", "description": "(Updatable) Interval in minutes that query is run periodically.\n" }, "intervalInSeconds": { "type": "integer", "description": "(Updatable) Interval in seconds which query is run periodically.\n" }, "loggingQueryDetails": { "$ref": "#/types/oci:CloudGuard/CloudGuardDataSourceDataSourceDetailsLoggingQueryDetails:CloudGuardDataSourceDataSourceDetailsLoggingQueryDetails", "description": "(Updatable) Details for a logging query for a data source.\n" }, "loggingQueryType": { "type": "string", "description": "(Updatable) Type of logging query for data source (Sighting/Insight)\n" }, "operator": { "type": "string", "description": "(Updatable) DEPRECATED - Operator used in data source\n" }, "query": { "type": "string", "description": "(Updatable) The continuous query expression that is run periodically.\n" }, "queryStartTime": { "$ref": "#/types/oci:CloudGuard/CloudGuardDataSourceDataSourceDetailsQueryStartTime:CloudGuardDataSourceDataSourceDetailsQueryStartTime", "description": "(Updatable) DEPRECATED - Start policy for continuous query\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of logging query regions\n" }, "scheduledQueryScopeDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/CloudGuardDataSourceDataSourceDetailsScheduledQueryScopeDetail:CloudGuardDataSourceDataSourceDetailsScheduledQueryScopeDetail" }, "description": "(Updatable) Target information in which scheduled query will be run\n" }, "threshold": { "type": "integer", "description": "(Updatable) DEPRECATED - The integer value that must be exceeded, fall below or equal to (depending on the operator), for the query result to trigger an event\n" } }, "type": "object", "required": [ "dataSourceFeedProvider" ], "language": { "nodejs": { "requiredOutputs": [ "additionalEntitiesCount", "dataSourceFeedProvider", "description", "intervalInMinutes", "intervalInSeconds", "loggingQueryDetails", "loggingQueryType", "operator", "query", "queryStartTime", "regions", "scheduledQueryScopeDetails", "threshold" ] } } }, "oci:CloudGuard/CloudGuardDataSourceDataSourceDetailsLoggingQueryDetails:CloudGuardDataSourceDataSourceDetailsLoggingQueryDetails": { "properties": { "keyEntitiesCount": { "type": "integer", "description": "(Updatable) The key entities count used for data source query\n" }, "loggingQueryType": { "type": "string", "description": "(Updatable) Logging query type for data source\n" } }, "type": "object", "required": [ "loggingQueryType" ], "language": { "nodejs": { "requiredOutputs": [ "keyEntitiesCount", "loggingQueryType" ] } } }, "oci:CloudGuard/CloudGuardDataSourceDataSourceDetailsQueryStartTime:CloudGuardDataSourceDataSourceDetailsQueryStartTime": { "properties": { "queryStartTime": { "type": "string", "description": "(Updatable) Time when the query can start. If not specified it can start immediately\n" }, "startPolicyType": { "type": "string", "description": "(Updatable) Start policy delay timing\n" } }, "type": "object", "required": [ "startPolicyType" ], "language": { "nodejs": { "requiredOutputs": [ "queryStartTime", "startPolicyType" ] } } }, "oci:CloudGuard/CloudGuardDataSourceDataSourceDetailsScheduledQueryScopeDetail:CloudGuardDataSourceDataSourceDetailsScheduledQueryScopeDetail": { "properties": { "region": { "type": "string", "description": "(Updatable) region on which scheduled query needs to be run\n" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of OCIDs on scheduled query needs to run\n" }, "resourceType": { "type": "string", "description": "(Updatable) Type of resource\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "resourceIds", "resourceType" ] } } }, "oci:CloudGuard/CloudGuardDataSourceDataSourceDetectorMappingInfo:CloudGuardDataSourceDataSourceDetectorMappingInfo": { "properties": { "detectorRecipeId": { "type": "string", "description": "ID of the detector recipe attached to the data source\n" }, "detectorRuleId": { "type": "string", "description": "ID of the detector rule attached to the data source\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "detectorRecipeId", "detectorRuleId" ] } } }, "oci:CloudGuard/CloudGuardDataSourceRegionStatusDetail:CloudGuardDataSourceRegionStatusDetail": { "properties": { "region": { "type": "string", "description": "Data source replication region\n" }, "status": { "type": "string", "description": "(Updatable) Enablement status of data source.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "region", "status" ] } } }, "oci:CloudGuard/DataMaskRuleTargetSelected:DataMaskRuleTargetSelected": { "properties": { "kind": { "type": "string", "description": "(Updatable) Kind of target selection to be used\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) Types of targets\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "kind" ], "language": { "nodejs": { "requiredOutputs": [ "kind", "values" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRule:DetectorRecipeDetectorRule": { "properties": { "candidateResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleCandidateResponderRule:DetectorRecipeDetectorRuleCandidateResponderRule" }, "description": "List of responder rules that can be used to remediate this detector rule\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "(Updatable) Detector recipe description.\n\nAvoid entering confidential information.\n" }, "details": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleDetails:DetectorRecipeDetectorRuleDetails", "description": "(Updatable) Parameters to be updated for a detector rule within a detector recipe.\n" }, "detector": { "type": "string", "description": "Detector for the rule\n" }, "detectorRuleId": { "type": "string", "description": "(Updatable) Detector recipe rule ID\n" }, "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleEntitiesMapping:DetectorRecipeDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "Resource type of the configuration to which the rule is applied\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleRuleType:DetectorRecipeDetectorRuleRuleType" }, "description": "Detector rule type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "required": [ "details", "detectorRuleId" ], "language": { "nodejs": { "requiredOutputs": [ "candidateResponderRules", "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleCandidateResponderRule:DetectorRecipeDetectorRuleCandidateResponderRule": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "isPreferred": { "type": "boolean", "description": "Is this the preferred state?\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "id", "isPreferred" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleDetails:DetectorRecipeDetectorRuleDetails": { "properties": { "condition": { "type": "string", "description": "(Updatable) The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfiguration:DetectorRecipeDetectorRuleDetailsConfiguration" }, "description": "(Updatable) List of detector rule configurations\n" }, "dataSourceId": { "type": "string", "description": "(Updatable) The unique identifier of the attached data source\n" }, "description": { "type": "string", "description": "(Updatable) Description for the detector rule\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleDetailsEntitiesMapping:DetectorRecipeDetectorRuleDetailsEntitiesMapping" }, "description": "(Updatable) Data source entities mapping for a detector rule\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Can the rule be configured?\n" }, "isEnabled": { "type": "boolean", "description": "(Updatable) Enablement status of the detector rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) User-defined labels for a detector rule\n" }, "recommendation": { "type": "string", "description": "(Updatable) Recommendation for the detector rule\n" }, "riskLevel": { "type": "string", "description": "(Updatable) The risk level of the detector rule\n" } }, "type": "object", "required": [ "isEnabled", "riskLevel" ], "language": { "nodejs": { "requiredOutputs": [ "condition", "configurations", "dataSourceId", "description", "entitiesMappings", "isConfigurationAllowed", "isEnabled", "labels", "recommendation", "riskLevel" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfiguration:DetectorRecipeDetectorRuleDetailsConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty:DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty" }, "description": "(Updatable) Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue:DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue" }, "description": "(Updatable) Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "(Updatable) Map property Value data type\n" }, "configKey": { "type": "string", "description": "(Updatable) Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "(Updatable) Configuration data type\n" }, "name": { "type": "string", "description": "(Updatable) Configuration name\n" }, "value": { "type": "string", "description": "(Updatable) Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfigurationValue:DetectorRecipeDetectorRuleDetailsConfigurationValue" }, "description": "(Updatable) List of configuration values\n" } }, "type": "object", "required": [ "configKey", "name" ], "language": { "nodejs": { "requiredOutputs": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty:DetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "(Updatable) Name for Additional Property, for example, \"interpreter\", \"router\"\n" }, "propertyType": { "type": "string", "description": "(Updatable) Property Type\n" }, "value": { "type": "string", "description": "(Updatable) Value for Property Name, for example, \"generic\", \"cloudguard\"\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "propertyType", "value" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue:DetectorRecipeDetectorRuleDetailsConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "(Updatable) key\n" }, "value": { "type": "string", "description": "(Updatable) value\n" } }, "type": "object", "required": [ "key", "value" ] }, "oci:CloudGuard/DetectorRecipeDetectorRuleDetailsConfigurationValue:DetectorRecipeDetectorRuleDetailsConfigurationValue": { "properties": { "listType": { "type": "string", "description": "(Updatable) Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "(Updatable) Type of content in the managed list\n" }, "value": { "type": "string", "description": "(Updatable) Configuration value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ] }, "oci:CloudGuard/DetectorRecipeDetectorRuleDetailsEntitiesMapping:DetectorRecipeDetectorRuleDetailsEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Display name of the entity\n" }, "entityType": { "type": "string", "description": "(Updatable) Type of entity\n" }, "queryField": { "type": "string", "description": "(Updatable) The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "queryField" ], "language": { "nodejs": { "requiredOutputs": [ "displayName", "entityType", "queryField" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleEntitiesMapping:DetectorRecipeDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "entityType", "queryField" ] } } }, "oci:CloudGuard/DetectorRecipeDetectorRuleRuleType:DetectorRecipeDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Detector rule type value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "values" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRule:DetectorRecipeEffectiveDetectorRule": { "properties": { "candidateResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleCandidateResponderRule:DetectorRecipeEffectiveDetectorRuleCandidateResponderRule" }, "description": "List of responder rules that can be used to remediate this detector rule\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "(Updatable) Detector recipe description.\n\nAvoid entering confidential information.\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetail:DetectorRecipeEffectiveDetectorRuleDetail" }, "description": "Detailed information for a detector.\n" }, "detector": { "type": "string", "description": "Detector for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule.\n" }, "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleEntitiesMapping:DetectorRecipeEffectiveDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "Resource type of the configuration to which the rule is applied\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleRuleType:DetectorRecipeEffectiveDetectorRuleRuleType" }, "description": "Detector rule type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "candidateResponderRules", "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleCandidateResponderRule:DetectorRecipeEffectiveDetectorRuleCandidateResponderRule": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "isPreferred": { "type": "boolean", "description": "Is this the preferred state?\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "id", "isPreferred" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetail:DetectorRecipeEffectiveDetectorRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfiguration:DetectorRecipeEffectiveDetectorRuleDetailConfiguration" }, "description": "List of detector rule configurations\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "(Updatable) Detector recipe description.\n\nAvoid entering confidential information.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping:DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Can the rule be configured?\n" }, "isEnabled": { "type": "boolean", "description": "Enablement status for the rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "riskLevel": { "type": "string", "description": "The risk level for the rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "configurations", "dataSourceId", "description", "entitiesMappings", "isConfigurationAllowed", "isEnabled", "labels", "recommendation", "riskLevel" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfiguration:DetectorRecipeEffectiveDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:DetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:DetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Detector rule type value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:DetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "propertyType", "value" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:DetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:DetectorRecipeEffectiveDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listType", "managedListType", "value" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping:DetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "entityType", "queryField" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleEntitiesMapping:DetectorRecipeEffectiveDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Detector recipe display name.\n\nAvoid entering confidential information.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "entityType", "queryField" ] } } }, "oci:CloudGuard/DetectorRecipeEffectiveDetectorRuleRuleType:DetectorRecipeEffectiveDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Detector rule type value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "values" ] } } }, "oci:CloudGuard/ResponderRecipeEffectiveResponderRule:ResponderRecipeEffectiveResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) Compartment OCID\n" }, "description": { "type": "string", "description": "(Updatable) Responder recipe description.\n\nAvoid entering confidential information.\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/ResponderRecipeEffectiveResponderRuleDetail:ResponderRecipeEffectiveResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "(Updatable) Responder recipe display name.\n\nAvoid entering confidential information.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The current lifecycle state of the example\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ] } } }, "oci:CloudGuard/ResponderRecipeEffectiveResponderRuleDetail:ResponderRecipeEffectiveResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/ResponderRecipeEffectiveResponderRuleDetailConfiguration:ResponderRecipeEffectiveResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "configurations", "isEnabled", "mode" ] } } }, "oci:CloudGuard/ResponderRecipeEffectiveResponderRuleDetailConfiguration:ResponderRecipeEffectiveResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configKey", "name", "value" ] } } }, "oci:CloudGuard/ResponderRecipeResponderRule:ResponderRecipeResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) Compartment OCID\n" }, "description": { "type": "string", "description": "(Updatable) Responder recipe description.\n\nAvoid entering confidential information.\n" }, "details": { "$ref": "#/types/oci:CloudGuard/ResponderRecipeResponderRuleDetails:ResponderRecipeResponderRuleDetails", "description": "(Updatable) Parameters to be updated for a responder rule within a responder recipe.\n" }, "displayName": { "type": "string", "description": "(Updatable) Responder recipe display name.\n\nAvoid entering confidential information.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "(Updatable) Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The current lifecycle state of the example\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "details", "responderRuleId" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ] } } }, "oci:CloudGuard/ResponderRecipeResponderRuleDetails:ResponderRecipeResponderRuleDetails": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/ResponderRecipeResponderRuleDetailsConfiguration:ResponderRecipeResponderRuleDetailsConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "(Updatable) Enablement state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "isEnabled" ], "language": { "nodejs": { "requiredOutputs": [ "condition", "configurations", "isEnabled", "mode" ] } } }, "oci:CloudGuard/ResponderRecipeResponderRuleDetailsConfiguration:ResponderRecipeResponderRuleDetailsConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configKey", "name", "value" ] } } }, "oci:CloudGuard/TargetTargetDetail:TargetTargetDetail": { "properties": { "securityZoneDisplayName": { "type": "string", "description": "The name of the security zone to associate with this compartment.\n" }, "securityZoneId": { "type": "string", "description": "The OCID of the security zone to associate with this compartment\n" }, "targetResourceType": { "type": "string", "description": "Type of resource that target support (COMPARTMENT/FACLOUD)\n" }, "targetSecurityZoneRecipes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetailTargetSecurityZoneRecipe:TargetTargetDetailTargetSecurityZoneRecipe" }, "description": "The list of security zone recipes to associate with this compartment\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityZoneDisplayName", "securityZoneId", "targetResourceType", "targetSecurityZoneRecipes" ] } } }, "oci:CloudGuard/TargetTargetDetailTargetSecurityZoneRecipe:TargetTargetDetailTargetSecurityZoneRecipe": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID where the resource is created\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n\nAvoid entering confidential information.\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "securityPolicies": { "type": "array", "items": { "type": "string" }, "description": "The list of security policy IDs that are included in the recipe\n" }, "state": { "type": "string", "description": "(Updatable) The enablement state of the detector rule\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "owner", "securityPolicies", "state", "systemTags", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipe:TargetTargetDetectorRecipe": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID where the resource is created\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRecipeId": { "type": "string", "description": "Unique identifier for the target detector recipe\n", "willReplaceOnChanges": true }, "detectorRecipeType": { "type": "string", "description": "Recipe type ( STANDARD, ENTERPRISE )\n" }, "detectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRule:TargetTargetDetectorRecipeDetectorRule" }, "description": "(Updatable) List of overrides to be applied to detector rules associated with the target\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "effectiveDetectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRule:TargetTargetDetectorRecipeEffectiveDetectorRule" }, "description": "List of currently enabled detector rules for the detector type for recipe after applying defaults\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "state": { "type": "string", "description": "(Updatable) The enablement state of the detector rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "detectorRecipeId" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "description", "detector", "detectorRecipeId", "detectorRecipeType", "detectorRules", "displayName", "effectiveDetectorRules", "id", "owner", "state", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRule:TargetTargetDetectorRecipeDetectorRule": { "properties": { "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "details": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetails:TargetTargetDetectorRecipeDetectorRuleDetails", "description": "(Updatable) Parameters to update detector rule configuration details in a detector recipe attached to a target.\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRuleId": { "type": "string", "description": "(Updatable) Unique identifier for the detector rule\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleEntitiesMapping:TargetTargetDetectorRecipeDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for a detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for TargetDetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleRuleType:TargetTargetDetectorRecipeDetectorRuleRuleType" }, "description": "Rule category type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "(Updatable) The enablement state of the detector rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "details", "detectorRuleId" ], "language": { "nodejs": { "requiredOutputs": [ "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetails:TargetTargetDetectorRecipeDetectorRuleDetails": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConditionGroup:TargetTargetDetectorRecipeDetectorRuleDetailsConditionGroup" }, "description": "(Updatable) Condition group corresponding to each compartment\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfiguration:TargetTargetDetectorRecipeDetectorRuleDetailsConfiguration" }, "description": "List of responder rule configurations\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Configuration allowed or not\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "riskLevel": { "type": "string", "description": "The risk level of the detector rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionGroups", "configurations", "isConfigurationAllowed", "isEnabled", "labels", "riskLevel" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConditionGroup:TargetTargetDetectorRecipeDetectorRuleDetailsConditionGroup": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) Compartment OCID associated with condition\n" }, "condition": { "type": "string", "description": "(Updatable) The base condition resource.\n" } }, "type": "object", "required": [ "compartmentId", "condition" ] }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfiguration:TargetTargetDetectorRecipeDetectorRuleDetailsConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty:TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAllowedValue:TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationValue:TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty:TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "propertyType", "value" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAllowedValue:TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationValue:TargetTargetDetectorRecipeDetectorRuleDetailsConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listType", "managedListType", "value" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleEntitiesMapping:TargetTargetDetectorRecipeDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "entityType", "queryField" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeDetectorRuleRuleType:TargetTargetDetectorRecipeDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "values" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRule:TargetTargetDetectorRecipeEffectiveDetectorRule": { "properties": { "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetail:TargetTargetDetectorRecipeEffectiveDetectorRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping:TargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for a detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for TargetDetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleRuleType:TargetTargetDetectorRecipeEffectiveDetectorRuleRuleType" }, "description": "Rule category type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "(Updatable) The enablement state of the detector rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetail:TargetTargetDetectorRecipeEffectiveDetectorRuleDetail": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup" }, "description": "Condition group corresponding to each compartment\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Configuration allowed or not\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "riskLevel": { "type": "string", "description": "The risk level of the detector rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "conditionGroups", "configurations", "isConfigurationAllowed", "isEnabled", "labels", "riskLevel" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID where the resource is created\n" }, "condition": { "type": "string", "description": "The base condition resource.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "condition" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "propertyType", "value" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:TargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "listType", "managedListType", "value" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping:TargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "entityType", "queryField" ] } } }, "oci:CloudGuard/TargetTargetDetectorRecipeEffectiveDetectorRuleRuleType:TargetTargetDetectorRecipeEffectiveDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "values" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipe:TargetTargetResponderRecipe": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID where the resource is created\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "effectiveResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetResponderRecipeEffectiveResponderRule:TargetTargetResponderRecipeEffectiveResponderRule" }, "description": "List of currently enabled responder rules for the responder type for recipe after applying defaults\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "responderRecipeId": { "type": "string", "description": "Unique identifier for responder recipe\n", "willReplaceOnChanges": true }, "responderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetResponderRecipeResponderRule:TargetTargetResponderRecipeResponderRule" }, "description": "(Updatable) List of overrides to be applied to responder rules associated with the target\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "responderRecipeId" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "description", "displayName", "effectiveResponderRules", "id", "owner", "responderRecipeId", "responderRules", "timeCreated", "timeUpdated" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipeEffectiveResponderRule:TargetTargetResponderRecipeEffectiveResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID where the resource is created\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetResponderRecipeEffectiveResponderRuleDetail:TargetTargetResponderRecipeEffectiveResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "(Updatable) The enablement state of the detector rule\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipeEffectiveResponderRuleDetail:TargetTargetResponderRecipeEffectiveResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration:TargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "configurations", "isEnabled", "mode" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration:TargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configKey", "name", "value" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipeResponderRule:TargetTargetResponderRecipeResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID where the resource is created\n" }, "description": { "type": "string", "description": "The target description.\n\nAvoid entering confidential information.\n" }, "details": { "$ref": "#/types/oci:CloudGuard/TargetTargetResponderRecipeResponderRuleDetails:TargetTargetResponderRecipeResponderRuleDetails", "description": "(Updatable) Parameters to update details for a responder rule for a target responder recipe. TargetResponderRuleDetails contains all configurations associated with the ResponderRule, whereas UpdateTargetResponderRecipeResponderRuleDetails refers to the details that are to be updated for ResponderRule.\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for the target.\n\nAvoid entering confidential information.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "(Updatable) Unique identifier for target detector recipe\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" }, "state": { "type": "string", "description": "(Updatable) The enablement state of the detector rule\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "details", "responderRuleId" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipeResponderRuleDetails:TargetTargetResponderRecipeResponderRuleDetails": { "properties": { "condition": { "type": "string", "description": "(Updatable) The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/TargetTargetResponderRecipeResponderRuleDetailsConfiguration:TargetTargetResponderRecipeResponderRuleDetailsConfiguration" }, "description": "(Updatable) List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "(Updatable) Execution mode for the responder rule\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "condition", "configurations", "isEnabled", "mode" ] } } }, "oci:CloudGuard/TargetTargetResponderRecipeResponderRuleDetailsConfiguration:TargetTargetResponderRecipeResponderRuleDetailsConfiguration": { "properties": { "configKey": { "type": "string", "description": "(Updatable) Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "(Updatable) Configuration name\n" }, "value": { "type": "string", "description": "(Updatable) Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ] }, "oci:CloudGuard/getAdhocQueriesAdhocQueryCollection:getAdhocQueriesAdhocQueryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItem:getAdhocQueriesAdhocQueryCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItem:getAdhocQueriesAdhocQueryCollectionItem": { "properties": { "adhocQueryDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetail:getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetail" }, "description": "Detailed information about the adhoc query.\n" }, "adhocQueryRegionalDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItemAdhocQueryRegionalDetail:getAdhocQueriesAdhocQueryCollectionItemAdhocQueryRegionalDetail" }, "description": "Instance level status for each region\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "errorMessage": { "type": "string", "description": "Error message to show on UI in case of failure\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "OCID for the adhoc query\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource.\n" }, "status": { "type": "string", "description": "Status of the adhoc query\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the adhoc query was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the adhoc query was updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "adhocQueryDetails", "adhocQueryRegionalDetails", "compartmentId", "definedTags", "errorMessage", "freeformTags", "id", "state", "status", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetail:getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetail": { "properties": { "adhocQueryResources": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetailAdhocQueryResource:getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetailAdhocQueryResource" }, "description": "Target information in which adhoc query will be run\n" }, "query": { "type": "string", "description": "The adhoc query expression that is run\n" } }, "type": "object", "required": [ "adhocQueryResources", "query" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetailAdhocQueryResource:getAdhocQueriesAdhocQueryCollectionItemAdhocQueryDetailAdhocQueryResource": { "properties": { "region": { "type": "string", "description": "Region name\n" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs on which query needs to be run\n" }, "resourceType": { "type": "string", "description": "Type of resource\n" } }, "type": "object", "required": [ "region", "resourceIds", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueriesAdhocQueryCollectionItemAdhocQueryRegionalDetail:getAdhocQueriesAdhocQueryCollectionItemAdhocQueryRegionalDetail": { "properties": { "expectedCount": { "type": "string", "description": "Expected number of instances on which query should run\n" }, "expiredCount": { "type": "string", "description": "Number of instances on which query expired\n" }, "failedCount": { "type": "string", "description": "Number of instances on which query failed\n" }, "region": { "type": "string", "description": "Region name\n" }, "regionalError": { "type": "string", "description": "error message to show if adhoc query fails in a region\n" }, "regionalStatus": { "type": "string", "description": "adhoc query status of the region\n" }, "succeededCount": { "type": "string", "description": "Number of instances on which query succeeded\n" } }, "type": "object", "required": [ "expectedCount", "expiredCount", "failedCount", "region", "regionalError", "regionalStatus", "succeededCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueriesFilter:getAdhocQueriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getAdhocQueryAdhocQueryDetail:getAdhocQueryAdhocQueryDetail": { "properties": { "adhocQueryResources": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getAdhocQueryAdhocQueryDetailAdhocQueryResource:getAdhocQueryAdhocQueryDetailAdhocQueryResource" }, "description": "Target information in which adhoc query will be run\n" }, "query": { "type": "string", "description": "The adhoc query expression that is run\n" } }, "type": "object", "required": [ "adhocQueryResources", "query" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueryAdhocQueryDetailAdhocQueryResource:getAdhocQueryAdhocQueryDetailAdhocQueryResource": { "properties": { "region": { "type": "string", "description": "Region name\n" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs on which query needs to be run\n" }, "resourceType": { "type": "string", "description": "Type of resource\n" } }, "type": "object", "required": [ "region", "resourceIds", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getAdhocQueryAdhocQueryRegionalDetail:getAdhocQueryAdhocQueryRegionalDetail": { "properties": { "expectedCount": { "type": "string", "description": "Expected number of instances on which query should run\n" }, "expiredCount": { "type": "string", "description": "Number of instances on which query expired\n" }, "failedCount": { "type": "string", "description": "Number of instances on which query failed\n" }, "region": { "type": "string", "description": "Region name\n" }, "regionalError": { "type": "string", "description": "error message to show if adhoc query fails in a region\n" }, "regionalStatus": { "type": "string", "description": "adhoc query status of the region\n" }, "succeededCount": { "type": "string", "description": "Number of instances on which query succeeded\n" } }, "type": "object", "required": [ "expectedCount", "expiredCount", "failedCount", "region", "regionalError", "regionalStatus", "succeededCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataMaskRuleTargetSelected:getDataMaskRuleTargetSelected": { "properties": { "kind": { "type": "string", "description": "Kind of target selection to be used\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Types of targets\n" } }, "type": "object", "required": [ "kind", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataMaskRulesDataMaskRuleCollection:getDataMaskRulesDataMaskRuleCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataMaskRulesDataMaskRuleCollectionItem:getDataMaskRulesDataMaskRuleCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataMaskRulesDataMaskRuleCollectionItem:getDataMaskRulesDataMaskRuleCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "dataMaskCategories": { "type": "array", "items": { "type": "string" }, "description": "List of data mask rule categories\n" }, "dataMaskRuleStatus": { "type": "string", "description": "The status of the data mask rule\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "The data mask rule description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "iamGroupId": { "type": "string", "description": "OCID of the IAM group\n" }, "id": { "type": "string", "description": "Unique identifier that can't be changed after creation\n" }, "lifecyleDetails": { "type": "string", "description": "Additional details on the substate of the lifecycle state [DEPRECATE]\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetSelecteds": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataMaskRulesDataMaskRuleCollectionItemTargetSelected:getDataMaskRulesDataMaskRuleCollectionItemTargetSelected" }, "description": "Specification of how targets are to be selected (select ALL, or select by TargetResourceType or TargetId).\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "dataMaskCategories", "dataMaskRuleStatus", "definedTags", "description", "displayName", "freeformTags", "iamGroupId", "id", "lifecyleDetails", "state", "systemTags", "targetSelecteds", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataMaskRulesDataMaskRuleCollectionItemTargetSelected:getDataMaskRulesDataMaskRuleCollectionItemTargetSelected": { "properties": { "kind": { "type": "string", "description": "Kind of target selection to be used\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Types of targets\n" } }, "type": "object", "required": [ "kind", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataMaskRulesFilter:getDataMaskRulesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Types of targets\n" } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getDataSourceDataSourceDetail:getDataSourceDataSourceDetail": { "properties": { "additionalEntitiesCount": { "type": "integer", "description": "The additional entities count used for data source query\n" }, "dataSourceFeedProvider": { "type": "string", "description": "Possible type of dataSourceFeed Provider(LoggingQuery)\n" }, "description": { "type": "string", "description": "Description text for the query\n" }, "intervalInMinutes": { "type": "integer", "description": "Interval in minutes that query is run periodically.\n" }, "intervalInSeconds": { "type": "integer", "description": "Interval in seconds which query is run periodically.\n" }, "loggingQueryDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourceDataSourceDetailLoggingQueryDetail:getDataSourceDataSourceDetailLoggingQueryDetail" }, "description": "Details for a logging query for a data source.\n" }, "loggingQueryType": { "type": "string", "description": "Type of logging query for data source (Sighting/Insight)\n" }, "operator": { "type": "string", "description": "DEPRECATED - Operator used in data source\n" }, "query": { "type": "string", "description": "The continuous query expression that is run periodically.\n" }, "queryStartTimes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourceDataSourceDetailQueryStartTime:getDataSourceDataSourceDetailQueryStartTime" }, "description": "Time when the query can start. If not specified it can start immediately\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of logging query regions\n" }, "scheduledQueryScopeDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourceDataSourceDetailScheduledQueryScopeDetail:getDataSourceDataSourceDetailScheduledQueryScopeDetail" }, "description": "Target information in which scheduled query will be run\n" }, "threshold": { "type": "integer", "description": "DEPRECATED - The integer value that must be exceeded, fall below or equal to (depending on the operator), for the query result to trigger an event\n" } }, "type": "object", "required": [ "additionalEntitiesCount", "dataSourceFeedProvider", "description", "intervalInMinutes", "intervalInSeconds", "loggingQueryDetails", "loggingQueryType", "operator", "query", "queryStartTimes", "regions", "scheduledQueryScopeDetails", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceDataSourceDetailLoggingQueryDetail:getDataSourceDataSourceDetailLoggingQueryDetail": { "properties": { "keyEntitiesCount": { "type": "integer", "description": "The key entities count used for data source query\n" }, "loggingQueryType": { "type": "string", "description": "Type of logging query for data source (Sighting/Insight)\n" } }, "type": "object", "required": [ "keyEntitiesCount", "loggingQueryType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceDataSourceDetailQueryStartTime:getDataSourceDataSourceDetailQueryStartTime": { "properties": { "queryStartTime": { "type": "string", "description": "Time when the query can start. If not specified it can start immediately\n" }, "startPolicyType": { "type": "string", "description": "Start policy delay timing\n" } }, "type": "object", "required": [ "queryStartTime", "startPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceDataSourceDetailScheduledQueryScopeDetail:getDataSourceDataSourceDetailScheduledQueryScopeDetail": { "properties": { "region": { "type": "string", "description": "Data source replication region\n" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs on scheduled query needs to run\n" }, "resourceType": { "type": "string", "description": "Type of resource\n" } }, "type": "object", "required": [ "region", "resourceIds", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceDataSourceDetectorMappingInfo:getDataSourceDataSourceDetectorMappingInfo": { "properties": { "detectorRecipeId": { "type": "string", "description": "ID of the detector recipe attached to the data source\n" }, "detectorRuleId": { "type": "string", "description": "ID of the detector rule attached to the data source\n" } }, "type": "object", "required": [ "detectorRecipeId", "detectorRuleId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceEventItem:getDataSourceEventItem": { "properties": { "comments": { "type": "string", "description": "Data source event comments\n" }, "dataSourceId": { "type": "string", "description": "DataSource OCID\n" }, "eventDate": { "type": "string", "description": "Data source event date time\n" }, "eventInfos": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourceEventItemEventInfo:getDataSourceEventItemEventInfo" }, "description": "Event info of a data source.\n" }, "region": { "type": "string", "description": "A filter to return only resource their region matches the given region.\n" }, "status": { "type": "string", "description": "Current data source event info status\n" }, "timeCreated": { "type": "string", "description": "Data source event created time\n" } }, "type": "object", "required": [ "comments", "dataSourceId", "eventDate", "eventInfos", "region", "status", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceEventItemEventInfo:getDataSourceEventItemEventInfo": { "properties": { "dataSourceFeedProvider": { "type": "string", "description": "Possible type of dataSourceFeed Provider(LoggingQuery)\n" }, "logResult": { "type": "string" }, "observedValue": { "type": "string" }, "operator": { "type": "string" }, "triggerValue": { "type": "string" } }, "type": "object", "required": [ "dataSourceFeedProvider", "logResult", "observedValue", "operator", "triggerValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceEventsDataSourceEventCollection:getDataSourceEventsDataSourceEventCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourceEventsDataSourceEventCollectionItem:getDataSourceEventsDataSourceEventCollectionItem" }, "description": "List of events related to a data source\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceEventsDataSourceEventCollectionItem:getDataSourceEventsDataSourceEventCollectionItem": { "properties": { "comments": { "type": "string", "description": "Data source event comments\n" }, "dataSourceId": { "type": "string", "description": "Data source OCID.\n" }, "eventDate": { "type": "string", "description": "Data source event date and time\n" }, "eventInfos": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourceEventsDataSourceEventCollectionItemEventInfo:getDataSourceEventsDataSourceEventCollectionItemEventInfo" }, "description": "This resource can have multiple subtypes, depending on the dataSourceFeedProvider value. For example, if dataSourceFeedProvider is LOGGINGQUERY, this resource will be of type LoggingEventInfo.\n" }, "region": { "type": "string", "description": "A filter to return only resource where their region matches the given region.\n" }, "status": { "type": "string", "description": "Current data source event info status\n" }, "timeCreated": { "type": "string", "description": "Data source event creation date and time\n" } }, "type": "object", "required": [ "comments", "dataSourceId", "eventDate", "eventInfos", "region", "status", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceEventsDataSourceEventCollectionItemEventInfo:getDataSourceEventsDataSourceEventCollectionItemEventInfo": { "properties": { "dataSourceFeedProvider": { "type": "string", "description": "Possible type of dataSourceFeed Provider (LoggingQuery)\n" }, "logResult": { "type": "string", "description": "Log result details of DataSource for a Problem\n" }, "observedValue": { "type": "string", "description": "Observed value of DataSource for a Problem\n" }, "operator": { "type": "string", "description": "Operator details of DataSource for a Problem\n" }, "triggerValue": { "type": "string", "description": "Triggered value of DataSource for a Problem\n" } }, "type": "object", "required": [ "dataSourceFeedProvider", "logResult", "observedValue", "operator", "triggerValue" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourceEventsFilter:getDataSourceEventsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getDataSourceRegionStatusDetail:getDataSourceRegionStatusDetail": { "properties": { "region": { "type": "string", "description": "Data source replication region\n" }, "status": { "type": "string", "description": "Enablement status of the data source\n" } }, "type": "object", "required": [ "region", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollection:getDataSourcesDataSourceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItem:getDataSourcesDataSourceCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItem:getDataSourcesDataSourceCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "dataSourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetail:getDataSourcesDataSourceCollectionItemDataSourceDetail" }, "description": "Details specific to the data source type.\n" }, "dataSourceDetectorMappingInfos": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetectorMappingInfo:getDataSourcesDataSourceCollectionItemDataSourceDetectorMappingInfo" }, "description": "Information about the detector recipe and rule attached\n" }, "dataSourceFeedProvider": { "type": "string", "description": "A filter to return only resources when their feed provider matches the given feed provider (`DataSourceFeedProvider` resource).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "OCID for the data source\n" }, "regionStatusDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItemRegionStatusDetail:getDataSourcesDataSourceCollectionItemRegionStatusDetail" }, "description": "Information about the region and status of query replication\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "status": { "type": "string", "description": "Enablement status of the data source\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the Data source was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the data source was updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "dataSourceDetails", "dataSourceDetectorMappingInfos", "dataSourceFeedProvider", "definedTags", "displayName", "freeformTags", "id", "regionStatusDetails", "state", "status", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetail:getDataSourcesDataSourceCollectionItemDataSourceDetail": { "properties": { "additionalEntitiesCount": { "type": "integer", "description": "The additional entities count used for data source query\n" }, "dataSourceFeedProvider": { "type": "string", "description": "A filter to return only resources when their feed provider matches the given feed provider (`DataSourceFeedProvider` resource).\n" }, "description": { "type": "string", "description": "Description text for the query\n" }, "intervalInMinutes": { "type": "integer", "description": "Interval in minutes that query is run periodically.\n" }, "intervalInSeconds": { "type": "integer", "description": "Interval in seconds which query is run periodically.\n" }, "loggingQueryDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetailLoggingQueryDetail:getDataSourcesDataSourceCollectionItemDataSourceDetailLoggingQueryDetail" }, "description": "Details for a logging query for a data source.\n" }, "loggingQueryType": { "type": "string", "description": "A filter to return only resources where their query type matches the given LoggingQueryType.\n" }, "operator": { "type": "string", "description": "DEPRECATED - Operator used in data source\n" }, "query": { "type": "string", "description": "The continuous query expression that is run periodically.\n" }, "queryStartTimes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetailQueryStartTime:getDataSourcesDataSourceCollectionItemDataSourceDetailQueryStartTime" }, "description": "Time when the query can start. If not specified it can start immediately\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "List of logging query regions\n" }, "scheduledQueryScopeDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetailScheduledQueryScopeDetail:getDataSourcesDataSourceCollectionItemDataSourceDetailScheduledQueryScopeDetail" }, "description": "Target information in which scheduled query will be run\n" }, "threshold": { "type": "integer", "description": "DEPRECATED - The integer value that must be exceeded, fall below or equal to (depending on the operator), for the query result to trigger an event\n" } }, "type": "object", "required": [ "additionalEntitiesCount", "dataSourceFeedProvider", "description", "intervalInMinutes", "intervalInSeconds", "loggingQueryDetails", "loggingQueryType", "operator", "query", "queryStartTimes", "regions", "scheduledQueryScopeDetails", "threshold" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetailLoggingQueryDetail:getDataSourcesDataSourceCollectionItemDataSourceDetailLoggingQueryDetail": { "properties": { "keyEntitiesCount": { "type": "integer", "description": "The key entities count used for data source query\n" }, "loggingQueryType": { "type": "string", "description": "A filter to return only resources where their query type matches the given LoggingQueryType.\n" } }, "type": "object", "required": [ "keyEntitiesCount", "loggingQueryType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetailQueryStartTime:getDataSourcesDataSourceCollectionItemDataSourceDetailQueryStartTime": { "properties": { "queryStartTime": { "type": "string", "description": "Time when the query can start. If not specified it can start immediately\n" }, "startPolicyType": { "type": "string", "description": "Start policy delay timing\n" } }, "type": "object", "required": [ "queryStartTime", "startPolicyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetailScheduledQueryScopeDetail:getDataSourcesDataSourceCollectionItemDataSourceDetailScheduledQueryScopeDetail": { "properties": { "region": { "type": "string", "description": "Data source replication region\n" }, "resourceIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs on scheduled query needs to run\n" }, "resourceType": { "type": "string", "description": "Type of resource\n" } }, "type": "object", "required": [ "region", "resourceIds", "resourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItemDataSourceDetectorMappingInfo:getDataSourcesDataSourceCollectionItemDataSourceDetectorMappingInfo": { "properties": { "detectorRecipeId": { "type": "string", "description": "ID of the detector recipe attached to the data source\n" }, "detectorRuleId": { "type": "string", "description": "ID of the detector rule attached to the data source\n" } }, "type": "object", "required": [ "detectorRecipeId", "detectorRuleId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesDataSourceCollectionItemRegionStatusDetail:getDataSourcesDataSourceCollectionItemRegionStatusDetail": { "properties": { "region": { "type": "string", "description": "Data source replication region\n" }, "status": { "type": "string", "description": "Enablement status of the data source\n" } }, "type": "object", "required": [ "region", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDataSourcesFilter:getDataSourcesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getDetectorRecipeDetectorRule:getDetectorRecipeDetectorRule": { "properties": { "candidateResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleCandidateResponderRule:getDetectorRecipeDetectorRuleCandidateResponderRule" }, "description": "List of responder rules that can be used to remediate this detector rule\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleDetail:getDetectorRecipeDetectorRuleDetail" }, "description": "Detailed information for a detector.\n" }, "detector": { "type": "string", "description": "Detector recipe for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule.\n" }, "displayName": { "type": "string", "description": "Display name of the entity\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleEntitiesMapping:getDetectorRecipeDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "Resource type of the configuration to which the rule is applied\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleRuleType:getDetectorRecipeDetectorRuleRuleType" }, "description": "Detector rule type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "required": [ "candidateResponderRules", "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleCandidateResponderRule:getDetectorRecipeDetectorRuleCandidateResponderRule": { "properties": { "displayName": { "type": "string", "description": "Display name of the entity\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "isPreferred": { "type": "boolean", "description": "Is this the preferred state?\n" } }, "type": "object", "required": [ "displayName", "id", "isPreferred" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleDetail:getDetectorRecipeDetectorRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfiguration:getDetectorRecipeDetectorRuleDetailConfiguration" }, "description": "List of detector rule configurations\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleDetailEntitiesMapping:getDetectorRecipeDetectorRuleDetailEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Can the rule be configured?\n" }, "isEnabled": { "type": "boolean", "description": "Enablement status for the rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "riskLevel": { "type": "string", "description": "The risk level for the rule\n" } }, "type": "object", "required": [ "condition", "configurations", "dataSourceId", "description", "entitiesMappings", "isConfigurationAllowed", "isEnabled", "labels", "recommendation", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfiguration:getDetectorRecipeDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipeDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Detector rule type value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfigurationValue:getDetectorRecipeDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipeDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleDetailConfigurationValue:getDetectorRecipeDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleDetailEntitiesMapping:getDetectorRecipeDetectorRuleDetailEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "Display name of the entity\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleEntitiesMapping:getDetectorRecipeDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "Display name of the entity\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeDetectorRuleRuleType:getDetectorRecipeDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRule:getDetectorRecipeEffectiveDetectorRule": { "properties": { "candidateResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleCandidateResponderRule:getDetectorRecipeEffectiveDetectorRuleCandidateResponderRule" }, "description": "List of responder rules that can be used to remediate this detector rule\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetail:getDetectorRecipeEffectiveDetectorRuleDetail" }, "description": "Detailed information for a detector.\n" }, "detector": { "type": "string", "description": "Detector recipe for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule.\n" }, "displayName": { "type": "string", "description": "Display name of the entity\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleEntitiesMapping:getDetectorRecipeEffectiveDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "Resource type of the configuration to which the rule is applied\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleRuleType:getDetectorRecipeEffectiveDetectorRuleRuleType" }, "description": "Detector rule type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "required": [ "candidateResponderRules", "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleCandidateResponderRule:getDetectorRecipeEffectiveDetectorRuleCandidateResponderRule": { "properties": { "displayName": { "type": "string", "description": "Display name of the entity\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "isPreferred": { "type": "boolean", "description": "Is this the preferred state?\n" } }, "type": "object", "required": [ "displayName", "id", "isPreferred" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetail:getDetectorRecipeEffectiveDetectorRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfiguration:getDetectorRecipeEffectiveDetectorRuleDetailConfiguration" }, "description": "List of detector rule configurations\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping:getDetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Can the rule be configured?\n" }, "isEnabled": { "type": "boolean", "description": "Enablement status for the rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "riskLevel": { "type": "string", "description": "The risk level for the rule\n" } }, "type": "object", "required": [ "condition", "configurations", "dataSourceId", "description", "entitiesMappings", "isConfigurationAllowed", "isEnabled", "labels", "recommendation", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfiguration:getDetectorRecipeEffectiveDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Detector rule type value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:getDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:getDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping:getDetectorRecipeEffectiveDetectorRuleDetailEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "Display name of the entity\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleEntitiesMapping:getDetectorRecipeEffectiveDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "Display name of the entity\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipeEffectiveDetectorRuleRuleType:getDetectorRecipeEffectiveDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollection:getDetectorRecipesDetectorRecipeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItem:getDetectorRecipesDetectorRecipeCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItem:getDetectorRecipesDetectorRecipeCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "detector": { "type": "string", "description": "Detector recipe for the rule\n" }, "detectorRecipeType": { "type": "string", "description": "Recipe type ( STANDARD, ENTERPRISE )\n" }, "detectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRule:getDetectorRecipesDetectorRecipeCollectionItemDetectorRule" }, "description": "List of detector rules for the detector type for recipe - user input\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "effectiveDetectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule" }, "description": "List of effective detector rules for the detector type for recipe after applying defaults\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "owner": { "type": "string", "description": "Owner of detector recipe\n" }, "sourceDetectorRecipeId": { "type": "string", "description": "Recipe OCID of the source recipe to be cloned\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetIds": { "type": "array", "items": { "type": "string" }, "description": "List of target IDs to which the recipe is attached\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "detector", "detectorRecipeType", "detectorRules", "displayName", "effectiveDetectorRules", "freeformTags", "id", "owner", "sourceDetectorRecipeId", "state", "systemTags", "targetIds", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRule:getDetectorRecipesDetectorRecipeCollectionItemDetectorRule": { "properties": { "candidateResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule" }, "description": "List of responder rules that can be used to remediate this detector rule\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail" }, "description": "Detailed information for a detector.\n" }, "detector": { "type": "string", "description": "Detector recipe for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "Resource type of the configuration to which the rule is applied\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleRuleType:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleRuleType" }, "description": "Detector rule type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "required": [ "candidateResponderRules", "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleCandidateResponderRule": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "isPreferred": { "type": "boolean", "description": "Is this the preferred state?\n" } }, "type": "object", "required": [ "displayName", "id", "isPreferred" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration" }, "description": "List of detector rule configurations\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Can the rule be configured?\n" }, "isEnabled": { "type": "boolean", "description": "Enablement status for the rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "riskLevel": { "type": "string", "description": "The risk level for the rule\n" } }, "type": "object", "required": [ "condition", "configurations", "dataSourceId", "description", "entitiesMappings", "isConfigurationAllowed", "isEnabled", "labels", "recommendation", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Detector rule type value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleDetailEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleRuleType:getDetectorRecipesDetectorRecipeCollectionItemDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRule": { "properties": { "candidateResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule" }, "description": "List of responder rules that can be used to remediate this detector rule\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail" }, "description": "Detailed information for a detector.\n" }, "detector": { "type": "string", "description": "Detector recipe for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "Resource type of the configuration to which the rule is applied\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleRuleType:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleRuleType" }, "description": "Detector rule type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The date and time the detector recipe was created Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the detector recipe was last updated Format defined by RFC3339.\n" } }, "type": "object", "required": [ "candidateResponderRules", "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleCandidateResponderRule": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "id": { "type": "string", "description": "OCID for detector recipe\n" }, "isPreferred": { "type": "boolean", "description": "Is this the preferred state?\n" } }, "type": "object", "required": [ "displayName", "id", "isPreferred" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration" }, "description": "List of detector rule configurations\n" }, "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Description for detector recipe detector rule\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping" }, "description": "Data source entities mapping for the detector rule\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Can the rule be configured?\n" }, "isEnabled": { "type": "boolean", "description": "Enablement status for the rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for DetectorRecipeDetectorRule resource\n" }, "riskLevel": { "type": "string", "description": "The risk level for the rule\n" } }, "type": "object", "required": [ "condition", "configurations", "dataSourceId", "description", "entitiesMappings", "isConfigurationAllowed", "isEnabled", "labels", "recommendation", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Detector rule type value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAllowedValue:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Detector rule type value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleDetailEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleRuleType:getDetectorRecipesDetectorRecipeCollectionItemEffectiveDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Detector rule type value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getDetectorRecipesFilter:getDetectorRecipesFilter": { "properties": { "name": { "type": "string", "description": "Configuration name\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getGuardTargetTargetDetail:getGuardTargetTargetDetail": { "properties": { "securityZoneDisplayName": { "type": "string", "description": "The name of the security zone to associate with this compartment.\n" }, "securityZoneId": { "type": "string", "description": "The OCID of the security zone to associate with this compartment\n" }, "targetResourceType": { "type": "string", "description": "Type of target\n" }, "targetSecurityZoneRecipes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetailTargetSecurityZoneRecipe:getGuardTargetTargetDetailTargetSecurityZoneRecipe" }, "description": "The list of security zone recipes to associate with this compartment\n" } }, "type": "object", "required": [ "securityZoneDisplayName", "securityZoneId", "targetResourceType", "targetSecurityZoneRecipes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetailTargetSecurityZoneRecipe:getGuardTargetTargetDetailTargetSecurityZoneRecipe": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "securityPolicies": { "type": "array", "items": { "type": "string" }, "description": "The list of security policy IDs that are included in the recipe\n" }, "state": { "type": "string", "description": "The current lifecycle state of the responder rule\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "owner", "securityPolicies", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipe:getGuardTargetTargetDetectorRecipe": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRecipeId": { "type": "string", "description": "Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based\n" }, "detectorRecipeType": { "type": "string", "description": "Recipe type ( STANDARD, ENTERPRISE )\n" }, "detectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRule:getGuardTargetTargetDetectorRecipeDetectorRule" }, "description": "List of detector rules for the detector recipe - user input\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "effectiveDetectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRule:getGuardTargetTargetDetectorRecipeEffectiveDetectorRule" }, "description": "List of currently enabled detector rules for the detector type for recipe after applying defaults\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "state": { "type": "string", "description": "The current lifecycle state of the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "description", "detector", "detectorRecipeId", "detectorRecipeType", "detectorRules", "displayName", "effectiveDetectorRules", "id", "owner", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRule:getGuardTargetTargetDetectorRecipeDetectorRule": { "properties": { "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetail:getGuardTargetTargetDetectorRecipeDetectorRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleEntitiesMapping:getGuardTargetTargetDetectorRecipeDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for a detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for TargetDetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleRuleType:getGuardTargetTargetDetectorRecipeDetectorRuleRuleType" }, "description": "Rule category type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The current lifecycle state of the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetail:getGuardTargetTargetDetectorRecipeDetectorRuleDetail": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConditionGroup:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConditionGroup" }, "description": "Condition group corresponding to each compartment\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfiguration:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Configuration allowed or not\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "riskLevel": { "type": "string", "description": "The risk level of the detector rule\n" } }, "type": "object", "required": [ "conditionGroups", "configurations", "isConfigurationAllowed", "isEnabled", "labels", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConditionGroup:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConditionGroup": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "condition": { "type": "string", "description": "The base condition resource.\n" } }, "type": "object", "required": [ "compartmentId", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfiguration:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationValue:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationValue:getGuardTargetTargetDetectorRecipeDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleEntitiesMapping:getGuardTargetTargetDetectorRecipeDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "Responder rule display name\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeDetectorRuleRuleType:getGuardTargetTargetDetectorRecipeDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRule:getGuardTargetTargetDetectorRecipeEffectiveDetectorRule": { "properties": { "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetail:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for a detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for TargetDetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleRuleType:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleRuleType" }, "description": "Rule category type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The current lifecycle state of the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetail:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetail": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup" }, "description": "Condition group corresponding to each compartment\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Configuration allowed or not\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "riskLevel": { "type": "string", "description": "The risk level of the detector rule\n" } }, "type": "object", "required": [ "conditionGroups", "configurations", "isConfigurationAllowed", "isEnabled", "labels", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "condition": { "type": "string", "description": "The base condition resource.\n" } }, "type": "object", "required": [ "compartmentId", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "Responder rule display name\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleRuleType:getGuardTargetTargetDetectorRecipeEffectiveDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipe:getGuardTargetTargetResponderRecipe": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "effectiveResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetResponderRecipeEffectiveResponderRule:getGuardTargetTargetResponderRecipeEffectiveResponderRule" }, "description": "List of currently enabled responder rules for the responder type for recipe after applying defaults\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "responderRecipeId": { "type": "string", "description": "Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned\n" }, "responderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetResponderRecipeResponderRule:getGuardTargetTargetResponderRecipeResponderRule" }, "description": "List of responder rules associated with the recipe - user input\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "description", "displayName", "effectiveResponderRules", "id", "owner", "responderRecipeId", "responderRules", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipeEffectiveResponderRule:getGuardTargetTargetResponderRecipeEffectiveResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetail:getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The current lifecycle state of the responder rule\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetail:getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration:getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration:getGuardTargetTargetResponderRecipeEffectiveResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipeResponderRule:getGuardTargetTargetResponderRecipeResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetResponderRecipeResponderRuleDetail:getGuardTargetTargetResponderRecipeResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The current lifecycle state of the responder rule\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipeResponderRuleDetail:getGuardTargetTargetResponderRecipeResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetTargetResponderRecipeResponderRuleDetailConfiguration:getGuardTargetTargetResponderRecipeResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetTargetResponderRecipeResponderRuleDetailConfiguration:getGuardTargetTargetResponderRecipeResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsFilter:getGuardTargetsFilter": { "properties": { "name": { "type": "string", "description": "Configuration name\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getGuardTargetsTargetCollection:getGuardTargetsTargetCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItem:getGuardTargetsTargetCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItem:getGuardTargetsTargetCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "inheritedByCompartments": { "type": "array", "items": { "type": "string" }, "description": "List of inherited compartments\n" }, "lifecyleDetails": { "type": "string", "description": "A message describing the current lifecycle state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]\n" }, "recipeCount": { "type": "integer", "description": "Total number of recipes attached to target\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetail:getGuardTargetsTargetCollectionItemTargetDetail" }, "description": "Details specific to the target type.\n" }, "targetDetectorRecipes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipe:getGuardTargetsTargetCollectionItemTargetDetectorRecipe" }, "description": "List of detector recipes attached to target\n" }, "targetResourceId": { "type": "string", "description": "Resource ID which the target uses to monitor\n" }, "targetResourceType": { "type": "string", "description": "Type of target\n" }, "targetResponderRecipes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipe:getGuardTargetsTargetCollectionItemTargetResponderRecipe" }, "description": "List of responder recipes attached to target\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "inheritedByCompartments", "lifecyleDetails", "recipeCount", "state", "systemTags", "targetDetails", "targetDetectorRecipes", "targetResourceId", "targetResourceType", "targetResponderRecipes", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetail:getGuardTargetsTargetCollectionItemTargetDetail": { "properties": { "securityZoneDisplayName": { "type": "string", "description": "The name of the security zone to associate with this compartment.\n" }, "securityZoneId": { "type": "string", "description": "The OCID of the security zone to associate with this compartment\n" }, "targetResourceType": { "type": "string", "description": "Type of target\n" }, "targetSecurityZoneRecipes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetailTargetSecurityZoneRecipe:getGuardTargetsTargetCollectionItemTargetDetailTargetSecurityZoneRecipe" }, "description": "The list of security zone recipes to associate with this compartment\n" } }, "type": "object", "required": [ "securityZoneDisplayName", "securityZoneId", "targetResourceType", "targetSecurityZoneRecipes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetailTargetSecurityZoneRecipe:getGuardTargetsTargetCollectionItemTargetDetailTargetSecurityZoneRecipe": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "securityPolicies": { "type": "array", "items": { "type": "string" }, "description": "The list of security policy IDs that are included in the recipe\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "owner", "securityPolicies", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipe:getGuardTargetsTargetCollectionItemTargetDetectorRecipe": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRecipeId": { "type": "string", "description": "Unique identifier for of original Oracle-managed detector recipe on which the TargetDetectorRecipe is based\n" }, "detectorRecipeType": { "type": "string", "description": "Recipe type ( STANDARD, ENTERPRISE )\n" }, "detectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRule:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRule" }, "description": "List of detector rules for the detector recipe - user input\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "effectiveDetectorRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRule:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRule" }, "description": "List of currently enabled detector rules for the detector type for recipe after applying defaults\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "description", "detector", "detectorRecipeId", "detectorRecipeType", "detectorRules", "displayName", "effectiveDetectorRules", "id", "owner", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRule:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRule": { "properties": { "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetail:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleEntitiesMapping:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for a detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for TargetDetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleRuleType:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleRuleType" }, "description": "Rule category type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetail:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetail": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConditionGroup:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConditionGroup" }, "description": "Condition group corresponding to each compartment\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Configuration allowed or not\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "riskLevel": { "type": "string", "description": "The risk level of the detector rule\n" } }, "type": "object", "required": [ "conditionGroups", "configurations", "isConfigurationAllowed", "isEnabled", "labels", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConditionGroup:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConditionGroup": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "condition": { "type": "string", "description": "The base condition resource.\n" } }, "type": "object", "required": [ "compartmentId", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleEntitiesMapping:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleRuleType:getGuardTargetsTargetCollectionItemTargetDetectorRecipeDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRule:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRule": { "properties": { "dataSourceId": { "type": "string", "description": "The ID of the attached data source\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetail:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "detector": { "type": "string", "description": "Detector type for the rule\n" }, "detectorRuleId": { "type": "string", "description": "The unique identifier of the detector rule\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entitiesMappings": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping" }, "description": "Data source entities mapping for a detector rule\n" }, "isCloneable": { "type": "boolean", "description": "Is the rule cloneable?\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "managedListTypes": { "type": "array", "items": { "type": "string" }, "description": "List of managed list types related to this rule\n" }, "recommendation": { "type": "string", "description": "Recommendation for TargetDetectorRecipeDetectorRule resource\n" }, "resourceType": { "type": "string", "description": "The type of resource which is monitored by the detector rule. For example, Instance, Database, VCN, Policy. To find the resource type for a particular rule, see [Detector Recipe Reference] (/iaas/cloud-guard/using/detect-recipes.htm#detect-recipes-reference).\n" }, "ruleTypes": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleRuleType:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleRuleType" }, "description": "Rule category type\n" }, "serviceType": { "type": "string", "description": "Service type of the configuration to which the rule is applied\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "dataSourceId", "description", "details", "detector", "detectorRuleId", "displayName", "entitiesMappings", "isCloneable", "lifecycleDetails", "managedListTypes", "recommendation", "resourceType", "ruleTypes", "serviceType", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetail:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetail": { "properties": { "conditionGroups": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup" }, "description": "Condition group corresponding to each compartment\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isConfigurationAllowed": { "type": "boolean", "description": "Configuration allowed or not\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "labels": { "type": "array", "items": { "type": "string" }, "description": "User-defined labels for a detector rule\n" }, "riskLevel": { "type": "string", "description": "The risk level of the detector rule\n" } }, "type": "object", "required": [ "conditionGroups", "configurations", "isConfigurationAllowed", "isEnabled", "labels", "riskLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConditionGroup": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "condition": { "type": "string", "description": "The base condition resource.\n" } }, "type": "object", "required": [ "compartmentId", "condition" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfiguration": { "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty" }, "description": "Map of additional property values for configuration\n" }, "allowedValues": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue" }, "description": "Map of possible values for configuration\n" }, "allowedValuesDataType": { "type": "string", "description": "Map property Value data type\n" }, "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "dataType": { "type": "string", "description": "Configuration data type\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" }, "values": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue" }, "description": "List of configuration values\n" } }, "type": "object", "required": [ "additionalProperties", "allowedValues", "allowedValuesDataType", "configKey", "dataType", "name", "value", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAdditionalProperty": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "propertyType": { "type": "string", "description": "Property Type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "propertyType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationAllowedValue": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleDetailConfigurationValue": { "properties": { "listType": { "type": "string", "description": "Configuration list item type (CUSTOM or MANAGED)\n" }, "managedListType": { "type": "string", "description": "Type of content in the managed list\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "listType", "managedListType", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleEntitiesMapping": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "entityType": { "type": "string", "description": "Type of entity\n" }, "queryField": { "type": "string", "description": "The entity value mapped to a data source query\n" } }, "type": "object", "required": [ "displayName", "entityType", "queryField" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleRuleType:getGuardTargetsTargetCollectionItemTargetDetectorRecipeEffectiveDetectorRuleRuleType": { "properties": { "key": { "type": "string", "description": "The unique identifier of the detector rule type\n" }, "values": { "type": "array", "items": { "type": "string" }, "description": "Configuration value\n" } }, "type": "object", "required": [ "key", "values" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipe:getGuardTargetsTargetCollectionItemTargetResponderRecipe": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "effectiveResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRule:getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRule" }, "description": "List of currently enabled responder rules for the responder type for recipe after applying defaults\n" }, "id": { "type": "string", "description": "Unique identifier of target responder recipe that can't be changed after creation\n" }, "owner": { "type": "string", "description": "Owner of target responder recipe\n" }, "responderRecipeId": { "type": "string", "description": "Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned\n" }, "responderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRule:getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRule" }, "description": "List of responder rules associated with the recipe - user input\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "description", "displayName", "effectiveResponderRules", "id", "owner", "responderRecipeId", "responderRules", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRule:getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetail:getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetail:getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetResponderRecipeEffectiveResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRule:getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetail:getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the target was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the target was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetail:getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetailConfiguration:getGuardTargetsTargetCollectionItemTargetResponderRecipeResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getManagedListsFilter:getManagedListsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getManagedListsManagedListCollection:getManagedListsManagedListCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getManagedListsManagedListCollectionItem:getManagedListsManagedListCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getManagedListsManagedListCollectionItem:getManagedListsManagedListCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Managed list description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "feedProvider": { "type": "string", "description": "Provider of the managed list feed\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "group": { "type": "string", "description": "Managed list type group\n" }, "id": { "type": "string", "description": "Unique identifier that can't be changed after creation\n" }, "isEditable": { "type": "boolean", "description": "Is this list editable?\n" }, "lifecyleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]\n" }, "listItems": { "type": "array", "items": { "type": "string" }, "description": "List of items in the managed list\n" }, "listType": { "type": "string", "description": "The type of managed list.\n" }, "sourceManagedListId": { "type": "string", "description": "OCID of the source managed list\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the managed list was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the managed list was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "feedProvider", "freeformTags", "group", "id", "isEditable", "lifecyleDetails", "listItems", "listType", "sourceManagedListId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getProblemEntitiesFilter:getProblemEntitiesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getProblemEntitiesProblemEntityCollection:getProblemEntitiesProblemEntityCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getProblemEntitiesProblemEntityCollectionItem:getProblemEntitiesProblemEntityCollectionItem" }, "description": "List of entity details related to a data source\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getProblemEntitiesProblemEntityCollectionItem:getProblemEntitiesProblemEntityCollectionItem": { "properties": { "entityDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getProblemEntitiesProblemEntityCollectionItemEntityDetail:getProblemEntitiesProblemEntityCollectionItemEntityDetail" }, "description": "List of entity details related to a data source\n" }, "problemId": { "type": "string", "description": "OCID of the problem.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Data source problem entities region\n" }, "resultUrl": { "type": "string", "description": "Log result query URL for a data source query\n" }, "timeFirstDetected": { "type": "string", "description": "Data source problem entities first detected time\n" }, "timeLastDetected": { "type": "string", "description": "Data source problem entities last detected time\n" } }, "type": "object", "required": [ "entityDetails", "problemId", "regions", "resultUrl", "timeFirstDetected", "timeLastDetected" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getProblemEntitiesProblemEntityCollectionItemEntityDetail:getProblemEntitiesProblemEntityCollectionItemEntityDetail": { "properties": { "displayName": { "type": "string", "description": "The display name of entity\n" }, "type": { "type": "string", "description": "Type of entity\n" }, "value": { "type": "string", "description": "The entity value\n" } }, "type": "object", "required": [ "displayName", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getProblemEntityItem:getProblemEntityItem": { "properties": { "entityDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getProblemEntityItemEntityDetail:getProblemEntityItemEntityDetail" }, "description": "List of event related to a DataSource\n" }, "problemId": { "type": "string", "description": "OCId of the problem.\n" }, "regions": { "type": "array", "items": { "type": "string" }, "description": "Data source problem entities region\n" }, "resultUrl": { "type": "string", "description": "Log result query url for a data source query\n" }, "timeFirstDetected": { "type": "string", "description": "Data source problem entities first detected time\n" }, "timeLastDetected": { "type": "string", "description": "Data source problem entities last detected time\n" } }, "type": "object", "required": [ "entityDetails", "problemId", "regions", "resultUrl", "timeFirstDetected", "timeLastDetected" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getProblemEntityItemEntityDetail:getProblemEntityItemEntityDetail": { "properties": { "displayName": { "type": "string", "description": "The display name of entity\n" }, "type": { "type": "string", "description": "Type of entity\n" }, "value": { "type": "string", "description": "The entity value\n" } }, "type": "object", "required": [ "displayName", "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipeEffectiveResponderRule:getResponderRecipeEffectiveResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipeEffectiveResponderRuleDetail:getResponderRecipeEffectiveResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The current lifecycle state of the example\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipeEffectiveResponderRuleDetail:getResponderRecipeEffectiveResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipeEffectiveResponderRuleDetailConfiguration:getResponderRecipeEffectiveResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipeEffectiveResponderRuleDetailConfiguration:getResponderRecipeEffectiveResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipeResponderRule:getResponderRecipeResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "Compartment OCID\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipeResponderRuleDetail:getResponderRecipeResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "Responder rule display name\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The current lifecycle state of the example\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipeResponderRuleDetail:getResponderRecipeResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipeResponderRuleDetailConfiguration:getResponderRecipeResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipeResponderRuleDetailConfiguration:getResponderRecipeResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesFilter:getResponderRecipesFilter": { "properties": { "name": { "type": "string", "description": "Configuration name\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollection:getResponderRecipesResponderRecipeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItem:getResponderRecipesResponderRecipeCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItem:getResponderRecipesResponderRecipeCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "effectiveResponderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRule:getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRule" }, "description": "List of currently enabled responder rules for the responder type, for recipe after applying defaults\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier for the responder recip\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "owner": { "type": "string", "description": "Owner of responder recipe\n" }, "responderRules": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemResponderRule:getResponderRecipesResponderRecipeCollectionItemResponderRule" }, "description": "List of responder rules associated with the recipe\n" }, "sourceResponderRecipeId": { "type": "string", "description": "The unique identifier of the source responder recipe\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "effectiveResponderRules", "freeformTags", "id", "lifecycleDetails", "owner", "responderRules", "sourceResponderRecipeId", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRule:getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetail:getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetail:getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetailConfiguration:getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetailConfiguration:getResponderRecipesResponderRecipeCollectionItemEffectiveResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemResponderRule:getResponderRecipesResponderRecipeCollectionItemResponderRule": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "description": { "type": "string", "description": "Responder rule description\n" }, "details": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemResponderRuleDetail:getResponderRecipesResponderRecipeCollectionItemResponderRuleDetail" }, "description": "Detailed information for a responder rule\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.\n" }, "policies": { "type": "array", "items": { "type": "string" }, "description": "List of policies\n" }, "responderRuleId": { "type": "string", "description": "Unique identifier for the responder rule\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "supportedModes": { "type": "array", "items": { "type": "string" }, "description": "Supported execution modes for the responder rule\n" }, "timeCreated": { "type": "string", "description": "The date and time the responder recipe was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the responder recipe was last updated. Format defined by RFC3339.\n" }, "type": { "type": "string", "description": "Type of responder\n" } }, "type": "object", "required": [ "compartmentId", "description", "details", "displayName", "lifecycleDetails", "policies", "responderRuleId", "state", "supportedModes", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemResponderRuleDetail:getResponderRecipesResponderRecipeCollectionItemResponderRuleDetail": { "properties": { "condition": { "type": "string", "description": "The base condition resource.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemResponderRuleDetailConfiguration:getResponderRecipesResponderRecipeCollectionItemResponderRuleDetailConfiguration" }, "description": "List of responder rule configurations\n" }, "isEnabled": { "type": "boolean", "description": "Enabled state for the responder rule\n" }, "mode": { "type": "string", "description": "Execution mode for the responder rule\n" } }, "type": "object", "required": [ "condition", "configurations", "isEnabled", "mode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getResponderRecipesResponderRecipeCollectionItemResponderRuleDetailConfiguration:getResponderRecipesResponderRecipeCollectionItemResponderRuleDetailConfiguration": { "properties": { "configKey": { "type": "string", "description": "Unique identifier of the configuration\n" }, "name": { "type": "string", "description": "Configuration name\n" }, "value": { "type": "string", "description": "Configuration value\n" } }, "type": "object", "required": [ "configKey", "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSavedQueriesFilter:getSavedQueriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getSavedQueriesSavedQueryCollection:getSavedQueriesSavedQueryCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getSavedQueriesSavedQueryCollectionItem:getSavedQueriesSavedQueryCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSavedQueriesSavedQueryCollectionItem:getSavedQueriesSavedQueryCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "Description of the saved query\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "OCID for the saved query\n" }, "query": { "type": "string", "description": "The saved query expression\n" }, "state": { "type": "string", "description": "The current lifecycle state of the resource\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the saved query was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the saved query was updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "query", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSecurityPoliciesFilter:getSecurityPoliciesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getSecurityPoliciesSecurityPolicyCollection:getSecurityPoliciesSecurityPolicyCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getSecurityPoliciesSecurityPolicyCollectionItem:getSecurityPoliciesSecurityPolicyCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSecurityPoliciesSecurityPolicyCollectionItem:getSecurityPoliciesSecurityPolicyCollectionItem": { "properties": { "category": { "type": "string", "description": "The category of the security policy\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "The security policy's description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "friendlyName": { "type": "string", "description": "A shorter version of the security policy's name\n" }, "id": { "type": "string", "description": "The unique identifier of the security zone policy. (`SecurityPolicy`)\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, this can be used to provide actionable information for a resource in a `Failed` state.\n" }, "owner": { "type": "string", "description": "The owner of the security policy\n" }, "services": { "type": "array", "items": { "type": "string" }, "description": "The list of services that the security policy protects\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The time the security policy was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the security policy was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "category", "compartmentId", "definedTags", "description", "displayName", "freeformTags", "friendlyName", "id", "lifecycleDetails", "owner", "services", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSecurityRecipesFilter:getSecurityRecipesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getSecurityRecipesSecurityRecipeCollection:getSecurityRecipesSecurityRecipeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getSecurityRecipesSecurityRecipeCollectionItem:getSecurityRecipesSecurityRecipeCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSecurityRecipesSecurityRecipeCollectionItem:getSecurityRecipesSecurityRecipeCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "The recipe's description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The unique identifier of the security zone recipe. (`SecurityRecipe`)\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, this can be used to provide actionable information for a recipe in the `Failed` state.\n" }, "owner": { "type": "string", "description": "The owner of the recipe\n" }, "securityPolicies": { "type": "array", "items": { "type": "string" }, "description": "The list of security policy IDs that are included in the recipe\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The time the recipe was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the recipe was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "lifecycleDetails", "owner", "securityPolicies", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSecurityZonesFilter:getSecurityZonesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getSecurityZonesSecurityZoneCollection:getSecurityZonesSecurityZoneCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getSecurityZonesSecurityZoneCollectionItem:getSecurityZonesSecurityZoneCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getSecurityZonesSecurityZoneCollectionItem:getSecurityZonesSecurityZoneCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "The security zone's description\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The unique identifier of the security zone (`SecurityZone` resource).\n" }, "inheritedByCompartments": { "type": "array", "items": { "type": "string" }, "description": "List of inherited compartments\n" }, "isInheritanceAfterDeleteEnabled": { "type": "boolean", "description": "Indicates if upon deletion of the security zone the comparment should inherit parent security zone\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, this can be used to provide actionable information for a zone in the `Failed` state.\n" }, "securityZoneRecipeId": { "type": "string", "description": "The OCID of the recipe (`SecurityRecipe` resource) for the security zone\n" }, "securityZoneTargetId": { "type": "string", "description": "The OCID of the target associated with the security zone\n" }, "state": { "type": "string", "description": "The field lifecycle state. Only one state can be provided. Default value for state is active. If no value is specified state is active.\n" }, "timeCreated": { "type": "string", "description": "The time the security zone was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the security zone was last updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "freeformTags", "id", "inheritedByCompartments", "isInheritanceAfterDeleteEnabled", "lifecycleDetails", "securityZoneRecipeId", "securityZoneTargetId", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getWlpAgentsFilter:getWlpAgentsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudGuard/getWlpAgentsWlpAgentCollection:getWlpAgentsWlpAgentCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudGuard/getWlpAgentsWlpAgentCollectionItem:getWlpAgentsWlpAgentCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudGuard/getWlpAgentsWlpAgentCollectionItem:getWlpAgentsWlpAgentCollectionItem": { "properties": { "agentVersion": { "type": "string", "description": "The version of the agent\n" }, "certificateId": { "type": "string", "description": "The certificate ID returned by Oracle Cloud Infrastructure certificates service\n" }, "certificateSignedRequest": { "type": "string", "description": "The updated certificate signing request\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "hostId": { "type": "string", "description": "OCID for instance in which WlpAgent is installed\n" }, "id": { "type": "string", "description": "OCID for WlpAgent\n" }, "osInfo": { "type": "string" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "tenantId": { "type": "string", "description": "TenantId of the host\n" }, "timeCreated": { "type": "string", "description": "The date and time the WlpAgent was created. Format defined by RFC3339.\n" }, "timeUpdated": { "type": "string", "description": "The date and time the WlpAgent was updated. Format defined by RFC3339.\n" } }, "type": "object", "required": [ "agentVersion", "certificateId", "certificateSignedRequest", "compartmentId", "definedTags", "freeformTags", "hostId", "id", "osInfo", "systemTags", "tenantId", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/MigrationAssetReplicationLocationDetail:MigrationAssetReplicationLocationDetail": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties for each of the replication location types\n" }, "replicationLocationType": { "type": "string", "description": "The type of replication location\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metadata", "replicationLocationType" ] } } }, "oci:CloudMigrations/MigrationMigrationConfig:MigrationMigrationConfig": { "properties": { "subnetId": { "type": "string", "description": "(Updatable) The OCID of the subnet to use for replication\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "subnetId" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStat:MigrationPlanMigrationPlanStat": { "properties": { "costToMigrates": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatCostToMigrate:MigrationPlanMigrationPlanStatCostToMigrate" }, "description": "Summary of costs to migrate.\n" }, "currentMonthlyCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatCurrentMonthlyCost:MigrationPlanMigrationPlanStatCurrentMonthlyCost" }, "description": "Current monthly compute and storage costs.\n" }, "timeUpdated": { "type": "string", "description": "The time when the migration plan was updated. An RFC3339 formatted datetime string.\n" }, "totalEstimatedCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCost:MigrationPlanMigrationPlanStatTotalEstimatedCost" }, "description": "Cost estimation description\n" }, "vmCount": { "type": "integer", "description": "The total count of VMs in migration\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "costToMigrates", "currentMonthlyCosts", "timeUpdated", "totalEstimatedCosts", "vmCount" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatCostToMigrate:MigrationPlanMigrationPlanStatCostToMigrate": { "properties": { "assetCount": { "type": "integer", "description": "Number of assets used in this calculation.\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "ociDataTransferCosts": { "type": "number", "description": "Data transfer costs from OCI.\n" }, "sourceDataTransferCosts": { "type": "number", "description": "Data transfer costs from source cloud provider.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assetCount", "currencyCode", "ociDataTransferCosts", "sourceDataTransferCosts" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatCurrentMonthlyCost:MigrationPlanMigrationPlanStatCurrentMonthlyCost": { "properties": { "assetCount": { "type": "integer", "description": "Number of assets used in this calculation.\n" }, "computeAmount": { "type": "number", "description": "Current monthly compute costs.\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "storageAmount": { "type": "number", "description": "Current monthly storage costs.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assetCount", "computeAmount", "currencyCode", "storageAmount" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCost:MigrationPlanMigrationPlanStatTotalEstimatedCost": { "properties": { "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostCompute:MigrationPlanMigrationPlanStatTotalEstimatedCostCompute" }, "description": "Cost estimation for compute\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "osImages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostOsImage:MigrationPlanMigrationPlanStatTotalEstimatedCostOsImage" }, "description": "Cost estimation for the OS image.\n" }, "storages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostStorage:MigrationPlanMigrationPlanStatTotalEstimatedCostStorage" }, "description": "Cost estimation for storage\n" }, "subscriptionId": { "type": "string", "description": "Subscription ID\n" }, "totalEstimationPerMonth": { "type": "number", "description": "Total estimation per month\n" }, "totalEstimationPerMonthBySubscription": { "type": "number", "description": "Total estimation per month by subscription.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "computes", "currencyCode", "osImages", "storages", "subscriptionId", "totalEstimationPerMonth", "totalEstimationPerMonthBySubscription" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostCompute:MigrationPlanMigrationPlanStatTotalEstimatedCostCompute": { "properties": { "gpuCount": { "type": "number", "description": "Total number of GPU\n" }, "gpuPerHour": { "type": "number", "description": "GPU per hour\n" }, "gpuPerHourBySubscription": { "type": "number", "description": "GPU per hour by subscription\n" }, "memoryAmountGb": { "type": "number", "description": "Total usage of memory\n" }, "memoryGbPerHour": { "type": "number", "description": "Gigabyte per hour\n" }, "memoryGbPerHourBySubscription": { "type": "number", "description": "Gigabyte per hour by subscription\n" }, "ocpuCount": { "type": "number", "description": "Total number of OCPUs\n" }, "ocpuPerHour": { "type": "number", "description": "OCPU per hour\n" }, "ocpuPerHourBySubscription": { "type": "number", "description": "OCPU per hour by subscription\n" }, "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "gpuCount", "gpuPerHour", "gpuPerHourBySubscription", "memoryAmountGb", "memoryGbPerHour", "memoryGbPerHourBySubscription", "ocpuCount", "ocpuPerHour", "ocpuPerHourBySubscription", "totalPerHour", "totalPerHourBySubscription" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostOsImage:MigrationPlanMigrationPlanStatTotalEstimatedCostOsImage": { "properties": { "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "totalPerHour", "totalPerHourBySubscription" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostStorage:MigrationPlanMigrationPlanStatTotalEstimatedCostStorage": { "properties": { "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume:MigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume" }, "description": "Volume estimation\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "totalGbPerMonth", "totalGbPerMonthBySubscription", "volumes" ] } } }, "oci:CloudMigrations/MigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume:MigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume": { "properties": { "capacityGb": { "type": "number", "description": "Gigabyte storage capacity\n" }, "description": { "type": "string", "description": "Volume description\n" }, "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityGb", "description", "totalGbPerMonth", "totalGbPerMonthBySubscription" ] } } }, "oci:CloudMigrations/MigrationPlanStrategy:MigrationPlanStrategy": { "properties": { "adjustmentMultiplier": { "type": "number", "description": "(Updatable) The real resource usage is multiplied to this number before making any recommendation.\n" }, "metricTimeWindow": { "type": "string", "description": "(Updatable) The current state of the migration plan.\n" }, "metricType": { "type": "string", "description": "(Updatable) The current state of the migration plan.\n" }, "percentile": { "type": "string", "description": "(Updatable) Percentile value\n" }, "resourceType": { "type": "string", "description": "(Updatable) The type of resource.\n" }, "strategyType": { "type": "string", "description": "(Updatable) The type of strategy used for migration.\n" } }, "type": "object", "required": [ "resourceType", "strategyType" ], "language": { "nodejs": { "requiredOutputs": [ "adjustmentMultiplier", "metricTimeWindow", "metricType", "percentile", "resourceType", "strategyType" ] } } }, "oci:CloudMigrations/MigrationPlanTargetEnvironment:MigrationPlanTargetEnvironment": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) Availability Domain of the VM configuration.\n" }, "clusterAssetId": { "type": "string", "description": "(Updatable) Inventory asset id of the olvm cluster\n" }, "dedicatedVmHost": { "type": "string", "description": "(Updatable) OCID of the dedicated VM configuration host.\n" }, "faultDomain": { "type": "string", "description": "(Updatable) Fault domain of the VM configuration.\n" }, "msLicense": { "type": "string", "description": "(Updatable) Microsoft license for the VM configuration.\n" }, "olvmTemplates": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) OLVM OS type to inventory asset id of the template\n" }, "preferredShapeType": { "type": "string", "description": "(Updatable) Preferred VM shape type provided by the customer.\n" }, "subnet": { "type": "string", "description": "(Updatable) OCID of the VM configuration subnet.\n" }, "targetCompartmentId": { "type": "string", "description": "(Updatable) Target compartment identifier\n" }, "targetEnvironmentType": { "type": "string", "description": "(Updatable) The type of target environment.\n" }, "vcn": { "type": "string", "description": "(Updatable) OCID of the VM configuration VCN.\n" }, "vnicProfileAssetId": { "type": "string", "description": "(Updatable) Inventory asset Id of the vnic profile\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "targetEnvironmentType" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "clusterAssetId", "dedicatedVmHost", "faultDomain", "msLicense", "olvmTemplates", "preferredShapeType", "subnet", "targetCompartmentId", "targetEnvironmentType", "vcn", "vnicProfileAssetId" ] } } }, "oci:CloudMigrations/TargetAssetCompatibilityMessage:TargetAssetCompatibilityMessage": { "properties": { "message": { "type": "string", "description": "Detailed description of the compatibility issue.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "severity": { "type": "string", "description": "Severity level of the compatibility issue.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "message", "name", "severity" ] } } }, "oci:CloudMigrations/TargetAssetEstimatedCost:TargetAssetEstimatedCost": { "properties": { "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetEstimatedCostCompute:TargetAssetEstimatedCostCompute" }, "description": "Cost estimation for compute\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "osImages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetEstimatedCostOsImage:TargetAssetEstimatedCostOsImage" }, "description": "Cost estimation for the OS image.\n" }, "storages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetEstimatedCostStorage:TargetAssetEstimatedCostStorage" }, "description": "Cost estimation for storage\n" }, "subscriptionId": { "type": "string", "description": "Subscription ID\n" }, "totalEstimationPerMonth": { "type": "number", "description": "Total estimation per month\n" }, "totalEstimationPerMonthBySubscription": { "type": "number", "description": "Total estimation per month by subscription.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "computes", "currencyCode", "osImages", "storages", "subscriptionId", "totalEstimationPerMonth", "totalEstimationPerMonthBySubscription" ] } } }, "oci:CloudMigrations/TargetAssetEstimatedCostCompute:TargetAssetEstimatedCostCompute": { "properties": { "gpuCount": { "type": "number", "description": "Total number of GPU\n" }, "gpuPerHour": { "type": "number", "description": "GPU per hour\n" }, "gpuPerHourBySubscription": { "type": "number", "description": "GPU per hour by subscription\n" }, "memoryAmountGb": { "type": "number", "description": "Total usage of memory\n" }, "memoryGbPerHour": { "type": "number", "description": "Gigabyte per hour\n" }, "memoryGbPerHourBySubscription": { "type": "number", "description": "Gigabyte per hour by subscription\n" }, "ocpuCount": { "type": "number", "description": "Total number of OCPUs\n" }, "ocpuPerHour": { "type": "number", "description": "OCPU per hour\n" }, "ocpuPerHourBySubscription": { "type": "number", "description": "OCPU per hour by subscription\n" }, "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "gpuCount", "gpuPerHour", "gpuPerHourBySubscription", "memoryAmountGb", "memoryGbPerHour", "memoryGbPerHourBySubscription", "ocpuCount", "ocpuPerHour", "ocpuPerHourBySubscription", "totalPerHour", "totalPerHourBySubscription" ] } } }, "oci:CloudMigrations/TargetAssetEstimatedCostOsImage:TargetAssetEstimatedCostOsImage": { "properties": { "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "totalPerHour", "totalPerHourBySubscription" ] } } }, "oci:CloudMigrations/TargetAssetEstimatedCostStorage:TargetAssetEstimatedCostStorage": { "properties": { "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetEstimatedCostStorageVolume:TargetAssetEstimatedCostStorageVolume" }, "description": "Volume estimation\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "totalGbPerMonth", "totalGbPerMonthBySubscription", "volumes" ] } } }, "oci:CloudMigrations/TargetAssetEstimatedCostStorageVolume:TargetAssetEstimatedCostStorageVolume": { "properties": { "capacityGb": { "type": "number", "description": "Gigabyte storage capacity\n" }, "description": { "type": "string", "description": "Volume description\n" }, "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityGb", "description", "totalGbPerMonth", "totalGbPerMonthBySubscription" ] } } }, "oci:CloudMigrations/TargetAssetMigrationAsset:TargetAssetMigrationAsset": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "dependedOnBies": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depend on the asset.\n" }, "dependsOns": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depends on the asset.\n" }, "destinationDisks": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Mapping of source disk id to destination disk details\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "id": { "type": "string", "description": "Asset ID generated by mirgration service. It is used in the mirgration service pipeline.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationId": { "type": "string", "description": "OCID of the associated migration.\n" }, "notifications": { "type": "array", "items": { "type": "string" }, "description": "List of notifications\n" }, "parentSnapshot": { "type": "string", "description": "The parent snapshot of the migration asset to be used by the replication task.\n" }, "replicationCompartmentId": { "type": "string", "description": "Replication compartment identifier\n" }, "replicationLocationDetail": { "$ref": "#/types/oci:CloudMigrations/TargetAssetMigrationAssetReplicationLocationDetail:TargetAssetMigrationAssetReplicationLocationDetail", "description": "Replication location detail where the snapshots reside\n" }, "replicationScheduleId": { "type": "string", "description": "Replication schedule identifier\n" }, "snapShotBucketName": { "type": "string", "description": "Name of snapshot bucket\n" }, "snapshots": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetId": { "type": "string", "description": "OCID that is referenced to an asset for an inventory.\n" }, "state": { "type": "string", "description": "The current state of the target asset.\n" }, "tenancyId": { "type": "string", "description": "Tenancy identifier\n" }, "timeCreated": { "type": "string", "description": "The time when the target asset was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the target asset was updated. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "(Updatable) The type of target asset.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "compartmentId", "dependedOnBies", "dependsOns", "destinationDisks", "displayName", "id", "lifecycleDetails", "migrationId", "notifications", "parentSnapshot", "replicationCompartmentId", "replicationLocationDetail", "replicationScheduleId", "snapShotBucketName", "snapshots", "sourceAssetData", "sourceAssetId", "state", "tenancyId", "timeCreated", "timeUpdated", "type" ] } } }, "oci:CloudMigrations/TargetAssetMigrationAssetReplicationLocationDetail:TargetAssetMigrationAssetReplicationLocationDetail": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties for each of the replication location types\n" }, "replicationLocationType": { "type": "string", "description": "The type of replication location\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "metadata", "replicationLocationType" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpec:TargetAssetRecommendedSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecAgentConfig:TargetAssetRecommendedSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecCreateVnicDetail:TargetAssetRecommendedSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecInstanceOption:TargetAssetRecommendedSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecPreemptibleInstanceConfig:TargetAssetRecommendedSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecShapeConfig:TargetAssetRecommendedSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecSourceDetail:TargetAssetRecommendedSpecSourceDetail" }, "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecAgentConfig:TargetAssetRecommendedSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecAgentConfigPluginsConfig:TargetAssetRecommendedSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecAgentConfigPluginsConfig:TargetAssetRecommendedSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredState", "name" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecCreateVnicDetail:TargetAssetRecommendedSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecInstanceOption:TargetAssetRecommendedSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areLegacyImdsEndpointsDisabled" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecPreemptibleInstanceConfig:TargetAssetRecommendedSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction:TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preemptionActions" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction:TargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "(Updatable) The type of target asset.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preserveBootVolume", "type" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecShapeConfig:TargetAssetRecommendedSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ] } } }, "oci:CloudMigrations/TargetAssetRecommendedSpecSourceDetail:TargetAssetRecommendedSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ] } } }, "oci:CloudMigrations/TargetAssetTestSpec:TargetAssetTestSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecAgentConfig:TargetAssetTestSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecCreateVnicDetail:TargetAssetTestSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecInstanceOption:TargetAssetTestSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecPreemptibleInstanceConfig:TargetAssetTestSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecShapeConfig:TargetAssetTestSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecSourceDetail:TargetAssetTestSpecSourceDetail" }, "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecAgentConfig:TargetAssetTestSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecAgentConfigPluginsConfig:TargetAssetTestSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecAgentConfigPluginsConfig:TargetAssetTestSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredState", "name" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecCreateVnicDetail:TargetAssetTestSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecInstanceOption:TargetAssetTestSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areLegacyImdsEndpointsDisabled" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecPreemptibleInstanceConfig:TargetAssetTestSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction:TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preemptionActions" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction:TargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "(Updatable) The type of target asset.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preserveBootVolume", "type" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecShapeConfig:TargetAssetTestSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ] } } }, "oci:CloudMigrations/TargetAssetTestSpecSourceDetail:TargetAssetTestSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ] } } }, "oci:CloudMigrations/TargetAssetUserSpec:TargetAssetUserSpec": { "properties": { "agentConfig": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecAgentConfig:TargetAssetUserSpecAgentConfig", "description": "(Updatable) Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "(Updatable) The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "(Updatable) The OCID of the compartment.\n" }, "createVnicDetails": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecCreateVnicDetails:TargetAssetUserSpecCreateVnicDetails", "description": "(Updatable) Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "(Updatable) The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "(Updatable) A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n\nIf you do not specify the fault domain, the system selects one for you.\n\nTo get a list of fault domains, use the [ListFaultDomains](https://docs.cloud.oracle.com/iaas/api/#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API.\n\nExample: `FAULT-DOMAIN-1`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "(Updatable) Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecInstanceOptions:TargetAssetUserSpecInstanceOptions", "description": "(Updatable) Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "(Updatable) This is an advanced option.\n\nWhen a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.\n\nIf you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots. Be aware that the same iPXE script will run every time an instance boots, not only after the initial LaunchInstance call.\n\nBy default, the iPXE script connects to the instance's local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance's local boot volume over iSCSI in the same way as the default iPXE script, use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.\n\nIf your instance boot volume type is paravirtualized, the boot volume is attached to the instance through virtio-scsi and no iPXE script is used. If your instance boot volume type is paravirtualized and you use custom iPXE to perform network-boot into your instance, the primary boot volume is attached as a data volume through the virtio-scsi drive.\n\nFor more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).\n\nFor more information about iPXE, see http://ipxe.org.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "(Updatable) Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfig": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecPreemptibleInstanceConfig:TargetAssetUserSpecPreemptibleInstanceConfig", "description": "(Updatable) Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "(Updatable) The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n\nYou can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes).\n" }, "shapeConfig": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecShapeConfig:TargetAssetUserSpecShapeConfig", "description": "(Updatable) The shape configuration requested for the instance.\n\nIf the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e that you specify.\n\nEach shape only supports certain configurable values. If the values that you provide are not valid for the specified \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e, an error is returned.\n" }, "sourceDetails": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecSourceDetails:TargetAssetUserSpecSourceDetails", "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentConfig", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfig", "shape", "shapeConfig", "sourceDetails" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecAgentConfig:TargetAssetUserSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "(Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n\nTo get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "isManagementDisabled": { "type": "boolean", "description": "(Updatable) Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n\nThese are the management plugins: OS Management Service Agent and Compute instance run command.\n\nThe management plugins are controlled by this parameter and the per-plugin configuration in the `pluginsConfig` object.\n* If `isManagementDisabled` is true, all the management plugins are disabled, regardless of the per-plugin configuration.\n* If `isManagementDisabled` is false, all the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "(Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n\nThese are the monitoring plugins: Compute instance monitoring and Custom logs monitoring.\n\nThe monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.\n* If `isMonitoringDisabled` is true, all the monitoring plugins are disabled, regardless of the per-plugin configuration.\n* If `isMonitoringDisabled` is false, all the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecAgentConfigPluginsConfig:TargetAssetUserSpecAgentConfigPluginsConfig" }, "description": "(Updatable) The configuration of plugins associated with this instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecAgentConfigPluginsConfig:TargetAssetUserSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "(Updatable) Whether the plugin should be enabled or disabled.\n\nTo enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false.\n" }, "name": { "type": "string", "description": "(Updatable) The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredState", "name" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecCreateVnicDetails:TargetAssetUserSpecCreateVnicDetails": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "(Updatable) Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n\nIf you specify a `hostnameLabel`, then `assignPrivateDnsRecord` must be set to true.\n" }, "assignPublicIp": { "type": "boolean", "description": "(Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n\n**Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n\n**Note:** There's a limit to the number of [public IPs](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PublicIp/) a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see [Public IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\nExample: \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n\nIf you specify a `vlanId`, then `assignPublicIp` must be set to false. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "(Updatable) The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, `bminstance-1` in FQDN `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n\nFor more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).\n\nWhen launching an instance, use this `hostnameLabel` instead of the deprecated `hostnameLabel` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). If you provide both, the values must match.\n\nExample: `bminstance-1`\n\nIf you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN can not be assigned a hostname. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n\nIf a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "privateIp": { "type": "string", "description": "(Updatable) A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n\nIf you specify a `vlanId`, the `privateIp` cannot be specified. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nExample: `10.0.3.3`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "(Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n\nIf you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nExample: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "subnetId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n\nIf you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.\n" }, "vlanId": { "type": "string", "description": "(Updatable) Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nProvide a `vlanId` instead of a `subnetId`. If you provide both `vlanId` and `subnetId`, the request fails.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecInstanceOptions:TargetAssetUserSpecInstanceOptions": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "(Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areLegacyImdsEndpointsDisabled" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecPreemptibleInstanceConfig:TargetAssetUserSpecPreemptibleInstanceConfig": { "properties": { "preemptionAction": { "$ref": "#/types/oci:CloudMigrations/TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction:TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction", "description": "(Updatable) The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preemptionAction" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction:TargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "(Updatable) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "(Updatable) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "preserveBootVolume", "type" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecShapeConfig:TargetAssetUserSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "(Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n\nThe following values are supported:\n* `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.\n* `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.\n* `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.\n" }, "memoryInGbs": { "type": "number", "description": "(Updatable) The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "(Updatable) The total number of OCPUs available to the instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ] } } }, "oci:CloudMigrations/TargetAssetUserSpecSourceDetails:TargetAssetUserSpecSourceDetails": { "properties": { "bootVolumeId": { "type": "string", "description": "(Updatable) The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "(Updatable) The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "(Updatable) The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n" }, "imageId": { "type": "string", "description": "(Updatable) The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "(Updatable) The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ] } } }, "oci:CloudMigrations/getMigrationAssetReplicationLocationDetail:getMigrationAssetReplicationLocationDetail": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties for each of the replication location types\n" }, "replicationLocationType": { "type": "string", "description": "The type of replication location\n" } }, "type": "object", "required": [ "metadata", "replicationLocationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationAssetsFilter:getMigrationAssetsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudMigrations/getMigrationAssetsMigrationAssetCollection:getMigrationAssetsMigrationAssetCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationAssetsMigrationAssetCollectionItem:getMigrationAssetsMigrationAssetCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationAssetsMigrationAssetCollectionItem:getMigrationAssetsMigrationAssetCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "Availability domain\n" }, "compartmentId": { "type": "string", "description": "Compartment Identifier\n" }, "dependedOnBies": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depend on the asset.\n" }, "destinationDisks": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Mapping of source disk id to destination disk details\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "id": { "type": "string", "description": "Asset ID generated by mirgration service. It is used in the mirgration service pipeline.\n" }, "inventoryAssetId": { "type": "string" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationAssetDependsOns": { "type": "array", "items": { "type": "string" } }, "migrationId": { "type": "string", "description": "Unique migration identifier\n" }, "notifications": { "type": "array", "items": { "type": "string" }, "description": "List of notifications\n" }, "parentSnapshot": { "type": "string", "description": "The parent snapshot of the migration asset to be used by the replication task.\n" }, "replicationCompartmentId": { "type": "string", "description": "Replication compartment identifier\n" }, "replicationLocationDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationAssetsMigrationAssetCollectionItemReplicationLocationDetail:getMigrationAssetsMigrationAssetCollectionItemReplicationLocationDetail" }, "description": "Replication location detail where the snapshots reside\n" }, "replicationScheduleId": { "type": "string", "description": "Replication schedule identifier\n" }, "snapShotBucketName": { "type": "string", "description": "Name of snapshot bucket\n" }, "snapshots": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetId": { "type": "string", "description": "OCID that is referenced to an asset for an inventory.\n" }, "state": { "type": "string", "description": "The current state of the migration asset.\n" }, "tenancyId": { "type": "string", "description": "Tenancy identifier\n" }, "timeCreated": { "type": "string", "description": "The time when the migration asset was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the migration asset was updated. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "The type of asset referenced for inventory.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "dependedOnBies", "destinationDisks", "displayName", "id", "inventoryAssetId", "lifecycleDetails", "migrationAssetDependsOns", "migrationId", "notifications", "parentSnapshot", "replicationCompartmentId", "replicationLocationDetails", "replicationScheduleId", "snapShotBucketName", "snapshots", "sourceAssetId", "state", "tenancyId", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationAssetsMigrationAssetCollectionItemReplicationLocationDetail:getMigrationAssetsMigrationAssetCollectionItemReplicationLocationDetail": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties for each of the replication location types\n" }, "replicationLocationType": { "type": "string", "description": "The type of replication location\n" } }, "type": "object", "required": [ "metadata", "replicationLocationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationMigrationConfig:getMigrationMigrationConfig": { "properties": { "subnetId": { "type": "string", "description": "The OCID of the subnet to use for replication\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanAvailableShapeItem:getMigrationPlanAvailableShapeItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "gpuDescription": { "type": "string", "description": "Description of the GPUs.\n" }, "gpus": { "type": "integer", "description": "Number of GPUs.\n" }, "localDiskDescription": { "type": "string", "description": "Description of local disks.\n" }, "localDisks": { "type": "integer", "description": "Number of local disks.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "Total size of local disks for shape.\n" }, "maxVnicAttachments": { "type": "integer", "description": "Maximum number of virtual network interfaces that can be attached.\n" }, "memoryInGbs": { "type": "number", "description": "Amount of memory for the shape.\n" }, "minTotalBaselineOcpusRequired": { "type": "number", "description": "Minimum CPUs required.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "Shape bandwidth.\n" }, "ocpus": { "type": "number", "description": "Number of CPUs.\n" }, "paginationToken": { "type": "string", "description": "Shape name and availability domain. Used for pagination.\n" }, "processorDescription": { "type": "string", "description": "Description of the processor.\n" }, "shape": { "type": "string", "description": "Name of the shape.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" } }, "type": "object", "required": [ "availabilityDomain", "definedTags", "freeformTags", "gpuDescription", "gpus", "localDiskDescription", "localDisks", "localDisksTotalSizeInGbs", "maxVnicAttachments", "memoryInGbs", "minTotalBaselineOcpusRequired", "networkingBandwidthInGbps", "ocpus", "paginationToken", "processorDescription", "shape", "systemTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanAvailableShapesAvailableShapesCollection:getMigrationPlanAvailableShapesAvailableShapesCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanAvailableShapesAvailableShapesCollectionItem:getMigrationPlanAvailableShapesAvailableShapesCollectionItem" }, "description": "Available shapes list.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanAvailableShapesAvailableShapesCollectionItem:getMigrationPlanAvailableShapesAvailableShapesCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "gpuDescription": { "type": "string", "description": "Description of the GPUs.\n" }, "gpus": { "type": "integer", "description": "Number of GPUs.\n" }, "localDiskDescription": { "type": "string", "description": "Description of local disks.\n" }, "localDisks": { "type": "integer", "description": "Number of local disks.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "Total size of local disks for shape.\n" }, "maxVnicAttachments": { "type": "integer", "description": "Maximum number of virtual network interfaces that can be attached.\n" }, "memoryInGbs": { "type": "number", "description": "Amount of memory for the shape.\n" }, "minTotalBaselineOcpusRequired": { "type": "number", "description": "Minimum CPUs required.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "Shape bandwidth.\n" }, "ocpus": { "type": "number", "description": "Number of CPUs.\n" }, "paginationToken": { "type": "string", "description": "Shape name and availability domain. Used for pagination.\n" }, "processorDescription": { "type": "string", "description": "Description of the processor.\n" }, "shape": { "type": "string", "description": "Name of the shape.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" } }, "type": "object", "required": [ "availabilityDomain", "definedTags", "freeformTags", "gpuDescription", "gpus", "localDiskDescription", "localDisks", "localDisksTotalSizeInGbs", "maxVnicAttachments", "memoryInGbs", "minTotalBaselineOcpusRequired", "networkingBandwidthInGbps", "ocpus", "paginationToken", "processorDescription", "shape", "systemTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanAvailableShapesFilter:getMigrationPlanAvailableShapesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStat:getMigrationPlanMigrationPlanStat": { "properties": { "costToMigrates": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatCostToMigrate:getMigrationPlanMigrationPlanStatCostToMigrate" }, "description": "Summary of costs to migrate.\n" }, "currentMonthlyCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatCurrentMonthlyCost:getMigrationPlanMigrationPlanStatCurrentMonthlyCost" }, "description": "Current monthly compute and storage costs.\n" }, "timeUpdated": { "type": "string", "description": "The time when the migration plan was updated. An RFC3339 formatted datetime string.\n" }, "totalEstimatedCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCost:getMigrationPlanMigrationPlanStatTotalEstimatedCost" }, "description": "Cost estimation description\n" }, "vmCount": { "type": "integer", "description": "The total count of VMs in migration\n" } }, "type": "object", "required": [ "costToMigrates", "currentMonthlyCosts", "timeUpdated", "totalEstimatedCosts", "vmCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatCostToMigrate:getMigrationPlanMigrationPlanStatCostToMigrate": { "properties": { "assetCount": { "type": "integer", "description": "Number of assets used in this calculation.\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "ociDataTransferCosts": { "type": "number", "description": "Data transfer costs from OCI.\n" }, "sourceDataTransferCosts": { "type": "number", "description": "Data transfer costs from source cloud provider.\n" } }, "type": "object", "required": [ "assetCount", "currencyCode", "ociDataTransferCosts", "sourceDataTransferCosts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatCurrentMonthlyCost:getMigrationPlanMigrationPlanStatCurrentMonthlyCost": { "properties": { "assetCount": { "type": "integer", "description": "Number of assets used in this calculation.\n" }, "computeAmount": { "type": "number", "description": "Current monthly compute costs.\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "storageAmount": { "type": "number", "description": "Current monthly storage costs.\n" } }, "type": "object", "required": [ "assetCount", "computeAmount", "currencyCode", "storageAmount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCost:getMigrationPlanMigrationPlanStatTotalEstimatedCost": { "properties": { "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostCompute:getMigrationPlanMigrationPlanStatTotalEstimatedCostCompute" }, "description": "Cost estimation for compute\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "osImages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostOsImage:getMigrationPlanMigrationPlanStatTotalEstimatedCostOsImage" }, "description": "Cost estimation for the OS image.\n" }, "storages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostStorage:getMigrationPlanMigrationPlanStatTotalEstimatedCostStorage" }, "description": "Cost estimation for storage\n" }, "subscriptionId": { "type": "string", "description": "Subscription ID\n" }, "totalEstimationPerMonth": { "type": "number", "description": "Total estimation per month\n" }, "totalEstimationPerMonthBySubscription": { "type": "number", "description": "Total estimation per month by subscription.\n" } }, "type": "object", "required": [ "computes", "currencyCode", "osImages", "storages", "subscriptionId", "totalEstimationPerMonth", "totalEstimationPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostCompute:getMigrationPlanMigrationPlanStatTotalEstimatedCostCompute": { "properties": { "gpuCount": { "type": "number", "description": "Total number of GPU\n" }, "gpuPerHour": { "type": "number", "description": "GPU per hour\n" }, "gpuPerHourBySubscription": { "type": "number", "description": "GPU per hour by subscription\n" }, "memoryAmountGb": { "type": "number", "description": "Total usage of memory\n" }, "memoryGbPerHour": { "type": "number", "description": "Gigabyte per hour\n" }, "memoryGbPerHourBySubscription": { "type": "number", "description": "Gigabyte per hour by subscription\n" }, "ocpuCount": { "type": "number", "description": "Total number of OCPUs\n" }, "ocpuPerHour": { "type": "number", "description": "OCPU per hour\n" }, "ocpuPerHourBySubscription": { "type": "number", "description": "OCPU per hour by subscription\n" }, "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "gpuCount", "gpuPerHour", "gpuPerHourBySubscription", "memoryAmountGb", "memoryGbPerHour", "memoryGbPerHourBySubscription", "ocpuCount", "ocpuPerHour", "ocpuPerHourBySubscription", "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostOsImage:getMigrationPlanMigrationPlanStatTotalEstimatedCostOsImage": { "properties": { "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostStorage:getMigrationPlanMigrationPlanStatTotalEstimatedCostStorage": { "properties": { "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume:getMigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume" }, "description": "Volume estimation\n" } }, "type": "object", "required": [ "totalGbPerMonth", "totalGbPerMonthBySubscription", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume:getMigrationPlanMigrationPlanStatTotalEstimatedCostStorageVolume": { "properties": { "capacityGb": { "type": "number", "description": "Gigabyte storage capacity\n" }, "description": { "type": "string", "description": "Volume description\n" }, "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" } }, "type": "object", "required": [ "capacityGb", "description", "totalGbPerMonth", "totalGbPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanStrategy:getMigrationPlanStrategy": { "properties": { "adjustmentMultiplier": { "type": "number", "description": "The real resource usage is multiplied to this number before making any recommendation.\n" }, "metricTimeWindow": { "type": "string", "description": "The current state of the migration plan.\n" }, "metricType": { "type": "string", "description": "The current state of the migration plan.\n" }, "percentile": { "type": "string", "description": "Percentile value\n" }, "resourceType": { "type": "string", "description": "The type of resource.\n" }, "strategyType": { "type": "string", "description": "The type of strategy used for migration.\n" } }, "type": "object", "required": [ "adjustmentMultiplier", "metricTimeWindow", "metricType", "percentile", "resourceType", "strategyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlanTargetEnvironment:getMigrationPlanTargetEnvironment": { "properties": { "availabilityDomain": { "type": "string", "description": "Availability Domain of the VM configuration.\n" }, "clusterAssetId": { "type": "string", "description": "Inventory asset id of the olvm cluster\n" }, "dedicatedVmHost": { "type": "string", "description": "OCID of the dedicated VM configuration host.\n" }, "faultDomain": { "type": "string", "description": "Fault domain of the VM configuration.\n" }, "msLicense": { "type": "string", "description": "Microsoft license for the VM configuration.\n" }, "olvmTemplates": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OLVM OS type to inventory asset id of the template\n" }, "preferredShapeType": { "type": "string", "description": "Preferred VM shape type provided by the customer.\n" }, "subnet": { "type": "string", "description": "OCID of the VM configuration subnet.\n" }, "targetCompartmentId": { "type": "string", "description": "Target compartment identifier\n" }, "targetEnvironmentType": { "type": "string", "description": "The type of target environment.\n" }, "vcn": { "type": "string", "description": "OCID of the VM configuration VCN.\n" }, "vnicProfileAssetId": { "type": "string", "description": "Inventory asset Id of the vnic profile\n" } }, "type": "object", "required": [ "availabilityDomain", "clusterAssetId", "dedicatedVmHost", "faultDomain", "msLicense", "olvmTemplates", "preferredShapeType", "subnet", "targetCompartmentId", "targetEnvironmentType", "vcn", "vnicProfileAssetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansFilter:getMigrationPlansFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollection:getMigrationPlansMigrationPlanCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItem:getMigrationPlansMigrationPlanCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItem:getMigrationPlansMigrationPlanCollectionItem": { "properties": { "calculatedLimits": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Limits of the resources that are needed for migration. Example: {\"BlockVolume\": 2, \"VCN\": 1}\n" }, "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The unique Oracle ID (OCID) that is immutable on creation.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationId": { "type": "string", "description": "Unique migration identifier\n" }, "migrationPlanStats": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStat:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStat" }, "description": "Status of the migration plan.\n" }, "referenceToRmsStack": { "type": "string", "description": "OCID of the referenced ORM job.\n" }, "sourceMigrationPlanId": { "type": "string", "description": "Source migraiton plan ID to be cloned.\n" }, "state": { "type": "string", "description": "The current state of the migration plan.\n" }, "strategies": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemStrategy:getMigrationPlansMigrationPlanCollectionItemStrategy" }, "description": "List of strategies for the resources to be migrated.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetEnvironments": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemTargetEnvironment:getMigrationPlansMigrationPlanCollectionItemTargetEnvironment" }, "description": "List of target environments.\n" }, "timeCreated": { "type": "string", "description": "The time when the migration plan was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the migration plan was updated. An RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "calculatedLimits", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "lifecycleDetails", "migrationId", "migrationPlanStats", "referenceToRmsStack", "sourceMigrationPlanId", "state", "strategies", "systemTags", "targetEnvironments", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStat:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStat": { "properties": { "costToMigrates": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCostToMigrate:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCostToMigrate" }, "description": "Summary of costs to migrate.\n" }, "currentMonthlyCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCurrentMonthlyCost:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCurrentMonthlyCost" }, "description": "Current monthly compute and storage costs.\n" }, "timeUpdated": { "type": "string", "description": "The time when the migration plan was updated. An RFC3339 formatted datetime string.\n" }, "totalEstimatedCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCost:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCost" }, "description": "Cost estimation description\n" }, "vmCount": { "type": "integer", "description": "The total count of VMs in migration\n" } }, "type": "object", "required": [ "costToMigrates", "currentMonthlyCosts", "timeUpdated", "totalEstimatedCosts", "vmCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCostToMigrate:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCostToMigrate": { "properties": { "assetCount": { "type": "integer", "description": "Number of assets used in this calculation.\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "ociDataTransferCosts": { "type": "number", "description": "Data transfer costs from OCI.\n" }, "sourceDataTransferCosts": { "type": "number", "description": "Data transfer costs from source cloud provider.\n" } }, "type": "object", "required": [ "assetCount", "currencyCode", "ociDataTransferCosts", "sourceDataTransferCosts" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCurrentMonthlyCost:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatCurrentMonthlyCost": { "properties": { "assetCount": { "type": "integer", "description": "Number of assets used in this calculation.\n" }, "computeAmount": { "type": "number", "description": "Current monthly compute costs.\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "storageAmount": { "type": "number", "description": "Current monthly storage costs.\n" } }, "type": "object", "required": [ "assetCount", "computeAmount", "currencyCode", "storageAmount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCost:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCost": { "properties": { "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostCompute:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostCompute" }, "description": "Cost estimation for compute\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "osImages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostOsImage:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostOsImage" }, "description": "Cost estimation for the OS image.\n" }, "storages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorage:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorage" }, "description": "Cost estimation for storage\n" }, "subscriptionId": { "type": "string", "description": "Subscription ID\n" }, "totalEstimationPerMonth": { "type": "number", "description": "Total estimation per month\n" }, "totalEstimationPerMonthBySubscription": { "type": "number", "description": "Total estimation per month by subscription.\n" } }, "type": "object", "required": [ "computes", "currencyCode", "osImages", "storages", "subscriptionId", "totalEstimationPerMonth", "totalEstimationPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostCompute:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostCompute": { "properties": { "gpuCount": { "type": "number", "description": "Total number of GPU\n" }, "gpuPerHour": { "type": "number", "description": "GPU per hour\n" }, "gpuPerHourBySubscription": { "type": "number", "description": "GPU per hour by subscription\n" }, "memoryAmountGb": { "type": "number", "description": "Total usage of memory\n" }, "memoryGbPerHour": { "type": "number", "description": "Gigabyte per hour\n" }, "memoryGbPerHourBySubscription": { "type": "number", "description": "Gigabyte per hour by subscription\n" }, "ocpuCount": { "type": "number", "description": "Total number of OCPUs\n" }, "ocpuPerHour": { "type": "number", "description": "OCPU per hour\n" }, "ocpuPerHourBySubscription": { "type": "number", "description": "OCPU per hour by subscription\n" }, "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "gpuCount", "gpuPerHour", "gpuPerHourBySubscription", "memoryAmountGb", "memoryGbPerHour", "memoryGbPerHourBySubscription", "ocpuCount", "ocpuPerHour", "ocpuPerHourBySubscription", "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostOsImage:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostOsImage": { "properties": { "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorage:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorage": { "properties": { "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorageVolume:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorageVolume" }, "description": "Volume estimation\n" } }, "type": "object", "required": [ "totalGbPerMonth", "totalGbPerMonthBySubscription", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorageVolume:getMigrationPlansMigrationPlanCollectionItemMigrationPlanStatTotalEstimatedCostStorageVolume": { "properties": { "capacityGb": { "type": "number", "description": "Gigabyte storage capacity\n" }, "description": { "type": "string", "description": "Volume description\n" }, "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" } }, "type": "object", "required": [ "capacityGb", "description", "totalGbPerMonth", "totalGbPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemStrategy:getMigrationPlansMigrationPlanCollectionItemStrategy": { "properties": { "adjustmentMultiplier": { "type": "number", "description": "The real resource usage is multiplied to this number before making any recommendation.\n" }, "metricTimeWindow": { "type": "string", "description": "The current state of the migration plan.\n" }, "metricType": { "type": "string", "description": "The current state of the migration plan.\n" }, "percentile": { "type": "string", "description": "Percentile value\n" }, "resourceType": { "type": "string", "description": "The type of resource.\n" }, "strategyType": { "type": "string", "description": "The type of strategy used for migration.\n" } }, "type": "object", "required": [ "adjustmentMultiplier", "metricTimeWindow", "metricType", "percentile", "resourceType", "strategyType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationPlansMigrationPlanCollectionItemTargetEnvironment:getMigrationPlansMigrationPlanCollectionItemTargetEnvironment": { "properties": { "availabilityDomain": { "type": "string", "description": "Availability Domain of the VM configuration.\n" }, "clusterAssetId": { "type": "string", "description": "Inventory asset id of the olvm cluster\n" }, "dedicatedVmHost": { "type": "string", "description": "OCID of the dedicated VM configuration host.\n" }, "faultDomain": { "type": "string", "description": "Fault domain of the VM configuration.\n" }, "msLicense": { "type": "string", "description": "Microsoft license for the VM configuration.\n" }, "olvmTemplates": { "type": "object", "additionalProperties": { "type": "string" }, "description": "OLVM OS type to inventory asset id of the template\n" }, "preferredShapeType": { "type": "string", "description": "Preferred VM shape type provided by the customer.\n" }, "subnet": { "type": "string", "description": "OCID of the VM configuration subnet.\n" }, "targetCompartmentId": { "type": "string", "description": "Target compartment identifier\n" }, "targetEnvironmentType": { "type": "string", "description": "The type of target environment.\n" }, "vcn": { "type": "string", "description": "OCID of the VM configuration VCN.\n" }, "vnicProfileAssetId": { "type": "string", "description": "Inventory asset Id of the vnic profile\n" } }, "type": "object", "required": [ "availabilityDomain", "clusterAssetId", "dedicatedVmHost", "faultDomain", "msLicense", "olvmTemplates", "preferredShapeType", "subnet", "targetCompartmentId", "targetEnvironmentType", "vcn", "vnicProfileAssetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationsFilter:getMigrationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudMigrations/getMigrationsMigrationCollection:getMigrationsMigrationCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationsMigrationCollectionItem:getMigrationsMigrationCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationsMigrationCollectionItem:getMigrationsMigrationCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Unique identifier that is immutable on creation\n" }, "isCompleted": { "type": "boolean", "description": "Indicates whether migration is marked as completed.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getMigrationsMigrationCollectionItemMigrationConfig:getMigrationsMigrationCollectionItemMigrationConfig" }, "description": "Configuration for a Migration Project.\n" }, "migrationType": { "type": "string", "description": "Type of migration project (OCI/OLVM). This determines the target environment for the migration.\n" }, "replicationScheduleId": { "type": "string", "description": "Replication schedule identifier\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}`\n" }, "state": { "type": "string", "description": "A filter to return only resources where the resource's lifecycle state matches the given lifecycle state.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the migration project was created. An RFC3339 formatted datetime string\n" }, "timeUpdated": { "type": "string", "description": "The time when the migration project was updated. An RFC3339 formatted datetime string\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "isCompleted", "lifecycleDetails", "migrationConfigs", "migrationType", "replicationScheduleId", "securityAttributes", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getMigrationsMigrationCollectionItemMigrationConfig:getMigrationsMigrationCollectionItemMigrationConfig": { "properties": { "subnetId": { "type": "string", "description": "The OCID of the subnet to use for replication\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getReplicationSchedulesFilter:getReplicationSchedulesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudMigrations/getReplicationSchedulesReplicationScheduleCollection:getReplicationSchedulesReplicationScheduleCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getReplicationSchedulesReplicationScheduleCollectionItem:getReplicationSchedulesReplicationScheduleCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getReplicationSchedulesReplicationScheduleCollectionItem:getReplicationSchedulesReplicationScheduleCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The ID of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "executionRecurrences": { "type": "string", "description": "Recurrence specification for the replication schedule execution.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the replication schedule.\n" }, "lifecycleDetails": { "type": "string", "description": "The detailed state of the replication schedule.\n" }, "state": { "type": "string", "description": "The current state of the replication schedule.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time when the replication schedule was created in RFC3339 format.\n" }, "timeUpdated": { "type": "string", "description": "The time when the replication schedule was last updated in RFC3339 format.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "executionRecurrences", "freeformTags", "id", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetCompatibilityMessage:getTargetAssetCompatibilityMessage": { "properties": { "message": { "type": "string", "description": "Detailed description of the compatibility issue.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "severity": { "type": "string", "description": "Severity level of the compatibility issue.\n" } }, "type": "object", "required": [ "message", "name", "severity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetEstimatedCost:getTargetAssetEstimatedCost": { "properties": { "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetEstimatedCostCompute:getTargetAssetEstimatedCostCompute" }, "description": "Cost estimation for compute\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "osImages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetEstimatedCostOsImage:getTargetAssetEstimatedCostOsImage" }, "description": "Cost estimation for the OS image.\n" }, "storages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetEstimatedCostStorage:getTargetAssetEstimatedCostStorage" }, "description": "Cost estimation for storage\n" }, "subscriptionId": { "type": "string", "description": "Subscription ID\n" }, "totalEstimationPerMonth": { "type": "number", "description": "Total estimation per month\n" }, "totalEstimationPerMonthBySubscription": { "type": "number", "description": "Total estimation per month by subscription.\n" } }, "type": "object", "required": [ "computes", "currencyCode", "osImages", "storages", "subscriptionId", "totalEstimationPerMonth", "totalEstimationPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetEstimatedCostCompute:getTargetAssetEstimatedCostCompute": { "properties": { "gpuCount": { "type": "number", "description": "Total number of GPU\n" }, "gpuPerHour": { "type": "number", "description": "GPU per hour\n" }, "gpuPerHourBySubscription": { "type": "number", "description": "GPU per hour by subscription\n" }, "memoryAmountGb": { "type": "number", "description": "Total usage of memory\n" }, "memoryGbPerHour": { "type": "number", "description": "Gigabyte per hour\n" }, "memoryGbPerHourBySubscription": { "type": "number", "description": "Gigabyte per hour by subscription\n" }, "ocpuCount": { "type": "number", "description": "Total number of OCPUs\n" }, "ocpuPerHour": { "type": "number", "description": "OCPU per hour\n" }, "ocpuPerHourBySubscription": { "type": "number", "description": "OCPU per hour by subscription\n" }, "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "gpuCount", "gpuPerHour", "gpuPerHourBySubscription", "memoryAmountGb", "memoryGbPerHour", "memoryGbPerHourBySubscription", "ocpuCount", "ocpuPerHour", "ocpuPerHourBySubscription", "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetEstimatedCostOsImage:getTargetAssetEstimatedCostOsImage": { "properties": { "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetEstimatedCostStorage:getTargetAssetEstimatedCostStorage": { "properties": { "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetEstimatedCostStorageVolume:getTargetAssetEstimatedCostStorageVolume" }, "description": "Volume estimation\n" } }, "type": "object", "required": [ "totalGbPerMonth", "totalGbPerMonthBySubscription", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetEstimatedCostStorageVolume:getTargetAssetEstimatedCostStorageVolume": { "properties": { "capacityGb": { "type": "number", "description": "Gigabyte storage capacity\n" }, "description": { "type": "string", "description": "Volume description\n" }, "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" } }, "type": "object", "required": [ "capacityGb", "description", "totalGbPerMonth", "totalGbPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetMigrationAsset:getTargetAssetMigrationAsset": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "dependedOnBies": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depend on the asset.\n" }, "dependsOns": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depends on the asset.\n" }, "destinationDisks": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Mapping of source disk id to destination disk details\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "id": { "type": "string", "description": "Asset ID generated by mirgration service. It is used in the mirgration service pipeline.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationId": { "type": "string", "description": "OCID of the associated migration.\n" }, "notifications": { "type": "array", "items": { "type": "string" }, "description": "List of notifications\n" }, "parentSnapshot": { "type": "string", "description": "The parent snapshot of the migration asset to be used by the replication task.\n" }, "replicationCompartmentId": { "type": "string", "description": "Replication compartment identifier\n" }, "replicationLocationDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetMigrationAssetReplicationLocationDetail:getTargetAssetMigrationAssetReplicationLocationDetail" }, "description": "Replication location detail where the snapshots reside\n" }, "replicationScheduleId": { "type": "string", "description": "Replication schedule identifier\n" }, "snapShotBucketName": { "type": "string", "description": "Name of snapshot bucket\n" }, "snapshots": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetId": { "type": "string", "description": "OCID that is referenced to an asset for an inventory.\n" }, "state": { "type": "string", "description": "The current state of the target asset.\n" }, "tenancyId": { "type": "string", "description": "Tenancy identifier\n" }, "timeCreated": { "type": "string", "description": "The time when the target asset was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the target asset was updated. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "dependedOnBies", "dependsOns", "destinationDisks", "displayName", "id", "lifecycleDetails", "migrationId", "notifications", "parentSnapshot", "replicationCompartmentId", "replicationLocationDetails", "replicationScheduleId", "snapShotBucketName", "snapshots", "sourceAssetData", "sourceAssetId", "state", "tenancyId", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetMigrationAssetReplicationLocationDetail:getTargetAssetMigrationAssetReplicationLocationDetail": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties for each of the replication location types\n" }, "replicationLocationType": { "type": "string", "description": "The type of replication location\n" } }, "type": "object", "required": [ "metadata", "replicationLocationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpec:getTargetAssetRecommendedSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecAgentConfig:getTargetAssetRecommendedSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecCreateVnicDetail:getTargetAssetRecommendedSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecInstanceOption:getTargetAssetRecommendedSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecPreemptibleInstanceConfig:getTargetAssetRecommendedSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecShapeConfig:getTargetAssetRecommendedSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecSourceDetail:getTargetAssetRecommendedSpecSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecAgentConfig:getTargetAssetRecommendedSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecAgentConfigPluginsConfig:getTargetAssetRecommendedSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecAgentConfigPluginsConfig:getTargetAssetRecommendedSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecCreateVnicDetail:getTargetAssetRecommendedSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "required": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecInstanceOption:getTargetAssetRecommendedSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecPreemptibleInstanceConfig:getTargetAssetRecommendedSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetRecommendedSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecShapeConfig:getTargetAssetRecommendedSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetRecommendedSpecSourceDetail:getTargetAssetRecommendedSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpec:getTargetAssetTestSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecAgentConfig:getTargetAssetTestSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecCreateVnicDetail:getTargetAssetTestSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecInstanceOption:getTargetAssetTestSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecPreemptibleInstanceConfig:getTargetAssetTestSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecShapeConfig:getTargetAssetTestSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecSourceDetail:getTargetAssetTestSpecSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecAgentConfig:getTargetAssetTestSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecAgentConfigPluginsConfig:getTargetAssetTestSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecAgentConfigPluginsConfig:getTargetAssetTestSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecCreateVnicDetail:getTargetAssetTestSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "required": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecInstanceOption:getTargetAssetTestSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecPreemptibleInstanceConfig:getTargetAssetTestSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetTestSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecShapeConfig:getTargetAssetTestSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetTestSpecSourceDetail:getTargetAssetTestSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpec:getTargetAssetUserSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecAgentConfig:getTargetAssetUserSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecCreateVnicDetail:getTargetAssetUserSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecInstanceOption:getTargetAssetUserSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecPreemptibleInstanceConfig:getTargetAssetUserSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecShapeConfig:getTargetAssetUserSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecSourceDetail:getTargetAssetUserSpecSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecAgentConfig:getTargetAssetUserSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecAgentConfigPluginsConfig:getTargetAssetUserSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecAgentConfigPluginsConfig:getTargetAssetUserSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecCreateVnicDetail:getTargetAssetUserSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "required": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecInstanceOption:getTargetAssetUserSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecPreemptibleInstanceConfig:getTargetAssetUserSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetUserSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecShapeConfig:getTargetAssetUserSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetUserSpecSourceDetail:getTargetAssetUserSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsFilter:getTargetAssetsFilter": { "properties": { "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollection:getTargetAssetsTargetAssetCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItem:getTargetAssetsTargetAssetCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItem:getTargetAssetsTargetAssetCollectionItem": { "properties": { "blockVolumesPerformance": { "type": "integer", "description": "Performance of the block volumes.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "compatibilityMessages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemCompatibilityMessage:getTargetAssetsTargetAssetCollectionItemCompatibilityMessage" }, "description": "Messages about the compatibility issues.\n" }, "createdResourceId": { "type": "string", "description": "Created resource identifier\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "estimatedCosts": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCost:getTargetAssetsTargetAssetCollectionItemEstimatedCost" }, "description": "Cost estimation description\n" }, "id": { "type": "string", "description": "Asset ID generated by mirgration service. It is used in the mirgration service pipeline.\n" }, "isExcludedFromExecution": { "type": "boolean", "description": "A boolean indicating whether the asset should be migrated.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationAssets": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemMigrationAsset:getTargetAssetsTargetAssetCollectionItemMigrationAsset" }, "description": "Description of the migration asset.\n" }, "migrationPlanId": { "type": "string", "description": "Unique migration plan identifier\n" }, "msLicense": { "type": "string", "description": "Microsoft license for VM configuration.\n" }, "preferredShapeType": { "type": "string", "description": "Preferred VM shape type that you provide.\n" }, "recommendedSpecs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpec:getTargetAssetsTargetAssetCollectionItemRecommendedSpec" }, "description": "Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" }, "state": { "type": "string", "description": "The current state of the target asset.\n" }, "testSpecs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpec:getTargetAssetsTargetAssetCollectionItemTestSpec" }, "description": "Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" }, "timeAssessed": { "type": "string", "description": "The time when the assessment was done. An RFC3339 formatted datetime string.\n" }, "timeCreated": { "type": "string", "description": "The time when the target asset was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the target asset was updated. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" }, "userSpecs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpec:getTargetAssetsTargetAssetCollectionItemUserSpec" }, "description": "Instance launch details. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" } }, "type": "object", "required": [ "blockVolumesPerformance", "compartmentId", "compatibilityMessages", "createdResourceId", "displayName", "estimatedCosts", "id", "isExcludedFromExecution", "lifecycleDetails", "migrationAssets", "migrationPlanId", "msLicense", "preferredShapeType", "recommendedSpecs", "state", "testSpecs", "timeAssessed", "timeCreated", "timeUpdated", "type", "userSpecs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemCompatibilityMessage:getTargetAssetsTargetAssetCollectionItemCompatibilityMessage": { "properties": { "message": { "type": "string", "description": "Detailed description of the compatibility issue.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "severity": { "type": "string", "description": "Severity level of the compatibility issue.\n" } }, "type": "object", "required": [ "message", "name", "severity" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCost:getTargetAssetsTargetAssetCollectionItemEstimatedCost": { "properties": { "computes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostCompute:getTargetAssetsTargetAssetCollectionItemEstimatedCostCompute" }, "description": "Cost estimation for compute\n" }, "currencyCode": { "type": "string", "description": "Currency code in the ISO format.\n" }, "osImages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostOsImage:getTargetAssetsTargetAssetCollectionItemEstimatedCostOsImage" }, "description": "Cost estimation for the OS image.\n" }, "storages": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostStorage:getTargetAssetsTargetAssetCollectionItemEstimatedCostStorage" }, "description": "Cost estimation for storage\n" }, "subscriptionId": { "type": "string", "description": "Subscription ID\n" }, "totalEstimationPerMonth": { "type": "number", "description": "Total estimation per month\n" }, "totalEstimationPerMonthBySubscription": { "type": "number", "description": "Total estimation per month by subscription.\n" } }, "type": "object", "required": [ "computes", "currencyCode", "osImages", "storages", "subscriptionId", "totalEstimationPerMonth", "totalEstimationPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostCompute:getTargetAssetsTargetAssetCollectionItemEstimatedCostCompute": { "properties": { "gpuCount": { "type": "number", "description": "Total number of GPU\n" }, "gpuPerHour": { "type": "number", "description": "GPU per hour\n" }, "gpuPerHourBySubscription": { "type": "number", "description": "GPU per hour by subscription\n" }, "memoryAmountGb": { "type": "number", "description": "Total usage of memory\n" }, "memoryGbPerHour": { "type": "number", "description": "Gigabyte per hour\n" }, "memoryGbPerHourBySubscription": { "type": "number", "description": "Gigabyte per hour by subscription\n" }, "ocpuCount": { "type": "number", "description": "Total number of OCPUs\n" }, "ocpuPerHour": { "type": "number", "description": "OCPU per hour\n" }, "ocpuPerHourBySubscription": { "type": "number", "description": "OCPU per hour by subscription\n" }, "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "gpuCount", "gpuPerHour", "gpuPerHourBySubscription", "memoryAmountGb", "memoryGbPerHour", "memoryGbPerHourBySubscription", "ocpuCount", "ocpuPerHour", "ocpuPerHourBySubscription", "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostOsImage:getTargetAssetsTargetAssetCollectionItemEstimatedCostOsImage": { "properties": { "totalPerHour": { "type": "number", "description": "Total price per hour\n" }, "totalPerHourBySubscription": { "type": "number", "description": "Total price per hour by subscription\n" } }, "type": "object", "required": [ "totalPerHour", "totalPerHourBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostStorage:getTargetAssetsTargetAssetCollectionItemEstimatedCostStorage": { "properties": { "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostStorageVolume:getTargetAssetsTargetAssetCollectionItemEstimatedCostStorageVolume" }, "description": "Volume estimation\n" } }, "type": "object", "required": [ "totalGbPerMonth", "totalGbPerMonthBySubscription", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemEstimatedCostStorageVolume:getTargetAssetsTargetAssetCollectionItemEstimatedCostStorageVolume": { "properties": { "capacityGb": { "type": "number", "description": "Gigabyte storage capacity\n" }, "description": { "type": "string", "description": "Volume description\n" }, "totalGbPerMonth": { "type": "number", "description": "Gigabyte storage capacity per month.\n" }, "totalGbPerMonthBySubscription": { "type": "number", "description": "Gigabyte storage capacity per month by subscription\n" } }, "type": "object", "required": [ "capacityGb", "description", "totalGbPerMonth", "totalGbPerMonthBySubscription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemMigrationAsset:getTargetAssetsTargetAssetCollectionItemMigrationAsset": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "dependedOnBies": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depend on the asset.\n" }, "dependsOns": { "type": "array", "items": { "type": "string" }, "description": "List of migration assets that depends on the asset.\n" }, "destinationDisks": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Mapping of source disk id to destination disk details\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "id": { "type": "string", "description": "Asset ID generated by mirgration service. It is used in the mirgration service pipeline.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.\n" }, "migrationId": { "type": "string", "description": "OCID of the associated migration.\n" }, "notifications": { "type": "array", "items": { "type": "string" }, "description": "List of notifications\n" }, "parentSnapshot": { "type": "string", "description": "The parent snapshot of the migration asset to be used by the replication task.\n" }, "replicationCompartmentId": { "type": "string", "description": "Replication compartment identifier\n" }, "replicationLocationDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemMigrationAssetReplicationLocationDetail:getTargetAssetsTargetAssetCollectionItemMigrationAssetReplicationLocationDetail" }, "description": "Replication location detail where the snapshots reside\n" }, "replicationScheduleId": { "type": "string", "description": "Replication schedule identifier\n" }, "snapShotBucketName": { "type": "string", "description": "Name of snapshot bucket\n" }, "snapshots": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing disks ID mapped to the OCIDs of replicated or hydration server volume snapshots. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Key-value pair representing asset metadata keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`\n" }, "sourceAssetId": { "type": "string", "description": "OCID that is referenced to an asset for an inventory.\n" }, "state": { "type": "string", "description": "The current state of the target asset.\n" }, "tenancyId": { "type": "string", "description": "Tenancy identifier\n" }, "timeCreated": { "type": "string", "description": "The time when the target asset was created. An RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time when the target asset was updated. An RFC3339 formatted datetime string.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "dependedOnBies", "dependsOns", "destinationDisks", "displayName", "id", "lifecycleDetails", "migrationId", "notifications", "parentSnapshot", "replicationCompartmentId", "replicationLocationDetails", "replicationScheduleId", "snapShotBucketName", "snapshots", "sourceAssetData", "sourceAssetId", "state", "tenancyId", "timeCreated", "timeUpdated", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemMigrationAssetReplicationLocationDetail:getTargetAssetsTargetAssetCollectionItemMigrationAssetReplicationLocationDetail": { "properties": { "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Properties for each of the replication location types\n" }, "replicationLocationType": { "type": "string", "description": "The type of replication location\n" } }, "type": "object", "required": [ "metadata", "replicationLocationType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpec:getTargetAssetsTargetAssetCollectionItemRecommendedSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecCreateVnicDetail:getTargetAssetsTargetAssetCollectionItemRecommendedSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecInstanceOption:getTargetAssetsTargetAssetCollectionItemRecommendedSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecShapeConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecSourceDetail:getTargetAssetsTargetAssetCollectionItemRecommendedSpecSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfigPluginsConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfigPluginsConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecCreateVnicDetail:getTargetAssetsTargetAssetCollectionItemRecommendedSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "required": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecInstanceOption:getTargetAssetsTargetAssetCollectionItemRecommendedSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetsTargetAssetCollectionItemRecommendedSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecShapeConfig:getTargetAssetsTargetAssetCollectionItemRecommendedSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemRecommendedSpecSourceDetail:getTargetAssetsTargetAssetCollectionItemRecommendedSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpec:getTargetAssetsTargetAssetCollectionItemTestSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfig:getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecCreateVnicDetail:getTargetAssetsTargetAssetCollectionItemTestSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecInstanceOption:getTargetAssetsTargetAssetCollectionItemTestSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfig:getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecShapeConfig:getTargetAssetsTargetAssetCollectionItemTestSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecSourceDetail:getTargetAssetsTargetAssetCollectionItemTestSpecSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfig:getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfigPluginsConfig:getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfigPluginsConfig:getTargetAssetsTargetAssetCollectionItemTestSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecCreateVnicDetail:getTargetAssetsTargetAssetCollectionItemTestSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "required": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecInstanceOption:getTargetAssetsTargetAssetCollectionItemTestSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfig:getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetsTargetAssetCollectionItemTestSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecShapeConfig:getTargetAssetsTargetAssetCollectionItemTestSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemTestSpecSourceDetail:getTargetAssetsTargetAssetCollectionItemTestSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpec:getTargetAssetsTargetAssetCollectionItemUserSpec": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfig:getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation under which this instance is launched. You can opt out of all default reservations by specifying an empty string as input for this field. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecCreateVnicDetail:getTargetAssetsTargetAssetCollectionItemUserSpecCreateVnicDetail" }, "description": "Contains properties for a VNIC. You use this object when creating the primary VNIC during instance launch or when creating a secondary VNIC. For more information about VNICs, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated VM host.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains lets you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecInstanceOption:getTargetAssetsTargetAssetCollectionItemUserSpecInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. By default, the value is false.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfig:getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecShapeConfig:getTargetAssetsTargetAssetCollectionItemUserSpecShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecSourceDetail:getTargetAssetsTargetAssetCollectionItemUserSpecSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityDomain", "capacityReservationId", "compartmentId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "faultDomain", "freeformTags", "hostnameLabel", "instanceOptions", "ipxeScript", "isPvEncryptionInTransitEnabled", "preemptibleInstanceConfigs", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfig:getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. By default, the value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. By default, the value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfigPluginsConfig:getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfigPluginsConfig:getTargetAssetsTargetAssetCollectionItemUserSpecAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecCreateVnicDetail:getTargetAssetsTargetAssetCollectionItemUserSpecCreateVnicDetail": { "properties": { "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. By default, the value is true.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire given display name.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. It exists only for cross-compatibility. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "Deprecated. Instead use `hostnameLabel` in [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/). If you provide both, the values must match.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of OCIDs of the network security groups (NSGs) that are added to the VNIC. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you should skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n" }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" } }, "type": "object", "required": [ "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecInstanceOption:getTargetAssetsTargetAssetCollectionItemUserSpecInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfig:getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfigPreemptionAction:getTargetAssetsTargetAssetCollectionItemUserSpecPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. By default, it is false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecShapeConfig:getTargetAssetsTargetAssetCollectionItemUserSpecShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory in gigabytes that is available to the instance.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:CloudMigrations/getTargetAssetsTargetAssetCollectionItemUserSpecSourceDetail:getTargetAssetsTargetAssetCollectionItemUserSpecSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB that represents the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the key management key to assign as the master encryption key for the boot volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/ClusterPlacementGroupCapabilities:ClusterPlacementGroupCapabilities": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/ClusterPlacementGroupCapabilitiesItem:ClusterPlacementGroupCapabilitiesItem" }, "description": "The supported resources.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "items" ] }, "oci:ClusterPlacementGroups/ClusterPlacementGroupCapabilitiesItem:ClusterPlacementGroupCapabilitiesItem": { "properties": { "additionalDetails": { "$ref": "#/types/oci:ClusterPlacementGroups/ClusterPlacementGroupCapabilitiesItemAdditionalDetails:ClusterPlacementGroupCapabilitiesItemAdditionalDetails", "description": "Additional details describing the selected capability.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The type of resource.\n", "willReplaceOnChanges": true }, "service": { "type": "string", "description": "The service that the resource is part of.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "service" ], "language": { "nodejs": { "requiredOutputs": [ "additionalDetails", "name", "service" ] } } }, "oci:ClusterPlacementGroups/ClusterPlacementGroupCapabilitiesItemAdditionalDetails:ClusterPlacementGroupCapabilitiesItemAdditionalDetails": { "properties": { "clusterPlacementGroupCount": { "type": "integer", "description": "The number of instances or size of the resource.\n", "willReplaceOnChanges": true }, "memoryInGbs": { "type": "number", "description": "The amount of memory (in GBs) needed in the instance.\n", "willReplaceOnChanges": true }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to use for storage.\n", "willReplaceOnChanges": true }, "ocpus": { "type": "number", "description": "The number of OCPUs needed in the instance.\n", "willReplaceOnChanges": true }, "serviceType": { "type": "string", "description": "Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "serviceType" ], "language": { "nodejs": { "requiredOutputs": [ "clusterPlacementGroupCount", "memoryInGbs", "nvmes", "ocpus", "serviceType" ] } } }, "oci:ClusterPlacementGroups/ClusterPlacementGroupPlacementInstruction:ClusterPlacementGroupPlacementInstruction": { "properties": { "type": { "type": "string", "description": "The type of placement instruction.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The value of the token designated for placement of the cluster placement group upon creation.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type", "value" ] }, "oci:ClusterPlacementGroups/getClusterPlacementGroupCapability:getClusterPlacementGroupCapability": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupCapabilityItem:getClusterPlacementGroupCapabilityItem" }, "description": "The supported resources.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupCapabilityItem:getClusterPlacementGroupCapabilityItem": { "properties": { "additionalDetails": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupCapabilityItemAdditionalDetail:getClusterPlacementGroupCapabilityItemAdditionalDetail" }, "description": "Additional details describing the selected capability.\n" }, "name": { "type": "string", "description": "The user-friendly name of the cluster placement group. The display name for a cluster placement must be unique and you cannot change it. Avoid entering confidential information.\n" }, "service": { "type": "string", "description": "The service that the resource is part of.\n" } }, "type": "object", "required": [ "additionalDetails", "name", "service" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupCapabilityItemAdditionalDetail:getClusterPlacementGroupCapabilityItemAdditionalDetail": { "properties": { "clusterPlacementGroupCount": { "type": "integer", "description": "The number of instances or size of the resource.\n" }, "memoryInGbs": { "type": "number", "description": "The amount of memory (in GBs) needed in the instance.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to use for storage.\n" }, "ocpus": { "type": "number", "description": "The number of OCPUs needed in the instance.\n" }, "serviceType": { "type": "string", "description": "Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability.\n" } }, "type": "object", "required": [ "clusterPlacementGroupCount", "memoryInGbs", "nvmes", "ocpus", "serviceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupPlacementInstruction:getClusterPlacementGroupPlacementInstruction": { "properties": { "type": { "type": "string", "description": "The type of placement instruction.\n" }, "value": { "type": "string", "description": "The value of the token designated for placement of the cluster placement group upon creation.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollection:getClusterPlacementGroupsClusterPlacementGroupCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItem:getClusterPlacementGroupsClusterPlacementGroupCollectionItem" }, "description": "The supported resources.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItem:getClusterPlacementGroupsClusterPlacementGroupCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the cluster placement group.\n" }, "capabilities": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability:getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability" }, "description": "A list of resources that you can create in a cluster placement group.\n" }, "clusterPlacementGroupType": { "type": "string", "description": "The type of cluster placement group.\n" }, "compartmentId": { "type": "string", "description": "A filter to return only the resources that match the specified compartment [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A description of the cluster placement group.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "A filter to return only the resources that match the specified unique cluster placement group identifier.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, lifecycle details for a resource in a Failed state might include information to act on.\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire display name specified.\n" }, "opcDryRun": { "type": "boolean" }, "placementInstructions": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction:getClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction" }, "description": "Details that inform cluster placement group provisioning.\n" }, "state": { "type": "string", "description": "A filter to return only the resources that match the specified lifecycle state.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time the cluster placement group was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n" }, "timeUpdated": { "type": "string", "description": "The time the cluster placement group was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.\n" } }, "type": "object", "required": [ "availabilityDomain", "capabilities", "clusterPlacementGroupType", "compartmentId", "definedTags", "description", "freeformTags", "id", "lifecycleDetails", "name", "opcDryRun", "placementInstructions", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability:getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapability": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem:getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem" }, "description": "The supported resources.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem:getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItem": { "properties": { "additionalDetails": { "type": "array", "items": { "$ref": "#/types/oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItemAdditionalDetail:getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItemAdditionalDetail" }, "description": "Additional details describing the selected capability.\n" }, "name": { "type": "string", "description": "A filter to return only the resources that match the entire display name specified.\n" }, "service": { "type": "string", "description": "The service that the resource is part of.\n" } }, "type": "object", "required": [ "additionalDetails", "name", "service" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItemAdditionalDetail:getClusterPlacementGroupsClusterPlacementGroupCollectionItemCapabilityItemAdditionalDetail": { "properties": { "clusterPlacementGroupCount": { "type": "integer", "description": "The number of instances or size of the resource.\n" }, "memoryInGbs": { "type": "number", "description": "The amount of memory (in GBs) needed in the instance.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to use for storage.\n" }, "ocpus": { "type": "number", "description": "The number of OCPUs needed in the instance.\n" }, "serviceType": { "type": "string", "description": "Additional details about what service provides the capability. For example, `COMPUTE` means that the Oracle Cloud Infrastructure Compute service provides the selected capability.\n" } }, "type": "object", "required": [ "clusterPlacementGroupCount", "memoryInGbs", "nvmes", "ocpus", "serviceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction:getClusterPlacementGroupsClusterPlacementGroupCollectionItemPlacementInstruction": { "properties": { "type": { "type": "string", "description": "The type of placement instruction.\n" }, "value": { "type": "string", "description": "The value of the token designated for placement of the cluster placement group upon creation.\n" } }, "type": "object", "required": [ "type", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ClusterPlacementGroups/getClusterPlacementGroupsFilter:getClusterPlacementGroupsFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only the resources that match the entire display name specified.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureInventory:AtCustomerCccInfrastructureInfrastructureInventory": { "properties": { "capacityStorageTrayCount": { "type": "integer", "description": "The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage.\n" }, "computeNodeCount": { "type": "integer", "description": "The number of compute nodes that are available and usable on the Compute Cloud@Customer infrastructure rack. There is no distinction of compute node type in this information.\n" }, "managementNodeCount": { "type": "integer", "description": "The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack.\n" }, "performanceStorageTrayCount": { "type": "integer", "description": "The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage.\n" }, "serialNumber": { "type": "string", "description": "The serial number of the Compute Cloud@Customer infrastructure rack.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityStorageTrayCount", "computeNodeCount", "managementNodeCount", "performanceStorageTrayCount", "serialNumber" ] } } }, "oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfiguration:AtCustomerCccInfrastructureInfrastructureNetworkConfiguration": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network.\n" }, "infrastructureRoutingDynamics": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic" }, "description": "Dynamic routing information for the Compute Cloud@Customer infrastructure.\n" }, "infrastructureRoutingStatics": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic" }, "description": "Static routing information for a rack.\n" }, "managementNodes": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode" }, "description": "Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure.\n" }, "mgmtVipHostname": { "type": "string", "description": "The hostname corresponding to the virtual IP (VIP) address of the management nodes.\n" }, "mgmtVipIp": { "type": "string", "description": "The IP address used as the virtual IP (VIP) address of the management nodes.\n" }, "spineIps": { "type": "array", "items": { "type": "string" }, "description": "Addresses of the network spine switches.\n" }, "spineVip": { "type": "string", "description": "The spine switch public virtual IP (VIP). Traffic routed to the Compute Cloud@Customer infrastructure and and virtual cloud networks (VCNs) should have this address as next hop.\n" }, "uplinkDomain": { "type": "string", "description": "Domain name to be used as the base domain for the internal network and by public facing services.\n" }, "uplinkGatewayIp": { "type": "string", "description": "Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to.\n" }, "uplinkNetmask": { "type": "string", "description": "Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to.\n" }, "uplinkPortCount": { "type": "integer", "description": "Number of uplink ports per spine switch. Connectivity is identical on both spine switches. For example, if input is two 100 gigabyte ports; then port-1 and port-2 on both spines will be configured.\n" }, "uplinkPortForwardErrorCorrection": { "type": "string", "description": "The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure.\n" }, "uplinkPortSpeedInGbps": { "type": "integer", "description": "Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed.\n" }, "uplinkVlanMtu": { "type": "integer", "description": "The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "dnsIps", "infrastructureRoutingDynamics", "infrastructureRoutingStatics", "managementNodes", "mgmtVipHostname", "mgmtVipIp", "spineIps", "spineVip", "uplinkDomain", "uplinkGatewayIp", "uplinkNetmask", "uplinkPortCount", "uplinkPortForwardErrorCorrection", "uplinkPortSpeedInGbps", "uplinkVlanMtu" ] } } }, "oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic": { "properties": { "bgpTopology": { "type": "string", "description": "The topology in use for the Border Gateway Protocol (BGP) configuration.\n" }, "oracleAsn": { "type": "integer", "description": "The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration.\n" }, "peerInformations": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation" }, "description": "The list of peer devices in the dynamic routing configuration.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bgpTopology", "oracleAsn", "peerInformations" ] } } }, "oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation": { "properties": { "asn": { "type": "integer", "description": "The Autonomous System Number (ASN) of the peer network.\n" }, "ip": { "type": "string", "description": "Address of the management node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "asn", "ip" ] } } }, "oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic": { "properties": { "uplinkHsrpGroup": { "type": "integer", "description": "The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure.\n" }, "uplinkVlan": { "type": "integer", "description": "The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported).\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "uplinkHsrpGroup", "uplinkVlan" ] } } }, "oci:ComputeCloud/AtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode:AtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode": { "properties": { "hostname": { "type": "string", "description": "Hostname for interface to the management node.\n" }, "ip": { "type": "string", "description": "Address of the management node.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "hostname", "ip" ] } } }, "oci:ComputeCloud/AtCustomerCccInfrastructureUpgradeInformation:AtCustomerCccInfrastructureUpgradeInformation": { "properties": { "currentVersion": { "type": "string", "description": "The current version of software installed on the Compute Cloud@Customer infrastructure.\n" }, "isActive": { "type": "boolean", "description": "Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images).\n" }, "scheduledUpgradeDuration": { "type": "string", "description": "Expected duration of Compute Cloud@Customer infrastructure scheduled upgrade. The actual upgrade time might be longer or shorter than this duration depending on rack activity, this is only an estimate.\n" }, "timeOfScheduledUpgrade": { "type": "string", "description": "Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "currentVersion", "isActive", "scheduledUpgradeDuration", "timeOfScheduledUpgrade" ] } } }, "oci:ComputeCloud/AtCustomerCccUpgradeScheduleEvent:AtCustomerCccUpgradeScheduleEvent": { "properties": { "description": { "type": "string", "description": "(Updatable) A description of the Compute Cloud@Customer upgrade schedule time block.\n" }, "name": { "type": "string", "description": "Generated name associated with the event.\n" }, "scheduleEventDuration": { "type": "string", "description": "(Updatable) The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations.\n" }, "scheduleEventRecurrences": { "type": "string", "description": "(Updatable) Frequency of recurrence of schedule block. When this field is not included, the event is assumed to be a one time occurrence. The frequency field is strictly parsed and must conform to RFC-5545 formatting for recurrences.\n" }, "timeStart": { "type": "string", "description": "(Updatable) The date and time when the Compute Cloud@Customer upgrade schedule event starts, inclusive. An RFC3339 formatted UTC datetime string. For an event with recurrences, this is the date that a recurrence can start being applied.\n" } }, "type": "object", "required": [ "description", "scheduleEventDuration", "timeStart" ], "language": { "nodejs": { "requiredOutputs": [ "description", "name", "scheduleEventDuration", "scheduleEventRecurrences", "timeStart" ] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureInventory:getAtCustomerCccInfrastructureInfrastructureInventory": { "properties": { "capacityStorageTrayCount": { "type": "integer", "description": "The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage.\n" }, "computeNodeCount": { "type": "integer", "description": "The number of compute nodes that are available and usable on the Compute Cloud@Customer infrastructure rack. There is no distinction of compute node type in this information.\n" }, "managementNodeCount": { "type": "integer", "description": "The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack.\n" }, "performanceStorageTrayCount": { "type": "integer", "description": "The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage.\n" }, "serialNumber": { "type": "string", "description": "The serial number of the Compute Cloud@Customer infrastructure rack.\n" } }, "type": "object", "required": [ "capacityStorageTrayCount", "computeNodeCount", "managementNodeCount", "performanceStorageTrayCount", "serialNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfiguration:getAtCustomerCccInfrastructureInfrastructureNetworkConfiguration": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network.\n" }, "infrastructureRoutingDynamics": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic" }, "description": "Dynamic routing information for the Compute Cloud@Customer infrastructure.\n" }, "infrastructureRoutingStatics": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic" }, "description": "Static routing information for a rack.\n" }, "managementNodes": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode" }, "description": "Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure.\n" }, "mgmtVipHostname": { "type": "string", "description": "The hostname corresponding to the virtual IP (VIP) address of the management nodes.\n" }, "mgmtVipIp": { "type": "string", "description": "The IP address used as the virtual IP (VIP) address of the management nodes.\n" }, "spineIps": { "type": "array", "items": { "type": "string" }, "description": "Addresses of the network spine switches.\n" }, "spineVip": { "type": "string", "description": "The spine switch public virtual IP (VIP). Traffic routed to the Compute Cloud@Customer infrastructure and and virtual cloud networks (VCNs) should have this address as next hop.\n" }, "uplinkDomain": { "type": "string", "description": "Domain name to be used as the base domain for the internal network and by public facing services.\n" }, "uplinkGatewayIp": { "type": "string", "description": "Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to.\n" }, "uplinkNetmask": { "type": "string", "description": "Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to.\n" }, "uplinkPortCount": { "type": "integer", "description": "Number of uplink ports per spine switch. Connectivity is identical on both spine switches. For example, if input is two 100 gigabyte ports; then port-1 and port-2 on both spines will be configured.\n" }, "uplinkPortForwardErrorCorrection": { "type": "string", "description": "The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure.\n" }, "uplinkPortSpeedInGbps": { "type": "integer", "description": "Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed.\n" }, "uplinkVlanMtu": { "type": "integer", "description": "The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports.\n" } }, "type": "object", "required": [ "dnsIps", "infrastructureRoutingDynamics", "infrastructureRoutingStatics", "managementNodes", "mgmtVipHostname", "mgmtVipIp", "spineIps", "spineVip", "uplinkDomain", "uplinkGatewayIp", "uplinkNetmask", "uplinkPortCount", "uplinkPortForwardErrorCorrection", "uplinkPortSpeedInGbps", "uplinkVlanMtu" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamic": { "properties": { "bgpTopology": { "type": "string", "description": "The topology in use for the Border Gateway Protocol (BGP) configuration.\n" }, "oracleAsn": { "type": "integer", "description": "The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration.\n" }, "peerInformations": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation" }, "description": "The list of peer devices in the dynamic routing configuration.\n" } }, "type": "object", "required": [ "bgpTopology", "oracleAsn", "peerInformations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation": { "properties": { "asn": { "type": "integer", "description": "The Autonomous System Number (ASN) of the peer network.\n" }, "ip": { "type": "string", "description": "Address of the management node.\n" } }, "type": "object", "required": [ "asn", "ip" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationInfrastructureRoutingStatic": { "properties": { "uplinkHsrpGroup": { "type": "integer", "description": "The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure.\n" }, "uplinkVlan": { "type": "integer", "description": "The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported).\n" } }, "type": "object", "required": [ "uplinkHsrpGroup", "uplinkVlan" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode:getAtCustomerCccInfrastructureInfrastructureNetworkConfigurationManagementNode": { "properties": { "hostname": { "type": "string", "description": "Hostname for interface to the management node.\n" }, "ip": { "type": "string", "description": "Address of the management node.\n" } }, "type": "object", "required": [ "hostname", "ip" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructureUpgradeInformation:getAtCustomerCccInfrastructureUpgradeInformation": { "properties": { "currentVersion": { "type": "string", "description": "The current version of software installed on the Compute Cloud@Customer infrastructure.\n" }, "isActive": { "type": "boolean", "description": "Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images).\n" }, "scheduledUpgradeDuration": { "type": "string", "description": "Expected duration of Compute Cloud@Customer infrastructure scheduled upgrade. The actual upgrade time might be longer or shorter than this duration depending on rack activity, this is only an estimate.\n" }, "timeOfScheduledUpgrade": { "type": "string", "description": "Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time.\n" } }, "type": "object", "required": [ "currentVersion", "isActive", "scheduledUpgradeDuration", "timeOfScheduledUpgrade" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollection:getAtCustomerCccInfrastructuresCccInfrastructureCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItem:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItem:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItem": { "properties": { "cccUpgradeScheduleId": { "type": "string", "description": "Schedule used for upgrades. If no schedule is associated with the infrastructure, it can be updated at any time.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, "connectionDetails": { "type": "string", "description": "A message describing the current connection state in more detail.\n" }, "connectionState": { "type": "string", "description": "The current connection state of the infrastructure. A user can only update it from REQUEST to READY or from any state back to REJECT. The system automatically handles the REJECT to REQUEST, READY to CONNECTED, or CONNECTED to DISCONNECTED transitions.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A mutable client-meaningful text description of the Compute Cloud@Customer infrastructure. Avoid entering confidential information.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "The Compute Cloud@Customer infrastructure [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created.\n" }, "infrastructureInventories": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureInventory:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureInventory" }, "description": "Inventory for a Compute Cloud@Customer infrastructure. This information cannot be updated and is from the infrastructure. The information will only be available after the connectionState is transitioned to CONNECTED.\n" }, "infrastructureNetworkConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfiguration:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfiguration" }, "description": "Configuration information for the Compute Cloud@Customer infrastructure. This network configuration information cannot be updated and is retrieved from the data center. The information will only be available after the connectionState is transitioned to CONNECTED.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current lifecycle state in more detail. For example, this can be used to provide actionable information for a resource that is in a Failed state.\n" }, "provisioningFingerprint": { "type": "string", "description": "Fingerprint of a Compute Cloud@Customer infrastructure in a data center generated during the initial connection to this resource. The fingerprint should be verified by the administrator when changing the connectionState from REQUEST to READY.\n" }, "provisioningPin": { "type": "string", "description": "Code that is required for service personnel to connect a Compute Cloud@Customer infrastructure in a data center to this resource. This code will only be available when the connectionState is REJECT (usually at create time of the Compute Cloud@Customer infrastructure).\n" }, "shortName": { "type": "string", "description": "The Compute Cloud@Customer infrastructure short name. This cannot be changed once created. The short name is used to refer to the infrastructure in several contexts and is unique.\n" }, "state": { "type": "string", "description": "A filter used to return only resources that match the given lifecycleState.\n" }, "subnetId": { "type": "string", "description": "[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the network subnet that is used to communicate with Compute Cloud@Customer infrastructure.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "Compute Cloud@Customer infrastructure creation date and time, using an RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "Compute Cloud@Customer infrastructure updated date and time, using an RFC3339 formatted datetime string.\n" }, "upgradeInformations": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemUpgradeInformation:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemUpgradeInformation" }, "description": "Upgrade information that relates to a Compute Cloud@Customer infrastructure. This information cannot be updated.\n" } }, "type": "object", "required": [ "cccUpgradeScheduleId", "compartmentId", "connectionDetails", "connectionState", "definedTags", "description", "displayName", "freeformTags", "id", "infrastructureInventories", "infrastructureNetworkConfigurations", "lifecycleDetails", "provisioningFingerprint", "provisioningPin", "shortName", "state", "subnetId", "systemTags", "timeCreated", "timeUpdated", "upgradeInformations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureInventory:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureInventory": { "properties": { "capacityStorageTrayCount": { "type": "integer", "description": "The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for capacity storage.\n" }, "computeNodeCount": { "type": "integer", "description": "The number of compute nodes that are available and usable on the Compute Cloud@Customer infrastructure rack. There is no distinction of compute node type in this information.\n" }, "managementNodeCount": { "type": "integer", "description": "The number of management nodes that are available and in active use on the Compute Cloud@Customer infrastructure rack.\n" }, "performanceStorageTrayCount": { "type": "integer", "description": "The number of storage trays in the Compute Cloud@Customer infrastructure rack that are designated for performance storage.\n" }, "serialNumber": { "type": "string", "description": "The serial number of the Compute Cloud@Customer infrastructure rack.\n" } }, "type": "object", "required": [ "capacityStorageTrayCount", "computeNodeCount", "managementNodeCount", "performanceStorageTrayCount", "serialNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfiguration:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfiguration": { "properties": { "dnsIps": { "type": "array", "items": { "type": "string" }, "description": "The domain name system (DNS) addresses that the Compute Cloud@Customer infrastructure uses for the data center network.\n" }, "infrastructureRoutingDynamics": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamic:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamic" }, "description": "Dynamic routing information for the Compute Cloud@Customer infrastructure.\n" }, "infrastructureRoutingStatics": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingStatic:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingStatic" }, "description": "Static routing information for a rack.\n" }, "managementNodes": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationManagementNode:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationManagementNode" }, "description": "Information about the management nodes that are provisioned in the Compute Cloud@Customer infrastructure.\n" }, "mgmtVipHostname": { "type": "string", "description": "The hostname corresponding to the virtual IP (VIP) address of the management nodes.\n" }, "mgmtVipIp": { "type": "string", "description": "The IP address used as the virtual IP (VIP) address of the management nodes.\n" }, "spineIps": { "type": "array", "items": { "type": "string" }, "description": "Addresses of the network spine switches.\n" }, "spineVip": { "type": "string", "description": "The spine switch public virtual IP (VIP). Traffic routed to the Compute Cloud@Customer infrastructure and and virtual cloud networks (VCNs) should have this address as next hop.\n" }, "uplinkDomain": { "type": "string", "description": "Domain name to be used as the base domain for the internal network and by public facing services.\n" }, "uplinkGatewayIp": { "type": "string", "description": "Uplink gateway in the datacenter network that the Compute Cloud@Customer connects to.\n" }, "uplinkNetmask": { "type": "string", "description": "Netmask of the subnet that the Compute Cloud@Customer infrastructure is connected to.\n" }, "uplinkPortCount": { "type": "integer", "description": "Number of uplink ports per spine switch. Connectivity is identical on both spine switches. For example, if input is two 100 gigabyte ports; then port-1 and port-2 on both spines will be configured.\n" }, "uplinkPortForwardErrorCorrection": { "type": "string", "description": "The port forward error correction (FEC) setting for the uplink port on the Compute Cloud@Customer infrastructure.\n" }, "uplinkPortSpeedInGbps": { "type": "integer", "description": "Uplink port speed defined in gigabytes per second. All uplink ports must have identical speed.\n" }, "uplinkVlanMtu": { "type": "integer", "description": "The virtual local area network (VLAN) maximum transmission unit (MTU) size for the uplink ports.\n" } }, "type": "object", "required": [ "dnsIps", "infrastructureRoutingDynamics", "infrastructureRoutingStatics", "managementNodes", "mgmtVipHostname", "mgmtVipIp", "spineIps", "spineVip", "uplinkDomain", "uplinkGatewayIp", "uplinkNetmask", "uplinkPortCount", "uplinkPortForwardErrorCorrection", "uplinkPortSpeedInGbps", "uplinkVlanMtu" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamic:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamic": { "properties": { "bgpTopology": { "type": "string", "description": "The topology in use for the Border Gateway Protocol (BGP) configuration.\n" }, "oracleAsn": { "type": "integer", "description": "The Oracle Autonomous System Number (ASN) to control routing and exchange information within the dynamic routing configuration.\n" }, "peerInformations": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation" }, "description": "The list of peer devices in the dynamic routing configuration.\n" } }, "type": "object", "required": [ "bgpTopology", "oracleAsn", "peerInformations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingDynamicPeerInformation": { "properties": { "asn": { "type": "integer", "description": "The Autonomous System Number (ASN) of the peer network.\n" }, "ip": { "type": "string", "description": "Address of the management node.\n" } }, "type": "object", "required": [ "asn", "ip" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingStatic:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationInfrastructureRoutingStatic": { "properties": { "uplinkHsrpGroup": { "type": "integer", "description": "The uplink Hot Standby Router Protocol (HSRP) group value for the switch in the Compute Cloud@Customer infrastructure.\n" }, "uplinkVlan": { "type": "integer", "description": "The virtual local area network (VLAN) identifier used to connect to the uplink (only access mode is supported).\n" } }, "type": "object", "required": [ "uplinkHsrpGroup", "uplinkVlan" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationManagementNode:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemInfrastructureNetworkConfigurationManagementNode": { "properties": { "hostname": { "type": "string", "description": "Hostname for interface to the management node.\n" }, "ip": { "type": "string", "description": "Address of the management node.\n" } }, "type": "object", "required": [ "hostname", "ip" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemUpgradeInformation:getAtCustomerCccInfrastructuresCccInfrastructureCollectionItemUpgradeInformation": { "properties": { "currentVersion": { "type": "string", "description": "The current version of software installed on the Compute Cloud@Customer infrastructure.\n" }, "isActive": { "type": "boolean", "description": "Indication that the Compute Cloud@Customer infrastructure is in the process of an upgrade or an upgrade activity (such as preloading upgrade images).\n" }, "scheduledUpgradeDuration": { "type": "string", "description": "Expected duration of Compute Cloud@Customer infrastructure scheduled upgrade. The actual upgrade time might be longer or shorter than this duration depending on rack activity, this is only an estimate.\n" }, "timeOfScheduledUpgrade": { "type": "string", "description": "Compute Cloud@Customer infrastructure next upgrade time. The rack might have performance impacts during this time.\n" } }, "type": "object", "required": [ "currentVersion", "isActive", "scheduledUpgradeDuration", "timeOfScheduledUpgrade" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccInfrastructuresFilter:getAtCustomerCccInfrastructuresFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ComputeCloud/getAtCustomerCccUpgradeScheduleEvent:getAtCustomerCccUpgradeScheduleEvent": { "properties": { "description": { "type": "string", "description": "A description of the Compute Cloud@Customer upgrade schedule time block.\n" }, "name": { "type": "string", "description": "Generated name associated with the event.\n" }, "scheduleEventDuration": { "type": "string", "description": "The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations.\n" }, "scheduleEventRecurrences": { "type": "string", "description": "Frequency of recurrence of schedule block. When this field is not included, the event is assumed to be a one time occurrence. The frequency field is strictly parsed and must conform to RFC-5545 formatting for recurrences.\n" }, "timeStart": { "type": "string", "description": "The date and time when the Compute Cloud@Customer upgrade schedule event starts, inclusive. An RFC3339 formatted UTC datetime string. For an event with recurrences, this is the date that a recurrence can start being applied.\n" } }, "type": "object", "required": [ "description", "name", "scheduleEventDuration", "scheduleEventRecurrences", "timeStart" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollection:getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItem:getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItem:getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItem": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "description": { "type": "string", "description": "A description of the Compute Cloud@Customer upgrade schedule time block.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "events": { "type": "array", "items": { "$ref": "#/types/oci:ComputeCloud/getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItemEvent:getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItemEvent" }, "description": "List of preferred times for Compute Cloud@Customer infrastructures associated with this schedule to be upgraded.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "id": { "type": "string", "description": "Upgrade schedule [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). This cannot be changed once created.\n" }, "infrastructureIds": { "type": "array", "items": { "type": "string" }, "description": "List of Compute Cloud@Customer infrastructure [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that are using this upgrade schedule.\n" }, "lifecycleDetails": { "type": "string", "description": "A message describing the current state in more detail. For example, the message can be used to provide actionable information for a resource in a Failed state.\n" }, "state": { "type": "string", "description": "A filter to return resources only when their lifecycleState matches the given lifecycleState.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time the upgrade schedule was created, using an RFC3339 formatted datetime string.\n" }, "timeUpdated": { "type": "string", "description": "The time the upgrade schedule was updated, using an RFC3339 formatted datetime string.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "description", "displayName", "events", "freeformTags", "id", "infrastructureIds", "lifecycleDetails", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItemEvent:getAtCustomerCccUpgradeSchedulesCccUpgradeScheduleCollectionItemEvent": { "properties": { "description": { "type": "string", "description": "A description of the Compute Cloud@Customer upgrade schedule time block.\n" }, "name": { "type": "string", "description": "Generated name associated with the event.\n" }, "scheduleEventDuration": { "type": "string", "description": "The duration of this block of time. The duration must be specified and be of the ISO-8601 format for durations.\n" }, "scheduleEventRecurrences": { "type": "string", "description": "Frequency of recurrence of schedule block. When this field is not included, the event is assumed to be a one time occurrence. The frequency field is strictly parsed and must conform to RFC-5545 formatting for recurrences.\n" }, "timeStart": { "type": "string", "description": "The date and time when the Compute Cloud@Customer upgrade schedule event starts, inclusive. An RFC3339 formatted UTC datetime string. For an event with recurrences, this is the date that a recurrence can start being applied.\n" } }, "type": "object", "required": [ "description", "name", "scheduleEventDuration", "scheduleEventRecurrences", "timeStart" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeCloud/getAtCustomerCccUpgradeSchedulesFilter:getAtCustomerCccUpgradeSchedulesFilter": { "properties": { "name": { "type": "string", "description": "Generated name associated with the event.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ComputeInstanceAgent/getInstanceAgentPluginsFilter:getInstanceAgentPluginsFilter": { "properties": { "name": { "type": "string", "description": "The plugin name\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ComputeInstanceAgent/getInstanceAgentPluginsInstanceAgentPlugin:getInstanceAgentPluginsInstanceAgentPlugin": { "properties": { "message": { "type": "string", "description": "The optional message from the agent plugin\n" }, "name": { "type": "string", "description": "The plugin name\n" }, "status": { "type": "string", "description": "The plugin status\n" }, "timeLastUpdatedUtc": { "type": "string", "description": "The last update time of the plugin in UTC\n" } }, "type": "object", "required": [ "message", "name", "status", "timeLastUpdatedUtc" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeInstanceAgent/getInstanceAvailablePluginAvailablePlugin:getInstanceAvailablePluginAvailablePlugin": { "properties": { "isEnabledByDefault": { "type": "boolean", "description": "Is the plugin enabled or disabled by default\n" }, "isSupported": { "type": "boolean", "description": "Is the plugin supported or not\n" }, "name": { "type": "string", "description": "The plugin name\n" }, "summary": { "type": "string", "description": "A brief description of the plugin functionality\n" } }, "type": "object", "required": [ "isEnabledByDefault", "isSupported", "name", "summary" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ComputeInstanceAgent/getInstanceAvailablePluginFilter:getInstanceAvailablePluginFilter": { "properties": { "name": { "type": "string", "description": "The plugin name\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/AddonAddonError:AddonAddonError": { "properties": { "code": { "type": "string", "description": "A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).\n" }, "message": { "type": "string", "description": "A human-readable error string of the upstream error.\n" }, "status": { "type": "string", "description": "The status of the HTTP response encountered in the upstream error.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "code", "message", "status" ] } } }, "oci:ContainerEngine/AddonConfiguration:AddonConfiguration": { "properties": { "key": { "type": "string", "description": "(Updatable) configuration key name\n" }, "value": { "type": "string", "description": "(Updatable) configuration value name\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:ContainerEngine/ClusterClusterPodNetworkOption:ClusterClusterPodNetworkOption": { "properties": { "cniType": { "type": "string", "description": "The CNI used by the node pools of this cluster\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "cniType" ] }, "oci:ContainerEngine/ClusterEndpoint:ClusterEndpoint": { "properties": { "ipv6endpoint": { "type": "string", "description": "The IPv6 networking Kubernetes API server endpoint.\n" }, "kubernetes": { "type": "string", "description": "The non-native networking Kubernetes API server endpoint.\n" }, "privateEndpoint": { "type": "string", "description": "The private native networking Kubernetes API server endpoint.\n" }, "publicEndpoint": { "type": "string", "description": "The public native networking Kubernetes API server endpoint, if one was requested.\n" }, "vcnHostnameEndpoint": { "type": "string", "description": "The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6endpoint", "kubernetes", "privateEndpoint", "publicEndpoint", "vcnHostnameEndpoint" ] } } }, "oci:ContainerEngine/ClusterEndpointConfig:ClusterEndpointConfig": { "properties": { "isPublicIpEnabled": { "type": "boolean", "description": "Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" }, "subnetId": { "type": "string", "description": "The OCID of the regional subnet in which to place the Cluster endpoint.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "isPublicIpEnabled", "securityAttributes", "subnetId" ] } } }, "oci:ContainerEngine/ClusterImagePolicyConfig:ClusterImagePolicyConfig": { "properties": { "isPolicyEnabled": { "type": "boolean", "description": "(Updatable) Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.\n" }, "keyDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ClusterImagePolicyConfigKeyDetail:ClusterImagePolicyConfigKeyDetail" }, "description": "(Updatable) A list of KMS key details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isPolicyEnabled", "keyDetails" ] } } }, "oci:ContainerEngine/ClusterImagePolicyConfigKeyDetail:ClusterImagePolicyConfigKeyDetail": { "properties": { "kmsKeyId": { "type": "string", "description": "(Updatable) The OCIDs of the KMS key that will be used to verify whether the images are signed by an approved source.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "kmsKeyId" ] } } }, "oci:ContainerEngine/ClusterMetadata:ClusterMetadata": { "properties": { "createdByUserId": { "type": "string", "description": "The user who created the cluster.\n" }, "createdByWorkRequestId": { "type": "string", "description": "The OCID of the work request which created the cluster.\n" }, "deletedByUserId": { "type": "string", "description": "The user who deleted the cluster.\n" }, "deletedByWorkRequestId": { "type": "string", "description": "The OCID of the work request which deleted the cluster.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created.\n" }, "timeCredentialExpiration": { "type": "string", "description": "The time until which the cluster credential is valid.\n" }, "timeDeleted": { "type": "string", "description": "The time the cluster was deleted.\n" }, "timeUpdated": { "type": "string", "description": "The time the cluster was updated.\n" }, "updatedByUserId": { "type": "string", "description": "The user who updated the cluster.\n" }, "updatedByWorkRequestId": { "type": "string", "description": "The OCID of the work request which updated the cluster.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createdByUserId", "createdByWorkRequestId", "deletedByUserId", "deletedByWorkRequestId", "timeCreated", "timeCredentialExpiration", "timeDeleted", "timeUpdated", "updatedByUserId", "updatedByWorkRequestId" ] } } }, "oci:ContainerEngine/ClusterOptions:ClusterOptions": { "properties": { "addOns": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsAddOns:ClusterOptionsAddOns", "description": "Configurable cluster add-ons\n" }, "admissionControllerOptions": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsAdmissionControllerOptions:ClusterOptionsAdmissionControllerOptions", "description": "(Updatable) Configurable cluster admission controllers\n" }, "ipFamilies": { "type": "array", "items": { "type": "string" }, "description": "IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).\n", "willReplaceOnChanges": true }, "kubernetesNetworkConfig": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsKubernetesNetworkConfig:ClusterOptionsKubernetesNetworkConfig", "description": "Network configuration for Kubernetes.\n", "willReplaceOnChanges": true }, "openIdConnectDiscovery": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsOpenIdConnectDiscovery:ClusterOptionsOpenIdConnectDiscovery", "description": "(Updatable) The property that define the status of the OIDC Discovery feature for a cluster.\n" }, "openIdConnectTokenAuthenticationConfig": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsOpenIdConnectTokenAuthenticationConfig:ClusterOptionsOpenIdConnectTokenAuthenticationConfig", "description": "(Updatable) The properties that configure OIDC token authentication in kube-apiserver. For more information, see [Configuring the API Server](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-flags).\n" }, "persistentVolumeConfig": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsPersistentVolumeConfig:ClusterOptionsPersistentVolumeConfig", "description": "(Updatable) Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)\n" }, "serviceLbConfig": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsServiceLbConfig:ClusterOptionsServiceLbConfig", "description": "(Updatable) Configuration to be applied to load balancers created by Kubernetes services\n" }, "serviceLbSubnetIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the subnets used for Kubernetes services load balancers.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addOns", "admissionControllerOptions", "ipFamilies", "kubernetesNetworkConfig", "openIdConnectDiscovery", "openIdConnectTokenAuthenticationConfig", "persistentVolumeConfig", "serviceLbConfig", "serviceLbSubnetIds" ] } } }, "oci:ContainerEngine/ClusterOptionsAddOns:ClusterOptionsAddOns": { "properties": { "isKubernetesDashboardEnabled": { "type": "boolean", "description": "Whether or not to enable the Kubernetes Dashboard add-on.\n" }, "isTillerEnabled": { "type": "boolean", "description": "Whether or not to enable the Tiller add-on.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isKubernetesDashboardEnabled", "isTillerEnabled" ] } } }, "oci:ContainerEngine/ClusterOptionsAdmissionControllerOptions:ClusterOptionsAdmissionControllerOptions": { "properties": { "isPodSecurityPolicyEnabled": { "type": "boolean", "description": "(Updatable) Whether or not to enable the Pod Security Policy admission controller.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isPodSecurityPolicyEnabled" ] } } }, "oci:ContainerEngine/ClusterOptionsKubernetesNetworkConfig:ClusterOptionsKubernetesNetworkConfig": { "properties": { "podsCidr": { "type": "string", "description": "The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.\n", "willReplaceOnChanges": true }, "servicesCidr": { "type": "string", "description": "The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "podsCidr", "servicesCidr" ] } } }, "oci:ContainerEngine/ClusterOptionsOpenIdConnectDiscovery:ClusterOptionsOpenIdConnectDiscovery": { "properties": { "isOpenIdConnectDiscoveryEnabled": { "type": "boolean", "description": "(Updatable) Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isOpenIdConnectDiscoveryEnabled" ] } } }, "oci:ContainerEngine/ClusterOptionsOpenIdConnectTokenAuthenticationConfig:ClusterOptionsOpenIdConnectTokenAuthenticationConfig": { "properties": { "caCertificate": { "type": "string", "description": "(Updatable) A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.\n" }, "clientId": { "type": "string", "description": "(Updatable) A client id that all tokens must be issued for.\n" }, "configurationFile": { "type": "string", "description": "(Updatable) A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info [here](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration)\n" }, "groupsClaim": { "type": "string", "description": "(Updatable) JWT claim to use as the user's group. If the claim is present it must be an array of strings.\n" }, "groupsPrefix": { "type": "string", "description": "(Updatable) Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).\n" }, "isOpenIdConnectAuthEnabled": { "type": "boolean", "description": "(Updatable) Whether the cluster has OIDC Auth Config enabled. Defaults to false.\n" }, "issuerUrl": { "type": "string", "description": "(Updatable) URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.\n" }, "requiredClaims": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim:ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim" }, "description": "(Updatable) A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.\n" }, "signingAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The signing algorithms accepted. Default is [\"RS256\"].\n" }, "usernameClaim": { "type": "string", "description": "(Updatable) JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n" }, "usernamePrefix": { "type": "string", "description": "(Updatable) Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.\n" } }, "type": "object", "required": [ "isOpenIdConnectAuthEnabled" ] }, "oci:ContainerEngine/ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim:ClusterOptionsOpenIdConnectTokenAuthenticationConfigRequiredClaim": { "properties": { "key": { "type": "string", "description": "(Updatable) The key of the pair.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the pair.\n" } }, "type": "object" }, "oci:ContainerEngine/ClusterOptionsPersistentVolumeConfig:ClusterOptionsPersistentVolumeConfig": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "definedTags", "freeformTags" ] } } }, "oci:ContainerEngine/ClusterOptionsServiceLbConfig:ClusterOptionsServiceLbConfig": { "properties": { "backendNsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of the OCIDs of the network security groups (NSGs) associated to backends to LBs (pods/nodes/virtual pods, etc.). Rules necessary for LB to backend communication would be added when rule management mode is set to NSG via annotations. see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "backendNsgIds", "definedTags", "freeformTags" ] } } }, "oci:ContainerEngine/ContainerInstanceContainer:ContainerInstanceContainer": { "properties": { "arguments": { "type": "array", "items": { "type": "string" }, "description": "A list of string arguments for a container's ENTRYPOINT process.\n\nMany containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.\n\nThe total size of all arguments combined must be 64 KB or smaller.\n", "willReplaceOnChanges": true }, "availabilityDomain": { "type": "string", "description": "The availability domain where the container instance runs.\n" }, "commands": { "type": "array", "items": { "type": "string" }, "description": "An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.\n", "willReplaceOnChanges": true }, "compartmentId": { "type": "string", "description": "(Updatable) The compartment OCID.\n" }, "containerId": { "type": "string", "description": "The OCID of the container.\n" }, "containerInstanceId": { "type": "string" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.\n" }, "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.\n\nThe total size of all environment variables combined, name and values, must be 64 KB or smaller.\n", "willReplaceOnChanges": true }, "exitCode": { "type": "integer" }, "faultDomain": { "type": "string", "description": "The fault domain where the container instance runs.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "healthChecks": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceContainerHealthCheck:ContainerInstanceContainerHealthCheck" }, "description": "list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.\n", "willReplaceOnChanges": true }, "imageUrl": { "type": "string", "description": "A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.\n\nIf no registry is provided, will default the registry to public docker hub `docker.io/library`.\n\nThe registry used for container image must be reachable over the Container Instance's VNIC.\n", "willReplaceOnChanges": true }, "isResourcePrincipalDisabled": { "type": "boolean", "description": "Determines if the container will have access to the container instance resource principal.\n\nThis method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.\n", "willReplaceOnChanges": true }, "lifecycleDetails": { "type": "string", "description": "A message that describes the current state of the container in more detail. Can be used to provide actionable information.\n" }, "resourceConfig": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceContainerResourceConfig:ContainerInstanceContainerResourceConfig", "description": "The size and amount of resources available to the container.\n", "willReplaceOnChanges": true }, "securityContext": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceContainerSecurityContext:ContainerInstanceContainerSecurityContext", "description": "Security context for container.\n", "willReplaceOnChanges": true }, "state": { "type": "string", "description": "(Updatable) The target state for the Container Instance. Could be set to `ACTIVE` or `INACTIVE`. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`.\n" }, "timeCreated": { "type": "string", "description": "The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "timeTerminated": { "type": "string" }, "timeUpdated": { "type": "string", "description": "The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceContainerVolumeMount:ContainerInstanceContainerVolumeMount" }, "description": "List of the volume mounts.\n", "willReplaceOnChanges": true }, "workingDirectory": { "type": "string", "description": "The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "imageUrl" ], "language": { "nodejs": { "requiredOutputs": [ "arguments", "availabilityDomain", "commands", "compartmentId", "containerId", "containerInstanceId", "definedTags", "displayName", "environmentVariables", "exitCode", "faultDomain", "freeformTags", "healthChecks", "imageUrl", "isResourcePrincipalDisabled", "lifecycleDetails", "resourceConfig", "securityContext", "state", "systemTags", "timeCreated", "timeTerminated", "timeUpdated", "volumeMounts", "workingDirectory" ] } } }, "oci:ContainerEngine/ContainerInstanceContainerHealthCheck:ContainerInstanceContainerHealthCheck": { "properties": { "failureAction": { "type": "string", "description": "The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.\n", "willReplaceOnChanges": true }, "failureThreshold": { "type": "integer", "description": "Number of consecutive failures at which we consider the check failed.\n", "willReplaceOnChanges": true }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceContainerHealthCheckHeader:ContainerInstanceContainerHealthCheckHeader" }, "description": "Container health check HTTP headers.\n", "willReplaceOnChanges": true }, "healthCheckType": { "type": "string", "description": "Container health check type.\n", "willReplaceOnChanges": true }, "initialDelayInSeconds": { "type": "integer", "description": "The initial delay in seconds before start checking container health status.\n", "willReplaceOnChanges": true }, "intervalInSeconds": { "type": "integer", "description": "Number of seconds between two consecutive runs for checking container health.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "Health check name.\n", "willReplaceOnChanges": true }, "path": { "type": "string", "description": "Container health check HTTP path.\n", "willReplaceOnChanges": true }, "port": { "type": "integer", "description": "Container health check HTTP port.\n", "willReplaceOnChanges": true }, "status": { "type": "string" }, "statusDetails": { "type": "string" }, "successThreshold": { "type": "integer", "description": "Number of consecutive successes at which we consider the check succeeded again after it was in failure state.\n", "willReplaceOnChanges": true }, "timeoutInSeconds": { "type": "integer", "description": "Length of waiting time in seconds before marking health check failed.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "healthCheckType" ], "language": { "nodejs": { "requiredOutputs": [ "failureAction", "failureThreshold", "headers", "healthCheckType", "initialDelayInSeconds", "intervalInSeconds", "name", "path", "port", "status", "statusDetails", "successThreshold", "timeoutInSeconds" ] } } }, "oci:ContainerEngine/ContainerInstanceContainerHealthCheckHeader:ContainerInstanceContainerHealthCheckHeader": { "properties": { "name": { "type": "string", "description": "Container HTTP header Key.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "Container HTTP header value.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "name", "value" ] } } }, "oci:ContainerEngine/ContainerInstanceContainerResourceConfig:ContainerInstanceContainerResourceConfig": { "properties": { "memoryLimitInGbs": { "type": "number", "description": "The maximum amount of memory that can be consumed by the container's process.\n\nIf you do not set a value, then the process may use all available memory on the instance.\n", "willReplaceOnChanges": true }, "vcpusLimit": { "type": "number", "description": "The maximum amount of CPUs that can be consumed by the container's process.\n\nIf you do not set a value, then the process can use all available CPU resources on the instance.\n\nCPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.\n\nA container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of \"1.5\" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "memoryLimitInGbs", "vcpusLimit" ] } } }, "oci:ContainerEngine/ContainerInstanceContainerSecurityContext:ContainerInstanceContainerSecurityContext": { "properties": { "capabilities": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceContainerSecurityContextCapabilities:ContainerInstanceContainerSecurityContextCapabilities", "description": "Linux Container capabilities to configure capabilities of container.\n", "willReplaceOnChanges": true }, "isNonRootUserCheckEnabled": { "type": "boolean", "description": "Indicates if the container must run as a non-root user. If true, the service validates the container image at runtime to ensure that it is not going to run with UID 0 (root) and fails the container instance creation if the validation fails.\n", "willReplaceOnChanges": true }, "isRootFileSystemReadonly": { "type": "boolean", "description": "Determines if the container will have a read-only root file system. Default value is false.\n", "willReplaceOnChanges": true }, "runAsGroup": { "type": "integer", "description": "The group ID (GID) to run the entrypoint process of the container. Uses runtime default if not provided.\n", "willReplaceOnChanges": true }, "runAsUser": { "type": "integer", "description": "The user ID (UID) to run the entrypoint process of the container. Defaults to user specified UID in container image metadata if not provided. This must be provided if runAsGroup is provided.\n", "willReplaceOnChanges": true }, "securityContextType": { "type": "string", "description": "The type of security context\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capabilities", "isNonRootUserCheckEnabled", "isRootFileSystemReadonly", "runAsGroup", "runAsUser", "securityContextType" ] } } }, "oci:ContainerEngine/ContainerInstanceContainerSecurityContextCapabilities:ContainerInstanceContainerSecurityContextCapabilities": { "properties": { "addCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of additional configurable container capabilities.\n", "willReplaceOnChanges": true }, "dropCapabilities": { "type": "array", "items": { "type": "string" }, "description": "A list of container capabilities that can be dropped.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "addCapabilities", "dropCapabilities" ] } } }, "oci:ContainerEngine/ContainerInstanceContainerVolumeMount:ContainerInstanceContainerVolumeMount": { "properties": { "isReadOnly": { "type": "boolean", "description": "Whether the volume was mounted in read-only mode. By default, the volume is not read-only.\n", "willReplaceOnChanges": true }, "mountPath": { "type": "string", "description": "The volume access path.\n", "willReplaceOnChanges": true }, "partition": { "type": "integer", "description": "If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm\n", "willReplaceOnChanges": true }, "subPath": { "type": "string", "description": "A subpath inside the referenced volume.\n", "willReplaceOnChanges": true }, "volumeName": { "type": "string", "description": "The name of the volume. Avoid entering confidential information.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "mountPath", "volumeName" ], "language": { "nodejs": { "requiredOutputs": [ "isReadOnly", "mountPath", "partition", "subPath", "volumeName" ] } } }, "oci:ContainerEngine/ContainerInstanceDnsConfig:ContainerInstanceDnsConfig": { "properties": { "nameservers": { "type": "array", "items": { "type": "string" }, "description": "IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.\n", "willReplaceOnChanges": true }, "options": { "type": "array", "items": { "type": "string" }, "description": "Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: [\"ndots:n\", \"edns0\"].\n", "willReplaceOnChanges": true }, "searches": { "type": "array", "items": { "type": "string" }, "description": "Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "nameservers", "options", "searches" ] } } }, "oci:ContainerEngine/ContainerInstanceImagePullSecret:ContainerInstanceImagePullSecret": { "properties": { "password": { "type": "string", "description": "The password which should be used with the registry for authentication. The value is expected in base64 format.\n", "secret": true, "willReplaceOnChanges": true }, "registryEndpoint": { "type": "string", "description": "The registry endpoint of the container image.\n", "willReplaceOnChanges": true }, "secretId": { "type": "string", "description": "The OCID of the secret for registry credentials.\n", "willReplaceOnChanges": true }, "secretType": { "type": "string", "description": "The type of ImagePullSecret.\n", "willReplaceOnChanges": true }, "username": { "type": "string", "description": "The username which should be used with the registry for authentication. The value is expected in base64 format.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "registryEndpoint", "secretType" ], "language": { "nodejs": { "requiredOutputs": [ "password", "registryEndpoint", "secretId", "secretType", "username" ] } } }, "oci:ContainerEngine/ContainerInstanceSecurityContext:ContainerInstanceSecurityContext": { "properties": { "fsGroup": { "type": "integer", "description": "A special supplemental group that applies to all containers in the container instance. Some volume types allow the container instance to change ownership of the volume. The owning GID will be the fsGroup, the setgid bit will be set (new files will be owned by the fsGroup), and the permission bits are OR'd with rw-rw----. If unset, the container instance will not modify the ownership and permissions of volumes.\n", "willReplaceOnChanges": true }, "fsGroupChangePolicy": { "type": "string", "description": "Defines behavior of changing ownership and permission of the volume before being exposed inside the containers. This only applies to volumes which support fsGroup ownership and permissions, and will have no effect on ephemeral volumes. ON_ROOT_MISMATCH only changes permissions and ownership if the permission and ownership of the root directory does not match the expected permissions and ownership of the volume. This can improve container instance start times. ALWAYS changes permission and ownership of the volume when it is mounted. If unset, ALWAYS is used.\n", "willReplaceOnChanges": true }, "securityContextType": { "type": "string", "description": "The type of security context\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "fsGroup", "fsGroupChangePolicy", "securityContextType" ] } } }, "oci:ContainerEngine/ContainerInstanceShapeConfig:ContainerInstanceShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the container instance (GB).\n", "willReplaceOnChanges": true }, "networkingBandwidthInGbps": { "type": "number", "description": "The networking bandwidth available to the container instance, in gigabits per second.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the container instance.\n", "willReplaceOnChanges": true }, "processorDescription": { "type": "string", "description": "A short description of the container instance's processor (CPU).\n" } }, "type": "object", "required": [ "ocpus" ], "language": { "nodejs": { "requiredOutputs": [ "memoryInGbs", "networkingBandwidthInGbps", "ocpus", "processorDescription" ] } } }, "oci:ContainerEngine/ContainerInstanceVnic:ContainerInstanceVnic": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. Used for DNS.\n" }, "isPublicIpAssigned": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.\n", "willReplaceOnChanges": true }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in.\n", "willReplaceOnChanges": true }, "vnicId": { "type": "string", "description": "The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "definedTags", "displayName", "freeformTags", "hostnameLabel", "isPublicIpAssigned", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vnicId" ] } } }, "oci:ContainerEngine/ContainerInstanceVolume:ContainerInstanceVolume": { "properties": { "backingStore": { "type": "string", "description": "The volume type of the empty directory, can be either File Storage or Memory.\n", "willReplaceOnChanges": true }, "configs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceVolumeConfig:ContainerInstanceVolumeConfig" }, "description": "Contains key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.\n", "willReplaceOnChanges": true }, "export": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceVolumeExport:ContainerInstanceVolumeExport", "description": "An Oracle Cloud Infrastructure File Storage Service (FSS) Export. Check https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/Export/ for more details.\n", "willReplaceOnChanges": true }, "mountCommand": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceVolumeMountCommand:ContainerInstanceVolumeMountCommand", "description": "Specifications for the mount command to mount the Oracle Cloud Infrastructure File Storage Service (FSS) File System to Containers.\n", "willReplaceOnChanges": true }, "mountTarget": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceVolumeMountTarget:ContainerInstanceVolumeMountTarget", "description": "An Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. Check https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/MountTarget for more details.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n", "willReplaceOnChanges": true }, "security": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceVolumeSecurity:ContainerInstanceVolumeSecurity", "description": "Security options for Oracle Cloud Infrastructure FSS File System.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "Specifies the network interface to be used for the Oracle Cloud Infrastructure File Storage Service (FSS) volume. This is a required parameter when a Container Instance is attached to more than one subnets.\n", "willReplaceOnChanges": true }, "volumeType": { "type": "string", "description": "The type of volume.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "name", "volumeType" ], "language": { "nodejs": { "requiredOutputs": [ "backingStore", "configs", "export", "mountCommand", "mountTarget", "name", "security", "subnetId", "volumeType" ] } } }, "oci:ContainerEngine/ContainerInstanceVolumeConfig:ContainerInstanceVolumeConfig": { "properties": { "data": { "type": "string", "description": "The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.\n", "willReplaceOnChanges": true }, "fileName": { "type": "string", "description": "The name of the file. The fileName should be unique across the volume.\n", "willReplaceOnChanges": true }, "path": { "type": "string", "description": "(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "data", "fileName", "path" ] } } }, "oci:ContainerEngine/ContainerInstanceVolumeExport:ContainerInstanceVolumeExport": { "properties": { "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Export.\n", "willReplaceOnChanges": true }, "ociFssExportType": { "type": "string", "description": "Determines the mode for supplying the Oracle Cloud Infrastructure File Storage Service (FSS) Export details. The value must be an OCID unless your tenancy is allowed to use PATH as a value.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "id" ], "language": { "nodejs": { "requiredOutputs": [ "id", "ociFssExportType" ] } } }, "oci:ContainerEngine/ContainerInstanceVolumeMountCommand:ContainerInstanceVolumeMountCommand": { "properties": { "mountOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/ContainerInstanceVolumeMountCommandMountOption:ContainerInstanceVolumeMountCommandMountOption" }, "description": "List of mount options to be used in the mount command. The order of this array will be maintained while preparing the mount command.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "mountOptions" ] } } }, "oci:ContainerEngine/ContainerInstanceVolumeMountCommandMountOption:ContainerInstanceVolumeMountCommandMountOption": { "properties": { "option": { "type": "string", "description": "A generic (https://man7.org/linux/man-pages/man8/mount.8.html) or nfs (https://man7.org/linux/man-pages/man5/nfs.5.html) mount option.\n", "willReplaceOnChanges": true }, "value": { "type": "string", "description": "The value of the mount option.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "option", "value" ] } } }, "oci:ContainerEngine/ContainerInstanceVolumeMountTarget:ContainerInstanceVolumeMountTarget": { "properties": { "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target.\n", "willReplaceOnChanges": true }, "ociFssMountTargetType": { "type": "string", "description": "Determines the mode for supplying the Oracle Cloud Infrastructure File Storage Service (FSS) Mount target details. The value must be an OCID unless your tenancy is allowed to use HOST as a value.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "id" ], "language": { "nodejs": { "requiredOutputs": [ "id", "ociFssMountTargetType" ] } } }, "oci:ContainerEngine/ContainerInstanceVolumeSecurity:ContainerInstanceVolumeSecurity": { "properties": { "auth": { "type": "string", "description": "NFS authentication type to be used. Currently, only auth type SYS is supported.\n", "willReplaceOnChanges": true }, "isEncryptedInTransit": { "type": "boolean", "description": "Determines whether in-transit encryption needs to be enables. Check https://docs.oracle.com/en-us/iaas/Content/File/Tasks/intransitencryption.htm#Using_Intransit_Encryption for more details.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "auth", "isEncryptedInTransit" ] } } }, "oci:ContainerEngine/NodePoolInitialNodeLabel:NodePoolInitialNodeLabel": { "properties": { "key": { "type": "string", "description": "(Updatable) The key of the pair.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the pair.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:ContainerEngine/NodePoolNode:NodePoolNode": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain in which this node is placed.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "errors": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/NodePoolNodeError:NodePoolNodeError" }, "description": "An error that may be associated with the node.\n" }, "faultDomain": { "type": "string", "description": "The fault domain of this node.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the compute instance backing this node.\n" }, "kubernetesVersion": { "type": "string", "description": "(Updatable) The version of Kubernetes to install on the nodes in the node pool.\n" }, "lifecycleDetails": { "type": "string", "description": "Details about the state of the node.\n" }, "name": { "type": "string", "description": "(Updatable) The name of the node pool. Avoid entering confidential information.\n" }, "nodePoolId": { "type": "string", "description": "The OCID of the node pool to which this node belongs.\n" }, "privateIp": { "type": "string", "description": "The private IP address of this node.\n" }, "publicIp": { "type": "string", "description": "The public IP address of this node.\n" }, "state": { "type": "string", "description": "The state of the nodepool. For more information, see [Monitoring Clusters](https://docs.cloud.oracle.com/iaas/Content/ContEng/Tasks/contengmonitoringclusters.htm)\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "definedTags", "errors", "faultDomain", "freeformTags", "id", "kubernetesVersion", "lifecycleDetails", "name", "nodePoolId", "privateIp", "publicIp", "state", "subnetId" ] } } }, "oci:ContainerEngine/NodePoolNodeConfigDetails:NodePoolNodeConfigDetails": { "properties": { "computeClusterId": { "type": "string", "description": "The OCID of the Compute Cluster to be associated with the worker node instance.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "(Updatable) Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.\n" }, "kmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Key Management Service key assigned to the boot volume.\n" }, "nodePoolPodNetworkOptionDetails": { "$ref": "#/types/oci:ContainerEngine/NodePoolNodeConfigDetailsNodePoolPodNetworkOptionDetails:NodePoolNodeConfigDetailsNodePoolPodNetworkOptionDetails", "description": "(Updatable) The CNI related configuration of pods in the node pool.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The OCIDs of the Network Security Group(s) to associate nodes for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "placementConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/NodePoolNodeConfigDetailsPlacementConfig:NodePoolNodeConfigDetailsPlacementConfig" }, "description": "(Updatable) The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node.\n\nTo use the node pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.\n" }, "size": { "type": "integer", "description": "(Updatable) The number of nodes that should be in the node pool.\n" } }, "type": "object", "required": [ "placementConfigs", "size" ], "language": { "nodejs": { "requiredOutputs": [ "definedTags", "freeformTags", "isPvEncryptionInTransitEnabled", "kmsKeyId", "nodePoolPodNetworkOptionDetails", "nsgIds", "placementConfigs", "size" ] } } }, "oci:ContainerEngine/NodePoolNodeConfigDetailsNodePoolPodNetworkOptionDetails:NodePoolNodeConfigDetailsNodePoolPodNetworkOptionDetails": { "properties": { "cniType": { "type": "string", "description": "(Updatable) The CNI plugin used by this node pool\n", "willReplaceOnChanges": true }, "maxPodsPerNode": { "type": "integer", "description": "(Updatable) The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape\n" }, "podNsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "podSubnetIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs\n" } }, "type": "object", "required": [ "cniType" ], "language": { "nodejs": { "requiredOutputs": [ "cniType", "maxPodsPerNode", "podNsgIds", "podSubnetIds" ] } } }, "oci:ContainerEngine/NodePoolNodeConfigDetailsPlacementConfig:NodePoolNodeConfigDetailsPlacementConfig": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "(Updatable) The OCID of the compute capacity reservation in which to place the compute instance.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of fault domains in which to place nodes.\n" }, "hostGroupId": { "type": "string", "description": "(Updatable) The OCID of the Host Group to be associated with the worker node instance.\n" }, "preemptibleNodeConfig": { "$ref": "#/types/oci:ContainerEngine/NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig:NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig", "description": "(Updatable) Configuration options for preemptible nodes.\n" }, "subnetId": { "type": "string", "description": "(Updatable) The OCID of the subnet in which to place nodes.\n" } }, "type": "object", "required": [ "availabilityDomain", "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "capacityReservationId", "faultDomains", "preemptibleNodeConfig", "subnetId" ] } } }, "oci:ContainerEngine/NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig:NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfig": { "properties": { "preemptionAction": { "$ref": "#/types/oci:ContainerEngine/NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction:NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction", "description": "(Updatable) The action to run when the preemptible node is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionAction" ] }, "oci:ContainerEngine/NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction:NodePoolNodeConfigDetailsPlacementConfigPreemptibleNodeConfigPreemptionAction": { "properties": { "isPreserveBootVolume": { "type": "boolean", "description": "(Updatable) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "(Updatable) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "isPreserveBootVolume", "type" ] } } }, "oci:ContainerEngine/NodePoolNodeError:NodePoolNodeError": { "properties": { "code": { "type": "string", "description": "A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).\n" }, "message": { "type": "string", "description": "A human-readable error string of the upstream error.\n" }, "status": { "type": "string", "description": "The status of the HTTP response encountered in the upstream error.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "code", "message", "status" ] } } }, "oci:ContainerEngine/NodePoolNodeEvictionNodePoolSettings:NodePoolNodeEvictionNodePoolSettings": { "properties": { "evictionGraceDuration": { "type": "string", "description": "(Updatable) Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M\n" }, "isForceActionAfterGraceDuration": { "type": "boolean", "description": "(Updatable) If the node action should be performed if not all the pods can be evicted in the grace period\n" }, "isForceDeleteAfterGraceDuration": { "type": "boolean", "description": "(Updatable) If the underlying compute instance should be deleted if you cannot evict all the pods in grace period\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "evictionGraceDuration", "isForceActionAfterGraceDuration", "isForceDeleteAfterGraceDuration" ] } } }, "oci:ContainerEngine/NodePoolNodePoolCyclingDetails:NodePoolNodePoolCyclingDetails": { "properties": { "cycleModes": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) An ordered list of cycle modes that should be performed on the OKE nodes.\n" }, "isNodeCyclingEnabled": { "type": "boolean", "description": "(Updatable) If cycling operation should be performed on the nodes in the node pool.\n" }, "maximumSurge": { "type": "string", "description": "(Updatable) Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%\n" }, "maximumUnavailable": { "type": "string", "description": "(Updatable) Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cycleModes", "isNodeCyclingEnabled", "maximumSurge", "maximumUnavailable" ] } } }, "oci:ContainerEngine/NodePoolNodeShapeConfig:NodePoolNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "(Updatable) The total amount of memory available to each node, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "(Updatable) The total number of OCPUs available to each node in the node pool. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "memoryInGbs", "ocpus" ] } } }, "oci:ContainerEngine/NodePoolNodeSource:NodePoolNodeSource": { "properties": { "imageId": { "type": "string", "description": "The OCID of the image used to boot the node.\n" }, "sourceName": { "type": "string", "description": "The user-friendly name of the entity corresponding to the OCID.\n" }, "sourceType": { "type": "string", "description": "The source type for the node. Use `IMAGE` when specifying an OCID of an image.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "imageId", "sourceName", "sourceType" ] } } }, "oci:ContainerEngine/NodePoolNodeSourceDetails:NodePoolNodeSourceDetails": { "properties": { "bootVolumeSizeInGbs": { "type": "string", "description": "(Updatable) The size of the boot volume in GBs. Minimum value is 50 GB. See [here](https://docs.cloud.oracle.com/en-us/iaas/Content/Block/Concepts/bootvolumes.htm) for max custom boot volume sizing and OS-specific requirements.\n" }, "imageId": { "type": "string", "description": "(Updatable) The OCID of the image used to boot the node.\n" }, "sourceType": { "type": "string", "description": "(Updatable) The source type for the node. Use `IMAGE` when specifying an OCID of an image.\n" } }, "type": "object", "required": [ "imageId", "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "bootVolumeSizeInGbs", "imageId", "sourceType" ] } } }, "oci:ContainerEngine/NodePoolPrimaryVnic:NodePoolPrimaryVnic": { "properties": { "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "securityAttributes" ] } } }, "oci:ContainerEngine/NodePoolSecondaryVnic:NodePoolSecondaryVnic": { "properties": { "createVnicDetails": { "$ref": "#/types/oci:ContainerEngine/NodePoolSecondaryVnicCreateVnicDetails:NodePoolSecondaryVnicCreateVnicDetails", "description": "(Updatable) The properties of the secondary vnics\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for vnic attachment\n" }, "nicIndex": { "type": "integer", "description": "(Updatable) Which physical network interface card (NIC) the VNIC will use\n" } }, "type": "object", "required": [ "createVnicDetails" ], "language": { "nodejs": { "requiredOutputs": [ "createVnicDetails", "displayName", "nicIndex" ] } } }, "oci:ContainerEngine/NodePoolSecondaryVnicCreateVnicDetails:NodePoolSecondaryVnicCreateVnicDetails": { "properties": { "applicationResources": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling\n" }, "assignIpv6ip": { "type": "boolean", "description": "(Updatable) Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet\n" }, "assignPublicIp": { "type": "boolean", "description": "(Updatable) Whether the VNIC should be assigned a public IP address\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "(Updatable) Display name for secondary vnic\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "ipCount": { "type": "integer", "description": "(Updatable) The number of ip addresses to attach to secondary vnic\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/NodePoolSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:NodePoolSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "(Updatable) A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) [Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "(Updatable) Whether the source/destination check is disabled on the VNIC\n" }, "subnetId": { "type": "string", "description": "(Updatable) the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "applicationResources", "assignIpv6ip", "assignPublicIp", "definedTags", "displayName", "freeformTags", "ipCount", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "securityAttributes", "skipSourceDestCheck", "subnetId" ] } } }, "oci:ContainerEngine/NodePoolSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:NodePoolSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "(Updatable) An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix\n" }, "ipv6subnetCidr": { "type": "string", "description": "(Updatable) The IPv6 prefix allocated to the subnet\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6address", "ipv6subnetCidr" ] } } }, "oci:ContainerEngine/VirtualNodePoolInitialVirtualNodeLabel:VirtualNodePoolInitialVirtualNodeLabel": { "properties": { "key": { "type": "string", "description": "(Updatable) The key of the pair.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the pair.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "key", "value" ] } } }, "oci:ContainerEngine/VirtualNodePoolPlacementConfiguration:VirtualNodePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1`\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The fault domain of this virtual node.\n" }, "subnetId": { "type": "string", "description": "(Updatable) The OCID of the subnet in which to place virtual nodes.\n" } }, "type": "object", "required": [ "availabilityDomain", "faultDomains", "subnetId" ] }, "oci:ContainerEngine/VirtualNodePoolPodConfiguration:VirtualNodePoolPodConfiguration": { "properties": { "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) List of network security group IDs applied to the Pod VNIC.\n" }, "shape": { "type": "string", "description": "(Updatable) Shape of the pods.\n" }, "subnetId": { "type": "string", "description": "(Updatable) The private regional subnet where pods' VNIC will be placed.\n" } }, "type": "object", "required": [ "shape", "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "nsgIds", "shape", "subnetId" ] } } }, "oci:ContainerEngine/VirtualNodePoolTaint:VirtualNodePoolTaint": { "properties": { "effect": { "type": "string", "description": "(Updatable) The effect of the pair.\n" }, "key": { "type": "string", "description": "(Updatable) The key of the pair.\n" }, "value": { "type": "string", "description": "(Updatable) The value of the pair.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "effect", "key", "value" ] } } }, "oci:ContainerEngine/VirtualNodePoolVirtualNodePoolCyclingDetails:VirtualNodePoolVirtualNodePoolCyclingDetails": { "properties": { "isVirtualNodeCyclingEnabled": { "type": "boolean", "description": "(Updatable) If virtual nodes in the virtual nodepool will be cycled to have new changes.\n" }, "maximumSurge": { "type": "string", "description": "(Updatable) Maximum additional new virtual nodes that would be temporarily created and added to virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Virtual Nodepool size or 0% to 100%\n" }, "maximumUnavailable": { "type": "string", "description": "(Updatable) Maximum active virtual nodes that would be terminated from virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Virtual Nodepool size or 0% to 100%\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isVirtualNodeCyclingEnabled", "maximumSurge", "maximumUnavailable" ] } } }, "oci:ContainerEngine/VirtualNodePoolVirtualNodeTags:VirtualNodePoolVirtualNodeTags": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "definedTags", "freeformTags" ] } } }, "oci:ContainerEngine/getAddonAddonError:getAddonAddonError": { "properties": { "code": { "type": "string", "description": "A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).\n" }, "message": { "type": "string", "description": "A human-readable error string of the upstream error.\n" }, "status": { "type": "string", "description": "The status of the HTTP response encountered in the upstream error.\n" } }, "type": "object", "required": [ "code", "message", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonConfiguration:getAddonConfiguration": { "properties": { "key": { "type": "string", "description": "configuration key name\n" }, "value": { "type": "string", "description": "configuration value name\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonOptionsAddonOption:getAddonOptionsAddonOption": { "properties": { "addonGroup": { "type": "string", "description": "Addon group info, a namespace concept that groups addons with similar functionalities.\n" }, "addonSchemaVersion": { "type": "string", "description": "Addon definition schema version to validate addon.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "Information about the addon version.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isEssential": { "type": "boolean", "description": "Is it an essential addon for cluster operation or not.\n" }, "name": { "type": "string", "description": "Name of the addon and it would be unique.\n" }, "state": { "type": "string", "description": "The life cycle state of the addon.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The time the work request was created.\n" }, "versions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getAddonOptionsAddonOptionVersion:getAddonOptionsAddonOptionVersion" }, "description": "The resources this work request affects.\n" } }, "type": "object", "required": [ "addonGroup", "addonSchemaVersion", "definedTags", "description", "freeformTags", "isEssential", "name", "state", "systemTags", "timeCreated", "versions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonOptionsAddonOptionVersion:getAddonOptionsAddonOptionVersion": { "properties": { "configurations": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getAddonOptionsAddonOptionVersionConfiguration:getAddonOptionsAddonOptionVersionConfiguration" }, "description": "Addon version configuration details.\n" }, "description": { "type": "string", "description": "Information about the addon version.\n" }, "kubernetesVersionFilters": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getAddonOptionsAddonOptionVersionKubernetesVersionFilter:getAddonOptionsAddonOptionVersionKubernetesVersionFilter" }, "description": "The range of kubernetes versions an addon can be configured.\n" }, "status": { "type": "string", "description": "Current state of the addon, only active will be visible to customer, visibility of versions in other status will be filtered based on limits property.\n" }, "versionNumber": { "type": "string", "description": "Version number, need be comparable within an addon.\n" } }, "type": "object", "required": [ "configurations", "description", "kubernetesVersionFilters", "status", "versionNumber" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonOptionsAddonOptionVersionConfiguration:getAddonOptionsAddonOptionVersionConfiguration": { "properties": { "description": { "type": "string", "description": "Information about the addon version.\n" }, "displayName": { "type": "string", "description": "Display name of addon version.\n" }, "isRequired": { "type": "boolean", "description": "If the the configuration is required or not.\n" }, "key": { "type": "string", "description": "Addon configuration key\n" }, "value": { "type": "string", "description": "Addon configuration value\n" } }, "type": "object", "required": [ "description", "displayName", "isRequired", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonOptionsAddonOptionVersionKubernetesVersionFilter:getAddonOptionsAddonOptionVersionKubernetesVersionFilter": { "properties": { "exactKubernetesVersions": { "type": "array", "items": { "type": "string" }, "description": "The exact version of kubernetes that are compatible.\n" }, "maximumVersion": { "type": "string", "description": "The latest kubernetes version.\n" }, "minimalVersion": { "type": "string", "description": "The earliest kubernetes version.\n" } }, "type": "object", "required": [ "exactKubernetesVersions", "maximumVersion", "minimalVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonOptionsFilter:getAddonOptionsFilter": { "properties": { "name": { "type": "string", "description": "Name of the addon and it would be unique.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getAddonsAddon:getAddonsAddon": { "properties": { "addonErrors": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getAddonsAddonAddonError:getAddonsAddonAddonError" }, "description": "The error info of the addon.\n" }, "addonName": { "type": "string", "description": "The name of the addon.\n" }, "clusterId": { "type": "string", "description": "The OCID of the cluster.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getAddonsAddonConfiguration:getAddonsAddonConfiguration" }, "description": "Addon configuration details.\n" }, "currentInstalledVersion": { "type": "string", "description": "current installed version of the addon\n" }, "overrideExisting": { "type": "boolean" }, "removeAddonResourcesOnDelete": { "type": "boolean" }, "state": { "type": "string", "description": "The state of the addon.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created.\n" }, "version": { "type": "string", "description": "selected addon version, or null indicates autoUpdate\n" } }, "type": "object", "required": [ "addonErrors", "addonName", "clusterId", "configurations", "currentInstalledVersion", "removeAddonResourcesOnDelete", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonsAddonAddonError:getAddonsAddonAddonError": { "properties": { "code": { "type": "string", "description": "A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).\n" }, "message": { "type": "string", "description": "A human-readable error string of the upstream error.\n" }, "status": { "type": "string", "description": "The status of the HTTP response encountered in the upstream error.\n" } }, "type": "object", "required": [ "code", "message", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonsAddonConfiguration:getAddonsAddonConfiguration": { "properties": { "key": { "type": "string", "description": "configuration key name\n" }, "value": { "type": "string", "description": "configuration value name\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getAddonsFilter:getAddonsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getClusterClusterPodNetworkOption:getClusterClusterPodNetworkOption": { "properties": { "cniType": { "type": "string", "description": "The CNI used by the node pools of this cluster\n" } }, "type": "object", "required": [ "cniType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterEndpoint:getClusterEndpoint": { "properties": { "ipv6endpoint": { "type": "string", "description": "The IPv6 networking Kubernetes API server endpoint.\n" }, "kubernetes": { "type": "string", "description": "The non-native networking Kubernetes API server endpoint.\n" }, "privateEndpoint": { "type": "string", "description": "The private native networking Kubernetes API server endpoint.\n" }, "publicEndpoint": { "type": "string", "description": "The public native networking Kubernetes API server endpoint, if one was requested.\n" }, "vcnHostnameEndpoint": { "type": "string", "description": "The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'\n" } }, "type": "object", "required": [ "ipv6endpoint", "kubernetes", "privateEndpoint", "publicEndpoint", "vcnHostnameEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterEndpointConfig:getClusterEndpointConfig": { "properties": { "isPublicIpEnabled": { "type": "boolean", "description": "Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" }, "subnetId": { "type": "string", "description": "The OCID of the regional subnet in which to place the Cluster endpoint.\n" } }, "type": "object", "required": [ "isPublicIpEnabled", "nsgIds", "securityAttributes", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterImagePolicyConfig:getClusterImagePolicyConfig": { "properties": { "isPolicyEnabled": { "type": "boolean", "description": "Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.\n" }, "keyDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterImagePolicyConfigKeyDetail:getClusterImagePolicyConfigKeyDetail" }, "description": "A list of KMS key details.\n" } }, "type": "object", "required": [ "isPolicyEnabled", "keyDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterImagePolicyConfigKeyDetail:getClusterImagePolicyConfigKeyDetail": { "properties": { "kmsKeyId": { "type": "string", "description": "The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.\n" } }, "type": "object", "required": [ "kmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterMetadata:getClusterMetadata": { "properties": { "createdByUserId": { "type": "string", "description": "The user who created the cluster.\n" }, "createdByWorkRequestId": { "type": "string", "description": "The OCID of the work request which created the cluster.\n" }, "deletedByUserId": { "type": "string", "description": "The user who deleted the cluster.\n" }, "deletedByWorkRequestId": { "type": "string", "description": "The OCID of the work request which deleted the cluster.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created.\n" }, "timeCredentialExpiration": { "type": "string", "description": "The time until which the cluster credential is valid.\n" }, "timeDeleted": { "type": "string", "description": "The time the cluster was deleted.\n" }, "timeUpdated": { "type": "string", "description": "The time the cluster was updated.\n" }, "updatedByUserId": { "type": "string", "description": "The user who updated the cluster.\n" }, "updatedByWorkRequestId": { "type": "string", "description": "The OCID of the work request which updated the cluster.\n" } }, "type": "object", "required": [ "createdByUserId", "createdByWorkRequestId", "deletedByUserId", "deletedByWorkRequestId", "timeCreated", "timeCredentialExpiration", "timeDeleted", "timeUpdated", "updatedByUserId", "updatedByWorkRequestId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOption:getClusterOption": { "properties": { "addOns": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionAddOn:getClusterOptionAddOn" }, "description": "Configurable cluster add-ons\n" }, "admissionControllerOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionAdmissionControllerOption:getClusterOptionAdmissionControllerOption" }, "description": "Configurable cluster admission controllers\n" }, "ipFamilies": { "type": "array", "items": { "type": "string" }, "description": "IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).\n" }, "kubernetesNetworkConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionKubernetesNetworkConfig:getClusterOptionKubernetesNetworkConfig" }, "description": "Network configuration for Kubernetes.\n" }, "openIdConnectDiscoveries": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionOpenIdConnectDiscovery:getClusterOptionOpenIdConnectDiscovery" }, "description": "The property that define the status of the OIDC Discovery feature for a cluster.\n" }, "openIdConnectTokenAuthenticationConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionOpenIdConnectTokenAuthenticationConfig:getClusterOptionOpenIdConnectTokenAuthenticationConfig" }, "description": "The properties that configure OIDC token authentication in kube-apiserver. For more information, see [Configuring the API Server](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-flags).\n" }, "persistentVolumeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionPersistentVolumeConfig:getClusterOptionPersistentVolumeConfig" }, "description": "Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)\n" }, "serviceLbConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionServiceLbConfig:getClusterOptionServiceLbConfig" }, "description": "Configuration to be applied to load balancers created by Kubernetes services\n" }, "serviceLbSubnetIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the subnets used for Kubernetes services load balancers.\n" } }, "type": "object", "required": [ "addOns", "admissionControllerOptions", "ipFamilies", "kubernetesNetworkConfigs", "openIdConnectDiscoveries", "openIdConnectTokenAuthenticationConfigs", "persistentVolumeConfigs", "serviceLbConfigs", "serviceLbSubnetIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionAddOn:getClusterOptionAddOn": { "properties": { "isKubernetesDashboardEnabled": { "type": "boolean", "description": "Whether or not to enable the Kubernetes Dashboard add-on.\n" }, "isTillerEnabled": { "type": "boolean", "description": "Whether or not to enable the Tiller add-on.\n" } }, "type": "object", "required": [ "isKubernetesDashboardEnabled", "isTillerEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionAdmissionControllerOption:getClusterOptionAdmissionControllerOption": { "properties": { "isPodSecurityPolicyEnabled": { "type": "boolean", "description": "Whether or not to enable the Pod Security Policy admission controller.\n" } }, "type": "object", "required": [ "isPodSecurityPolicyEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionClusterPodNetworkOption:getClusterOptionClusterPodNetworkOption": { "properties": { "cniType": { "type": "string", "description": "The CNI used by the node pools of this cluster\n" } }, "type": "object", "required": [ "cniType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionKubernetesNetworkConfig:getClusterOptionKubernetesNetworkConfig": { "properties": { "podsCidr": { "type": "string", "description": "The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.\n" }, "servicesCidr": { "type": "string", "description": "The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.\n" } }, "type": "object", "required": [ "podsCidr", "servicesCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionOpenIdConnectDiscovery:getClusterOptionOpenIdConnectDiscovery": { "properties": { "isOpenIdConnectDiscoveryEnabled": { "type": "boolean", "description": "Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.\n" } }, "type": "object", "required": [ "isOpenIdConnectDiscoveryEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionOpenIdConnectTokenAuthenticationConfig:getClusterOptionOpenIdConnectTokenAuthenticationConfig": { "properties": { "caCertificate": { "type": "string", "description": "A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.\n" }, "clientId": { "type": "string", "description": "A client id that all tokens must be issued for.\n" }, "configurationFile": { "type": "string", "description": "A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info [here](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration)\n" }, "groupsClaim": { "type": "string", "description": "JWT claim to use as the user's group. If the claim is present it must be an array of strings.\n" }, "groupsPrefix": { "type": "string", "description": "Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).\n" }, "isOpenIdConnectAuthEnabled": { "type": "boolean", "description": "Whether the cluster has OIDC Auth Config enabled. Defaults to false.\n" }, "issuerUrl": { "type": "string", "description": "URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.\n" }, "requiredClaims": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim:getClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim" }, "description": "A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.\n" }, "signingAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "The signing algorithms accepted. Default is [\"RS256\"].\n" }, "usernameClaim": { "type": "string", "description": "JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n" }, "usernamePrefix": { "type": "string", "description": "Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.\n" } }, "type": "object", "required": [ "caCertificate", "clientId", "configurationFile", "groupsClaim", "groupsPrefix", "isOpenIdConnectAuthEnabled", "issuerUrl", "requiredClaims", "signingAlgorithms", "usernameClaim", "usernamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim:getClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim": { "properties": { "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionPersistentVolumeConfig:getClusterOptionPersistentVolumeConfig": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "required": [ "definedTags", "freeformTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterOptionServiceLbConfig:getClusterOptionServiceLbConfig": { "properties": { "backendNsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) associated to backends to LBs (pods/nodes/virtual pods, etc.). Rules necessary for LB to backend communication would be added when rule management mode is set to NSG via annotations. see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "required": [ "backendNsgIds", "definedTags", "freeformTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClusterWorkloadMappingsFilter:getClusterWorkloadMappingsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getClusterWorkloadMappingsWorkloadMapping:getClusterWorkloadMappingsWorkloadMapping": { "properties": { "clusterId": { "type": "string", "description": "The OCID of the cluster.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The ocid of the workloadMapping.\n" }, "mappedCompartmentId": { "type": "string", "description": "The OCID of the mapped customer compartment.\n" }, "mappedTenancyId": { "type": "string", "description": "The OCID of the mapped customer tenancy.\n" }, "namespace": { "type": "string", "description": "The namespace of the workloadMapping.\n" }, "state": { "type": "string", "description": "The state of the workloadMapping.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created.\n" } }, "type": "object", "required": [ "clusterId", "definedTags", "freeformTags", "id", "mappedCompartmentId", "mappedTenancyId", "namespace", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersCluster:getClustersCluster": { "properties": { "availableKubernetesUpgrades": { "type": "array", "items": { "type": "string" }, "description": "Available Kubernetes versions to which the clusters masters may be upgraded.\n" }, "clusterPodNetworkOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterClusterPodNetworkOption:getClustersClusterClusterPodNetworkOption" }, "description": "Available CNIs and network options for existing and new node pools of the cluster\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "endpointConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterEndpointConfig:getClustersClusterEndpointConfig" }, "description": "The network configuration for access to the Cluster control plane.\n" }, "endpoints": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterEndpoint:getClustersClusterEndpoint" }, "description": "Endpoints served up by the cluster masters.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the cluster.\n" }, "imagePolicyConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterImagePolicyConfig:getClustersClusterImagePolicyConfig" }, "description": "The image verification policy for signature validation.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.\n" }, "kubernetesVersion": { "type": "string", "description": "The version of Kubernetes running on the cluster masters.\n" }, "lifecycleDetails": { "type": "string", "description": "Details about the state of the cluster masters.\n" }, "metadatas": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterMetadata:getClustersClusterMetadata" }, "description": "Metadata about the cluster.\n" }, "name": { "type": "string", "description": "The name to filter on.\n" }, "openIdConnectDiscoveryEndpoint": { "type": "string", "description": "The cluster-specific OpenID Connect Discovery endpoint\n" }, "openIdConnectDiscoveryKey": { "type": "string", "description": "The cluster-specific OpenID Connect Discovery Key to derive the DiscoveryEndpoint\n" }, "options": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOption:getClustersClusterOption" }, "description": "Optional attributes for the cluster.\n" }, "state": { "type": "string", "description": "A cluster lifecycle state to filter on. Can have multiple parameters of this name.\n" }, "type": { "type": "string", "description": "Type of cluster. Values can be BASIC_CLUSTER or ENHANCED_CLUSTER. For more information, see [Cluster Types](https://docs.cloud.oracle.com/iaas/Content/ContEng/Tasks/contengcomparingenhancedwithbasicclusters_topic.htm)\n" }, "vcnId": { "type": "string", "description": "The OCID of the virtual cloud network (VCN) in which the cluster exists.\n" } }, "type": "object", "required": [ "availableKubernetesUpgrades", "clusterPodNetworkOptions", "compartmentId", "definedTags", "endpointConfigs", "endpoints", "freeformTags", "id", "imagePolicyConfigs", "kmsKeyId", "kubernetesVersion", "lifecycleDetails", "metadatas", "name", "openIdConnectDiscoveryEndpoint", "openIdConnectDiscoveryKey", "options", "state", "type", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterClusterPodNetworkOption:getClustersClusterClusterPodNetworkOption": { "properties": { "cniType": { "type": "string", "description": "The CNI used by the node pools of this cluster\n" } }, "type": "object", "required": [ "cniType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterEndpoint:getClustersClusterEndpoint": { "properties": { "ipv6endpoint": { "type": "string", "description": "The IPv6 networking Kubernetes API server endpoint.\n" }, "kubernetes": { "type": "string", "description": "The non-native networking Kubernetes API server endpoint.\n" }, "privateEndpoint": { "type": "string", "description": "The private native networking Kubernetes API server endpoint.\n" }, "publicEndpoint": { "type": "string", "description": "The public native networking Kubernetes API server endpoint, if one was requested.\n" }, "vcnHostnameEndpoint": { "type": "string", "description": "The FQDN assigned to the Kubernetes API private endpoint. Example: 'https://yourVcnHostnameEndpoint'\n" } }, "type": "object", "required": [ "ipv6endpoint", "kubernetes", "privateEndpoint", "publicEndpoint", "vcnHostnameEndpoint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterEndpointConfig:getClustersClusterEndpointConfig": { "properties": { "isPublicIpEnabled": { "type": "boolean", "description": "Whether the cluster should be assigned a public IP address. Defaults to false. If set to true on a private subnet, the cluster provisioning will fail.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to apply to the cluster endpoint. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" }, "subnetId": { "type": "string", "description": "The OCID of the regional subnet in which to place the Cluster endpoint.\n" } }, "type": "object", "required": [ "isPublicIpEnabled", "nsgIds", "securityAttributes", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterImagePolicyConfig:getClustersClusterImagePolicyConfig": { "properties": { "isPolicyEnabled": { "type": "boolean", "description": "Whether the image verification policy is enabled. Defaults to false. If set to true, the images will be verified against the policy at runtime.\n" }, "keyDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterImagePolicyConfigKeyDetail:getClustersClusterImagePolicyConfigKeyDetail" }, "description": "A list of KMS key details.\n" } }, "type": "object", "required": [ "isPolicyEnabled", "keyDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterImagePolicyConfigKeyDetail:getClustersClusterImagePolicyConfigKeyDetail": { "properties": { "kmsKeyId": { "type": "string", "description": "The OCID of the KMS key to be used as the master encryption key for Kubernetes secret encryption.\n" } }, "type": "object", "required": [ "kmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterMetadata:getClustersClusterMetadata": { "properties": { "createdByUserId": { "type": "string", "description": "The user who created the cluster.\n" }, "createdByWorkRequestId": { "type": "string", "description": "The OCID of the work request which created the cluster.\n" }, "deletedByUserId": { "type": "string", "description": "The user who deleted the cluster.\n" }, "deletedByWorkRequestId": { "type": "string", "description": "The OCID of the work request which deleted the cluster.\n" }, "timeCreated": { "type": "string", "description": "The time the cluster was created.\n" }, "timeCredentialExpiration": { "type": "string", "description": "The time until which the cluster credential is valid.\n" }, "timeDeleted": { "type": "string", "description": "The time the cluster was deleted.\n" }, "timeUpdated": { "type": "string", "description": "The time the cluster was updated.\n" }, "updatedByUserId": { "type": "string", "description": "The user who updated the cluster.\n" }, "updatedByWorkRequestId": { "type": "string", "description": "The OCID of the work request which updated the cluster.\n" } }, "type": "object", "required": [ "createdByUserId", "createdByWorkRequestId", "deletedByUserId", "deletedByWorkRequestId", "timeCreated", "timeCredentialExpiration", "timeDeleted", "timeUpdated", "updatedByUserId", "updatedByWorkRequestId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOption:getClustersClusterOption": { "properties": { "addOns": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionAddOn:getClustersClusterOptionAddOn" }, "description": "Configurable cluster add-ons\n" }, "admissionControllerOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionAdmissionControllerOption:getClustersClusterOptionAdmissionControllerOption" }, "description": "Configurable cluster admission controllers\n" }, "ipFamilies": { "type": "array", "items": { "type": "string" }, "description": "IP family to use for single stack or define the order of IP families for dual-stack. Available values are [] (defaults to IPv4), [IPv4] (IPv4), [IPv4, IPv6] (IPv4 preferred dual stack).\n" }, "kubernetesNetworkConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionKubernetesNetworkConfig:getClustersClusterOptionKubernetesNetworkConfig" }, "description": "Network configuration for Kubernetes.\n" }, "openIdConnectDiscoveries": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionOpenIdConnectDiscovery:getClustersClusterOptionOpenIdConnectDiscovery" }, "description": "The property that define the status of the OIDC Discovery feature for a cluster.\n" }, "openIdConnectTokenAuthenticationConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionOpenIdConnectTokenAuthenticationConfig:getClustersClusterOptionOpenIdConnectTokenAuthenticationConfig" }, "description": "The properties that configure OIDC token authentication in kube-apiserver. For more information, see [Configuring the API Server](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-flags).\n" }, "persistentVolumeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionPersistentVolumeConfig:getClustersClusterOptionPersistentVolumeConfig" }, "description": "Configuration to be applied to block volumes created by Kubernetes Persistent Volume Claims (PVC)\n" }, "serviceLbConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionServiceLbConfig:getClustersClusterOptionServiceLbConfig" }, "description": "Configuration to be applied to load balancers created by Kubernetes services\n" }, "serviceLbSubnetIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the subnets used for Kubernetes services load balancers.\n" } }, "type": "object", "required": [ "addOns", "admissionControllerOptions", "ipFamilies", "kubernetesNetworkConfigs", "openIdConnectDiscoveries", "openIdConnectTokenAuthenticationConfigs", "persistentVolumeConfigs", "serviceLbConfigs", "serviceLbSubnetIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionAddOn:getClustersClusterOptionAddOn": { "properties": { "isKubernetesDashboardEnabled": { "type": "boolean", "description": "Whether or not to enable the Kubernetes Dashboard add-on.\n" }, "isTillerEnabled": { "type": "boolean", "description": "Whether or not to enable the Tiller add-on.\n" } }, "type": "object", "required": [ "isKubernetesDashboardEnabled", "isTillerEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionAdmissionControllerOption:getClustersClusterOptionAdmissionControllerOption": { "properties": { "isPodSecurityPolicyEnabled": { "type": "boolean", "description": "Whether or not to enable the Pod Security Policy admission controller.\n" } }, "type": "object", "required": [ "isPodSecurityPolicyEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionKubernetesNetworkConfig:getClustersClusterOptionKubernetesNetworkConfig": { "properties": { "podsCidr": { "type": "string", "description": "The CIDR block for Kubernetes pods. Optional. For ipv4, defaults to 10.244.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0000::/96.\n" }, "servicesCidr": { "type": "string", "description": "The CIDR block for Kubernetes services. Optional. For ipv4, defaults to 10.96.0.0/16. For ipv6, defaults to fd00:eeee:eeee:0001::/108.\n" } }, "type": "object", "required": [ "podsCidr", "servicesCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionOpenIdConnectDiscovery:getClustersClusterOptionOpenIdConnectDiscovery": { "properties": { "isOpenIdConnectDiscoveryEnabled": { "type": "boolean", "description": "Whether the cluster has OIDC Discovery enabled. Defaults to false. If set to true, the cluster will be assigned a public OIDC Discovery endpoint.\n" } }, "type": "object", "required": [ "isOpenIdConnectDiscoveryEnabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionOpenIdConnectTokenAuthenticationConfig:getClustersClusterOptionOpenIdConnectTokenAuthenticationConfig": { "properties": { "caCertificate": { "type": "string", "description": "A Base64 encoded public RSA or ECDSA certificates used to signed your identity provider's web certificate.\n" }, "clientId": { "type": "string", "description": "A client id that all tokens must be issued for.\n" }, "configurationFile": { "type": "string", "description": "A Base64 encoded string of a Kubernetes OIDC Auth Config file. More info [here](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration)\n" }, "groupsClaim": { "type": "string", "description": "JWT claim to use as the user's group. If the claim is present it must be an array of strings.\n" }, "groupsPrefix": { "type": "string", "description": "Prefix prepended to group claims to prevent clashes with existing names (such as system:groups).\n" }, "isOpenIdConnectAuthEnabled": { "type": "boolean", "description": "Whether the cluster has OIDC Auth Config enabled. Defaults to false.\n" }, "issuerUrl": { "type": "string", "description": "URL of the provider that allows the API server to discover public signing keys. Only URLs that use the https:// scheme are accepted. This is typically the provider's discovery URL, changed to have an empty path.\n" }, "requiredClaims": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim:getClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim" }, "description": "A key=value pair that describes a required claim in the ID Token. If set, the claim is verified to be present in the ID Token with a matching value. Repeat this flag to specify multiple claims.\n" }, "signingAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "The signing algorithms accepted. Default is [\"RS256\"].\n" }, "usernameClaim": { "type": "string", "description": "JWT claim to use as the user name. By default sub, which is expected to be a unique identifier of the end user. Admins can choose other claims, such as email or name, depending on their provider. However, claims other than email will be prefixed with the issuer URL to prevent naming clashes with other plugins.\n" }, "usernamePrefix": { "type": "string", "description": "Prefix prepended to username claims to prevent clashes with existing names (such as system:users). For example, the value oidc: will create usernames like oidc:jane.doe. If this flag isn't provided and --oidc-username-claim is a value other than email the prefix defaults to ( Issuer URL )# where ( Issuer URL ) is the value of --oidc-issuer-url. The value - can be used to disable all prefixing.\n" } }, "type": "object", "required": [ "caCertificate", "clientId", "configurationFile", "groupsClaim", "groupsPrefix", "isOpenIdConnectAuthEnabled", "issuerUrl", "requiredClaims", "signingAlgorithms", "usernameClaim", "usernamePrefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim:getClustersClusterOptionOpenIdConnectTokenAuthenticationConfigRequiredClaim": { "properties": { "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionPersistentVolumeConfig:getClustersClusterOptionPersistentVolumeConfig": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "required": [ "definedTags", "freeformTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersClusterOptionServiceLbConfig:getClustersClusterOptionServiceLbConfig": { "properties": { "backendNsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) associated to backends to LBs (pods/nodes/virtual pods, etc.). Rules necessary for LB to backend communication would be added when rule management mode is set to NSG via annotations. see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "required": [ "backendNsgIds", "definedTags", "freeformTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getClustersFilter:getClustersFilter": { "properties": { "name": { "type": "string", "description": "The name to filter on.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getNodePoolInitialNodeLabel:getNodePoolInitialNodeLabel": { "properties": { "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNode:getNodePoolNode": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain in which this node is placed.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "errors": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolNodeError:getNodePoolNodeError" }, "description": "An error that may be associated with the node.\n" }, "faultDomain": { "type": "string", "description": "The fault domain of this node.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the compute instance backing this node.\n" }, "kubernetesVersion": { "type": "string", "description": "The version of Kubernetes this node is running.\n" }, "lifecycleDetails": { "type": "string", "description": "Details about the state of the node.\n" }, "name": { "type": "string", "description": "The name of the node.\n" }, "nodePoolId": { "type": "string", "description": "The OCID of the node pool.\n" }, "privateIp": { "type": "string", "description": "The private IP address of this node.\n" }, "publicIp": { "type": "string", "description": "The public IP address of this node.\n" }, "state": { "type": "string", "description": "The state of the nodepool.\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "availabilityDomain", "definedTags", "errors", "faultDomain", "freeformTags", "id", "kubernetesVersion", "lifecycleDetails", "name", "nodePoolId", "privateIp", "publicIp", "state", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeConfigDetail:getNodePoolNodeConfigDetail": { "properties": { "computeClusterId": { "type": "string", "description": "The OCID of the Compute Cluster to be associated with the worker node instance.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Key Management Service key assigned to the boot volume.\n" }, "nodePoolPodNetworkOptionDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail:getNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail" }, "description": "The CNI related configuration of pods in the node pool.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to\n" }, "placementConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolNodeConfigDetailPlacementConfig:getNodePoolNodeConfigDetailPlacementConfig" }, "description": "The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node.\n" }, "size": { "type": "integer", "description": "The number of nodes in the node pool.\n" } }, "type": "object", "required": [ "computeClusterId", "definedTags", "freeformTags", "isPvEncryptionInTransitEnabled", "kmsKeyId", "nodePoolPodNetworkOptionDetails", "nsgIds", "placementConfigs", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail:getNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail": { "properties": { "cniType": { "type": "string", "description": "The CNI plugin used by this node pool\n" }, "maxPodsPerNode": { "type": "integer", "description": "The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape\n" }, "podNsgIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "podSubnetIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs\n" } }, "type": "object", "required": [ "cniType", "maxPodsPerNode", "podNsgIds", "podSubnetIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeConfigDetailPlacementConfig:getNodePoolNodeConfigDetailPlacementConfig": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain in which this node is placed.\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation in which to place the compute instance.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "A list of fault domains in which to place nodes.\n" }, "hostGroupId": { "type": "string", "description": "The OCID of the Host Group to be associated with the worker node instance.\n" }, "preemptibleNodeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig:getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig" }, "description": "Configuration options for preemptible nodes.\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "availabilityDomain", "capacityReservationId", "faultDomains", "hostGroupId", "preemptibleNodeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig:getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction:getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction" }, "description": "The action to run when the preemptible node is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction:getNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction": { "properties": { "isPreserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "isPreserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeError:getNodePoolNodeError": { "properties": { "code": { "type": "string", "description": "A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).\n" }, "message": { "type": "string", "description": "A human-readable error string of the upstream error.\n" }, "status": { "type": "string", "description": "The status of the HTTP response encountered in the upstream error.\n" } }, "type": "object", "required": [ "code", "message", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeEvictionNodePoolSetting:getNodePoolNodeEvictionNodePoolSetting": { "properties": { "evictionGraceDuration": { "type": "string", "description": "Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M\n" }, "isForceActionAfterGraceDuration": { "type": "boolean", "description": "If the node action should be performed if not all the pods can be evicted in the grace period\n" }, "isForceDeleteAfterGraceDuration": { "type": "boolean", "description": "If the underlying compute instance should be deleted if you cannot evict all the pods in grace period\n" } }, "type": "object", "required": [ "evictionGraceDuration", "isForceActionAfterGraceDuration", "isForceDeleteAfterGraceDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodePoolCyclingDetail:getNodePoolNodePoolCyclingDetail": { "properties": { "cycleModes": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of cycle modes that should be performed on the OKE nodes.\n" }, "isNodeCyclingEnabled": { "type": "boolean", "description": "If cycling operation should be performed on the nodes in the node pool.\n" }, "maximumSurge": { "type": "string", "description": "Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%\n" }, "maximumUnavailable": { "type": "string", "description": "Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%\n" } }, "type": "object", "required": [ "cycleModes", "isNodeCyclingEnabled", "maximumSurge", "maximumUnavailable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeShapeConfig:getNodePoolNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to each node, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to each node in the node pool. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.\n" } }, "type": "object", "required": [ "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeSource:getNodePoolNodeSource": { "properties": { "imageId": { "type": "string", "description": "The OCID of the image used to boot the node.\n" }, "sourceName": { "type": "string", "description": "The user-friendly name of the entity corresponding to the OCID.\n" }, "sourceType": { "type": "string", "description": "The source type for the node. Use `IMAGE` when specifying an OCID of an image.\n" } }, "type": "object", "required": [ "imageId", "sourceName", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolNodeSourceDetail:getNodePoolNodeSourceDetail": { "properties": { "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. Minimum value is 50 GB. See [here](https://docs.cloud.oracle.com/en-us/iaas/Content/Block/Concepts/bootvolumes.htm) for max custom boot volume sizing and OS-specific requirements.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the node.\n" }, "sourceType": { "type": "string", "description": "The source type for the node. Use `IMAGE` when specifying an OCID of an image.\n" } }, "type": "object", "required": [ "bootVolumeSizeInGbs", "imageId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolOptionSource:getNodePoolOptionSource": { "properties": { "imageId": { "type": "string", "description": "The OCID of the image.\n" }, "sourceName": { "type": "string", "description": "The user-friendly name of the entity corresponding to the OCID.\n" }, "sourceType": { "type": "string", "description": "The source type of this option. `IMAGE` means the OCID is of an image.\n" } }, "type": "object", "required": [ "imageId", "sourceName", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolPrimaryVnic:getNodePoolPrimaryVnic": { "properties": { "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" } }, "type": "object", "required": [ "securityAttributes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolSecondaryVnic:getNodePoolSecondaryVnic": { "properties": { "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolSecondaryVnicCreateVnicDetail:getNodePoolSecondaryVnicCreateVnicDetail" }, "description": "The properties of the secondary vnics\n" }, "displayName": { "type": "string", "description": "Display name for vnic attachment\n" }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use\n" } }, "type": "object", "required": [ "createVnicDetails", "displayName", "nicIndex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolSecondaryVnicCreateVnicDetail:getNodePoolSecondaryVnicCreateVnicDetail": { "properties": { "applicationResources": { "type": "array", "items": { "type": "string" }, "description": "The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling\n" }, "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "Display name for vnic attachment\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "ipCount": { "type": "integer", "description": "The number of ip addresses to attach to secondary vnic\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "applicationResources", "assignIpv6ip", "assignPublicIp", "definedTags", "displayName", "freeformTags", "ipCount", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "securityAttributes", "skipSourceDestCheck", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix\n" }, "ipv6subnetCidr": { "type": "string", "description": "The IPv6 prefix allocated to the subnet\n" } }, "type": "object", "required": [ "ipv6address", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsFilter:getNodePoolsFilter": { "properties": { "name": { "type": "string", "description": "The name to filter on.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getNodePoolsNodePool:getNodePoolsNodePool": { "properties": { "clusterId": { "type": "string", "description": "The OCID of the cluster.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the node pool.\n" }, "initialNodeLabels": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolInitialNodeLabel:getNodePoolsNodePoolInitialNodeLabel" }, "description": "A list of key/value pairs to add to nodes after they join the Kubernetes cluster.\n" }, "kubernetesVersion": { "type": "string", "description": "The version of Kubernetes running on the nodes in the node pool.\n" }, "lifecycleDetails": { "type": "string", "description": "Details about the state of the nodepool.\n" }, "name": { "type": "string", "description": "The name to filter on.\n" }, "networkLaunchType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC) for nodes\n" }, "nodeConfigDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetail:getNodePoolsNodePoolNodeConfigDetail" }, "description": "The configuration of nodes in the node pool.\n" }, "nodeEvictionNodePoolSettings": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeEvictionNodePoolSetting:getNodePoolsNodePoolNodeEvictionNodePoolSetting" }, "description": "Node Eviction Details configuration\n" }, "nodeImageId": { "type": "string", "description": "Deprecated. see `nodeSource`. The OCID of the image running on the nodes in the node pool.\n", "deprecationMessage": "The 'node_image_id' field has been deprecated. Please use 'node_source_details' instead. If both fields are specified, then 'node_source_details' will be used." }, "nodeImageName": { "type": "string", "description": "Deprecated. see `nodeSource`. The name of the image running on the nodes in the node pool.\n", "deprecationMessage": "The 'node_image_name' field has been deprecated. Please use 'node_source_details' instead. If both fields are specified, then 'node_source_details' will be used." }, "nodeMetadata": { "type": "object", "additionalProperties": { "type": "string" } }, "nodePoolCyclingDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodePoolCyclingDetail:getNodePoolsNodePoolNodePoolCyclingDetail" }, "description": "Node Pool Cycling Details\n" }, "nodePoolId": { "type": "string" }, "nodeShape": { "type": "string", "description": "The name of the node shape of the nodes in the node pool.\n" }, "nodeShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeShapeConfig:getNodePoolsNodePoolNodeShapeConfig" }, "description": "The shape configuration of the nodes.\n" }, "nodeSourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeSourceDetail:getNodePoolsNodePoolNodeSourceDetail" }, "description": "Source running on the nodes in the node pool.\n" }, "nodeSources": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeSource:getNodePoolsNodePoolNodeSource" }, "description": "Deprecated. see `nodeSourceDetails`. Source running on the nodes in the node pool.\n" }, "nodes": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNode:getNodePoolsNodePoolNode" } }, "primaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolPrimaryVnic:getNodePoolsNodePoolPrimaryVnic" }, "description": "Details for node's primary VNIC\n" }, "quantityPerSubnet": { "type": "integer", "description": "The number of nodes in each subnet.\n" }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolSecondaryVnic:getNodePoolsNodePoolSecondaryVnic" }, "description": "A list of secondary vnics to attach to nodes\n" }, "sshPublicKey": { "type": "string", "description": "The SSH public key on each node in the node pool on launch.\n" }, "state": { "type": "string", "description": "A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING]\n" }, "subnetIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the subnets in which to place nodes for this node pool.\n" } }, "type": "object", "required": [ "clusterId", "compartmentId", "definedTags", "freeformTags", "id", "initialNodeLabels", "kubernetesVersion", "lifecycleDetails", "name", "networkLaunchType", "nodeConfigDetails", "nodeEvictionNodePoolSettings", "nodeImageId", "nodeImageName", "nodeMetadata", "nodePoolCyclingDetails", "nodePoolId", "nodeShape", "nodeShapeConfigs", "nodeSources", "nodeSourceDetails", "nodes", "primaryVnics", "quantityPerSubnet", "secondaryVnics", "sshPublicKey", "state", "subnetIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolInitialNodeLabel:getNodePoolsNodePoolInitialNodeLabel": { "properties": { "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNode:getNodePoolsNodePoolNode": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "errors": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeError:getNodePoolsNodePoolNodeError" } }, "faultDomain": { "type": "string" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the node pool.\n" }, "kubernetesVersion": { "type": "string", "description": "The version of Kubernetes running on the nodes in the node pool.\n" }, "lifecycleDetails": { "type": "string", "description": "Details about the state of the nodepool.\n" }, "name": { "type": "string", "description": "The name to filter on.\n" }, "nodePoolId": { "type": "string" }, "privateIp": { "type": "string" }, "publicIp": { "type": "string" }, "state": { "type": "string", "description": "A list of nodepool lifecycle states on which to filter on, matching any of the list items (OR logic). eg. [ACTIVE, DELETING]\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "availabilityDomain", "definedTags", "errors", "faultDomain", "freeformTags", "id", "kubernetesVersion", "lifecycleDetails", "name", "nodePoolId", "privateIp", "publicIp", "state", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetail:getNodePoolsNodePoolNodeConfigDetail": { "properties": { "computeClusterId": { "type": "string", "description": "The OCID of the Compute Cluster to be associated with the worker node instance.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. This field applies to both block volumes and boot volumes. The default value is false.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Key Management Service key assigned to the boot volume.\n" }, "nodePoolPodNetworkOptionDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail:getNodePoolsNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail" }, "description": "The CNI related configuration of pods in the node pool.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to\n" }, "placementConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailPlacementConfig:getNodePoolsNodePoolNodeConfigDetailPlacementConfig" }, "description": "The placement configurations for the node pool. Provide one placement configuration for each availability domain in which you intend to launch a node.\n" }, "size": { "type": "integer", "description": "The number of nodes in the node pool.\n" } }, "type": "object", "required": [ "computeClusterId", "definedTags", "freeformTags", "isPvEncryptionInTransitEnabled", "kmsKeyId", "nodePoolPodNetworkOptionDetails", "nsgIds", "placementConfigs", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail:getNodePoolsNodePoolNodeConfigDetailNodePoolPodNetworkOptionDetail": { "properties": { "cniType": { "type": "string", "description": "The CNI plugin used by this node pool\n" }, "maxPodsPerNode": { "type": "integer", "description": "The max number of pods per node in the node pool. This value will be limited by the number of VNICs attachable to the node pool shape\n" }, "podNsgIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the Network Security Group(s) to associate pods for this node pool with. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/NetworkSecurityGroup/).\n" }, "podSubnetIds": { "type": "array", "items": { "type": "string" }, "description": "The OCIDs of the subnets in which to place pods for this node pool. This can be one of the node pool subnet IDs\n" } }, "type": "object", "required": [ "cniType", "maxPodsPerNode", "podNsgIds", "podSubnetIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailPlacementConfig:getNodePoolsNodePoolNodeConfigDetailPlacementConfig": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain in which to place nodes. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation in which to place the compute instance.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "A list of fault domains in which to place nodes.\n" }, "hostGroupId": { "type": "string", "description": "The OCID of the Host Group to be associated with the worker node instance.\n" }, "preemptibleNodeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig:getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig" }, "description": "Configuration options for preemptible nodes.\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "availabilityDomain", "capacityReservationId", "faultDomains", "hostGroupId", "preemptibleNodeConfigs", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig:getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction:getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction" }, "description": "The action to run when the preemptible node is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction:getNodePoolsNodePoolNodeConfigDetailPlacementConfigPreemptibleNodeConfigPreemptionAction": { "properties": { "isPreserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "isPreserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeError:getNodePoolsNodePoolNodeError": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "string" } }, "type": "object", "required": [ "code", "message", "status" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeEvictionNodePoolSetting:getNodePoolsNodePoolNodeEvictionNodePoolSetting": { "properties": { "evictionGraceDuration": { "type": "string", "description": "Duration after which OKE will give up eviction of the pods on the node. PT0M will indicate you want to delete the node without cordon and drain. Default PT60M, Min PT0M, Max: PT60M. Format ISO 8601 e.g PT30M\n" }, "isForceActionAfterGraceDuration": { "type": "boolean", "description": "If the node action should be performed if not all the pods can be evicted in the grace period\n" }, "isForceDeleteAfterGraceDuration": { "type": "boolean", "description": "If the underlying compute instance should be deleted if you cannot evict all the pods in grace period\n" } }, "type": "object", "required": [ "evictionGraceDuration", "isForceActionAfterGraceDuration", "isForceDeleteAfterGraceDuration" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodePoolCyclingDetail:getNodePoolsNodePoolNodePoolCyclingDetail": { "properties": { "cycleModes": { "type": "array", "items": { "type": "string" }, "description": "An ordered list of cycle modes that should be performed on the OKE nodes.\n" }, "isNodeCyclingEnabled": { "type": "boolean", "description": "If cycling operation should be performed on the nodes in the node pool.\n" }, "maximumSurge": { "type": "string", "description": "Maximum additional new compute instances that would be temporarily created and added to nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Nodepool size or 0% to 100%\n" }, "maximumUnavailable": { "type": "string", "description": "Maximum active nodes that would be terminated from nodepool during the cycling nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Nodepool size or 0% to 100%\n" } }, "type": "object", "required": [ "cycleModes", "isNodeCyclingEnabled", "maximumSurge", "maximumUnavailable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeShapeConfig:getNodePoolsNodePoolNodeShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to each node, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to each node in the node pool. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details.\n" } }, "type": "object", "required": [ "memoryInGbs", "ocpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeSource:getNodePoolsNodePoolNodeSource": { "properties": { "imageId": { "type": "string", "description": "The OCID of the image used to boot the node.\n" }, "sourceName": { "type": "string", "description": "The user-friendly name of the entity corresponding to the OCID.\n" }, "sourceType": { "type": "string", "description": "The source type for the node. Use `IMAGE` when specifying an OCID of an image.\n" } }, "type": "object", "required": [ "imageId", "sourceName", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolNodeSourceDetail:getNodePoolsNodePoolNodeSourceDetail": { "properties": { "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. Minimum value is 50 GB. See [here](https://docs.cloud.oracle.com/en-us/iaas/Content/Block/Concepts/bootvolumes.htm) for max custom boot volume sizing and OS-specific requirements.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the node.\n" }, "sourceType": { "type": "string", "description": "The source type for the node. Use `IMAGE` when specifying an OCID of an image.\n" } }, "type": "object", "required": [ "bootVolumeSizeInGbs", "imageId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolPrimaryVnic:getNodePoolsNodePoolPrimaryVnic": { "properties": { "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" } }, "type": "object", "required": [ "securityAttributes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolSecondaryVnic:getNodePoolsNodePoolSecondaryVnic": { "properties": { "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolSecondaryVnicCreateVnicDetail:getNodePoolsNodePoolSecondaryVnicCreateVnicDetail" }, "description": "The properties of the secondary vnics\n" }, "displayName": { "type": "string", "description": "Display name for vnic attachment\n" }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use\n" } }, "type": "object", "required": [ "createVnicDetails", "displayName", "nicIndex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolSecondaryVnicCreateVnicDetail:getNodePoolsNodePoolSecondaryVnicCreateVnicDetail": { "properties": { "applicationResources": { "type": "array", "items": { "type": "string" }, "description": "The application resource that corresponds to this secondary vnic. Used to map pods to this specific vnic for scheduling\n" }, "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "Display name for vnic attachment\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "ipCount": { "type": "integer", "description": "The number of ip addresses to attach to secondary vnic\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getNodePoolsNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getNodePoolsNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources.\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC\n" }, "subnetId": { "type": "string", "description": "the ocid of the subnet to create the vnic in\n" } }, "type": "object", "required": [ "applicationResources", "assignIpv6ip", "assignPublicIp", "definedTags", "displayName", "freeformTags", "ipCount", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "securityAttributes", "skipSourceDestCheck", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getNodePoolsNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getNodePoolsNodePoolSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix\n" }, "ipv6subnetCidr": { "type": "string", "description": "The IPv6 prefix allocated to the subnet\n" } }, "type": "object", "required": [ "ipv6address", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getPodShapesFilter:getPodShapesFilter": { "properties": { "name": { "type": "string", "description": "The name to filter on.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getPodShapesPodShape:getPodShapesPodShape": { "properties": { "memoryOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getPodShapesPodShapeMemoryOption:getPodShapesPodShapeMemoryOption" }, "description": "ShapeMemoryOptions.\n" }, "name": { "type": "string", "description": "The name to filter on.\n" }, "networkBandwidthOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getPodShapesPodShapeNetworkBandwidthOption:getPodShapesPodShapeNetworkBandwidthOption" }, "description": "ShapeNetworkBandwidthOptions.\n" }, "ocpuOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getPodShapesPodShapeOcpuOption:getPodShapesPodShapeOcpuOption" }, "description": "Options for OCPU shape.\n" }, "processorDescription": { "type": "string", "description": "A short description of the VM's processor (CPU).\n" } }, "type": "object", "required": [ "memoryOptions", "name", "networkBandwidthOptions", "ocpuOptions", "processorDescription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getPodShapesPodShapeMemoryOption:getPodShapesPodShapeMemoryOption": { "properties": { "defaultPerOcpuInGbs": { "type": "number", "description": "The default amount of memory per OCPU available for this shape, in gigabytes.\n" }, "maxInGbs": { "type": "number", "description": "The maximum amount of memory, in gigabytes.\n" }, "maxPerOcpuInGbs": { "type": "number", "description": "The maximum amount of memory per OCPU available for this shape, in gigabytes.\n" }, "minInGbs": { "type": "number", "description": "The minimum amount of memory, in gigabytes.\n" }, "minPerOcpuInGbs": { "type": "number", "description": "The minimum amount of memory per OCPU available for this shape, in gigabytes.\n" } }, "type": "object", "required": [ "defaultPerOcpuInGbs", "maxInGbs", "maxPerOcpuInGbs", "minInGbs", "minPerOcpuInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getPodShapesPodShapeNetworkBandwidthOption:getPodShapesPodShapeNetworkBandwidthOption": { "properties": { "defaultPerOcpuInGbps": { "type": "number", "description": "The default amount of networking bandwidth per OCPU, in gigabits per second.\n" }, "maxInGbps": { "type": "number", "description": "The maximum amount of networking bandwidth, in gigabits per second.\n" }, "minInGbps": { "type": "number", "description": "The minimum amount of networking bandwidth, in gigabits per second.\n" } }, "type": "object", "required": [ "defaultPerOcpuInGbps", "maxInGbps", "minInGbps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getPodShapesPodShapeOcpuOption:getPodShapesPodShapeOcpuOption": { "properties": { "max": { "type": "number", "description": "The maximum number of OCPUs.\n" }, "min": { "type": "number", "description": "The minimum number of OCPUs.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolInitialVirtualNodeLabel:getVirtualNodePoolInitialVirtualNodeLabel": { "properties": { "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolPlacementConfiguration:getVirtualNodePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1`\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domain of this virtual node.\n" }, "subnetId": { "type": "string", "description": "The private regional subnet where pods' VNIC will be placed.\n" } }, "type": "object", "required": [ "availabilityDomain", "faultDomains", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolPodConfiguration:getVirtualNodePoolPodConfiguration": { "properties": { "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of network security group IDs applied to the Pod VNIC.\n" }, "shape": { "type": "string", "description": "Shape of the pods.\n" }, "subnetId": { "type": "string", "description": "The private regional subnet where pods' VNIC will be placed.\n" } }, "type": "object", "required": [ "nsgIds", "shape", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolTaint:getVirtualNodePoolTaint": { "properties": { "effect": { "type": "string", "description": "The effect of the pair.\n" }, "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "effect", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolVirtualNodePoolCyclingDetail:getVirtualNodePoolVirtualNodePoolCyclingDetail": { "properties": { "isVirtualNodeCyclingEnabled": { "type": "boolean", "description": "If virtual nodes in the virtual nodepool will be cycled to have new changes.\n" }, "maximumSurge": { "type": "string", "description": "Maximum additional new virtual nodes that would be temporarily created and added to virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Virtual Nodepool size or 0% to 100%\n" }, "maximumUnavailable": { "type": "string", "description": "Maximum active virtual nodes that would be terminated from virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Virtual Nodepool size or 0% to 100%\n" } }, "type": "object", "required": [ "isVirtualNodeCyclingEnabled", "maximumSurge", "maximumUnavailable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolVirtualNodeTag:getVirtualNodePoolVirtualNodeTag": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "required": [ "definedTags", "freeformTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsFilter:getVirtualNodePoolsFilter": { "properties": { "name": { "type": "string", "description": "The name to filter on.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePool:getVirtualNodePoolsVirtualNodePool": { "properties": { "clusterId": { "type": "string", "description": "The OCID of the cluster.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "Display name of the virtual node pool. This is a non-unique value.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the virtual node pool.\n" }, "initialVirtualNodeLabels": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolInitialVirtualNodeLabel:getVirtualNodePoolsVirtualNodePoolInitialVirtualNodeLabel" }, "description": "Initial labels that will be added to the Kubernetes Virtual Node object when it registers. This is the same as virtualNodePool resources.\n" }, "kubernetesVersion": { "type": "string", "description": "The version of Kubernetes running on the nodes in the node pool.\n" }, "lifecycleDetails": { "type": "string", "description": "Details about the state of the Virtual Node Pool.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of network security group IDs applied to the Pod VNIC.\n" }, "placementConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolPlacementConfiguration:getVirtualNodePoolsVirtualNodePoolPlacementConfiguration" }, "description": "The list of placement configurations which determines where Virtual Nodes will be provisioned across as it relates to the subnet and availability domains. The size attribute determines how many we evenly spread across these placement configurations\n" }, "podConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolPodConfiguration:getVirtualNodePoolsVirtualNodePoolPodConfiguration" }, "description": "The pod configuration for pods run on virtual nodes of this virtual node pool.\n" }, "size": { "type": "integer", "description": "The number of Virtual Nodes that should be in the Virtual Node Pool. The placement configurations determine where these virtual nodes are placed.\n" }, "state": { "type": "string", "description": "A virtual node pool lifecycle state to filter on. Can have multiple parameters of this name.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "taints": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolTaint:getVirtualNodePoolsVirtualNodePoolTaint" }, "description": "A taint is a collection of \u003ckey, value, effect\u003e. These taints will be applied to the Virtual Nodes of this Virtual Node Pool for Kubernetes scheduling.\n" }, "timeCreated": { "type": "string", "description": "The time the virtual node pool was created.\n" }, "timeUpdated": { "type": "string", "description": "The time the virtual node pool was updated.\n" }, "virtualNodePoolCyclingDetails": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolVirtualNodePoolCyclingDetail:getVirtualNodePoolsVirtualNodePoolVirtualNodePoolCyclingDetail" }, "description": "Virtual Node Pool Cycling Details\n" }, "virtualNodePoolId": { "type": "string" }, "virtualNodeTags": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolVirtualNodeTag:getVirtualNodePoolsVirtualNodePoolVirtualNodeTag" }, "description": "The tags associated to the virtual nodes in this virtual node pool.\n" } }, "type": "object", "required": [ "clusterId", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "initialVirtualNodeLabels", "kubernetesVersion", "lifecycleDetails", "nsgIds", "placementConfigurations", "podConfigurations", "size", "state", "systemTags", "taints", "timeCreated", "timeUpdated", "virtualNodePoolCyclingDetails", "virtualNodePoolId", "virtualNodeTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolInitialVirtualNodeLabel:getVirtualNodePoolsVirtualNodePoolInitialVirtualNodeLabel": { "properties": { "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolPlacementConfiguration:getVirtualNodePoolsVirtualNodePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain in which to place virtual nodes. Example: `Uocm:PHX-AD-1`\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domain of this virtual node.\n" }, "subnetId": { "type": "string", "description": "The private regional subnet where pods' VNIC will be placed.\n" } }, "type": "object", "required": [ "availabilityDomain", "faultDomains", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolPodConfiguration:getVirtualNodePoolsVirtualNodePoolPodConfiguration": { "properties": { "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "List of network security group IDs applied to the Pod VNIC.\n" }, "shape": { "type": "string", "description": "Shape of the pods.\n" }, "subnetId": { "type": "string", "description": "The private regional subnet where pods' VNIC will be placed.\n" } }, "type": "object", "required": [ "nsgIds", "shape", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolTaint:getVirtualNodePoolsVirtualNodePoolTaint": { "properties": { "effect": { "type": "string", "description": "The effect of the pair.\n" }, "key": { "type": "string", "description": "The key of the pair.\n" }, "value": { "type": "string", "description": "The value of the pair.\n" } }, "type": "object", "required": [ "effect", "key", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolVirtualNodePoolCyclingDetail:getVirtualNodePoolsVirtualNodePoolVirtualNodePoolCyclingDetail": { "properties": { "isVirtualNodeCyclingEnabled": { "type": "boolean", "description": "If virtual nodes in the virtual nodepool will be cycled to have new changes.\n" }, "maximumSurge": { "type": "string", "description": "Maximum additional new virtual nodes that would be temporarily created and added to virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 1, Ranges from 0 to Virtual Nodepool size or 0% to 100%\n" }, "maximumUnavailable": { "type": "string", "description": "Maximum active virtual nodes that would be terminated from virtual nodepool during the cycling virtual nodepool process. OKE supports both integer and percentage input. Defaults to 0, Ranges from 0 to Virtual Nodepool size or 0% to 100%\n" } }, "type": "object", "required": [ "isVirtualNodeCyclingEnabled", "maximumSurge", "maximumUnavailable" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getVirtualNodePoolsVirtualNodePoolVirtualNodeTag:getVirtualNodePoolsVirtualNodePoolVirtualNodeTag": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" } }, "type": "object", "required": [ "definedTags", "freeformTags" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getWorkRequestErrorsFilter:getWorkRequestErrorsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getWorkRequestErrorsWorkRequestError:getWorkRequestErrorsWorkRequestError": { "properties": { "code": { "type": "string", "description": "A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.cloud.oracle.com/iaas/Content/API/References/apierrors.htm).\n" }, "message": { "type": "string", "description": "A human-readable error string.\n" }, "timestamp": { "type": "string", "description": "The date and time the error occurred.\n" } }, "type": "object", "required": [ "code", "message", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getWorkRequestLogEntriesFilter:getWorkRequestLogEntriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getWorkRequestLogEntriesWorkRequestLogEntry:getWorkRequestLogEntriesWorkRequestLogEntry": { "properties": { "message": { "type": "string", "description": "The description of an action that occurred.\n" }, "timestamp": { "type": "string", "description": "The date and time the log entry occurred.\n" } }, "type": "object", "required": [ "message", "timestamp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getWorkRequestsFilter:getWorkRequestsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerEngine/getWorkRequestsWorkRequest:getWorkRequestsWorkRequest": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "id": { "type": "string", "description": "The OCID of the work request.\n" }, "operationType": { "type": "string", "description": "The type of work the work request is doing.\n" }, "resources": { "type": "array", "items": { "$ref": "#/types/oci:ContainerEngine/getWorkRequestsWorkRequestResource:getWorkRequestsWorkRequestResource" }, "description": "The resources this work request affects.\n" }, "status": { "type": "string", "description": "A work request status to filter on. Can have multiple parameters of this name.\n" }, "timeAccepted": { "type": "string", "description": "The time the work request was accepted.\n" }, "timeFinished": { "type": "string", "description": "The time the work request was finished.\n" }, "timeStarted": { "type": "string", "description": "The time the work request was started.\n" } }, "type": "object", "required": [ "compartmentId", "id", "operationType", "resources", "status", "timeAccepted", "timeFinished", "timeStarted" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerEngine/getWorkRequestsWorkRequestResource:getWorkRequestsWorkRequestResource": { "properties": { "actionType": { "type": "string", "description": "The way in which this resource was affected by the work tracked by the work request.\n" }, "entityType": { "type": "string", "description": "The resource type the work request affects.\n" }, "entityUri": { "type": "string", "description": "The URI path on which the user can issue a GET request to access the resource metadata.\n" }, "identifier": { "type": "string", "description": "The OCID of the resource the work request affects.\n" } }, "type": "object", "required": [ "actionType", "entityType", "entityUri", "identifier" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainer:getContainerInstanceContainer": { "properties": { "arguments": { "type": "array", "items": { "type": "string" } }, "availabilityDomain": { "type": "string", "description": "The availability domain to place the container instance.\n" }, "commands": { "type": "array", "items": { "type": "string" } }, "compartmentId": { "type": "string", "description": "The OCID of the compartment.\n" }, "containerId": { "type": "string", "description": "The OCID of the container.\n" }, "containerInstanceId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container instance.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" } }, "exitCode": { "type": "integer" }, "faultDomain": { "type": "string", "description": "The fault domain to place the container instance.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "healthChecks": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceContainerHealthCheck:getContainerInstanceContainerHealthCheck" } }, "imageUrl": { "type": "string" }, "isResourcePrincipalDisabled": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message that describes the current state of the container in more detail. Can be used to provide actionable information.\n" }, "resourceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceContainerResourceConfig:getContainerInstanceContainerResourceConfig" } }, "securityContexts": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceContainerSecurityContext:getContainerInstanceContainerSecurityContext" }, "description": "Security context for all containers in a container instance.\n" }, "state": { "type": "string", "description": "The current state of the container instance.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`.\n" }, "timeCreated": { "type": "string", "description": "The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "timeTerminated": { "type": "string" }, "timeUpdated": { "type": "string", "description": "The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceContainerVolumeMount:getContainerInstanceContainerVolumeMount" } }, "workingDirectory": { "type": "string" } }, "type": "object", "required": [ "arguments", "availabilityDomain", "commands", "compartmentId", "containerId", "containerInstanceId", "definedTags", "displayName", "environmentVariables", "exitCode", "faultDomain", "freeformTags", "healthChecks", "imageUrl", "isResourcePrincipalDisabled", "lifecycleDetails", "resourceConfigs", "securityContexts", "state", "systemTags", "timeCreated", "timeTerminated", "timeUpdated", "volumeMounts", "workingDirectory" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainerHealthCheck:getContainerInstanceContainerHealthCheck": { "properties": { "failureAction": { "type": "string" }, "failureThreshold": { "type": "integer" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceContainerHealthCheckHeader:getContainerInstanceContainerHealthCheckHeader" } }, "healthCheckType": { "type": "string" }, "initialDelayInSeconds": { "type": "integer" }, "intervalInSeconds": { "type": "integer" }, "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "path": { "type": "string", "description": "(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.\n" }, "port": { "type": "integer" }, "status": { "type": "string" }, "statusDetails": { "type": "string" }, "successThreshold": { "type": "integer" }, "timeoutInSeconds": { "type": "integer" } }, "type": "object", "required": [ "failureAction", "failureThreshold", "headers", "healthCheckType", "initialDelayInSeconds", "intervalInSeconds", "name", "path", "port", "status", "statusDetails", "successThreshold", "timeoutInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainerHealthCheckHeader:getContainerInstanceContainerHealthCheckHeader": { "properties": { "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "value": { "type": "string", "description": "The value of the mount option.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainerResourceConfig:getContainerInstanceContainerResourceConfig": { "properties": { "memoryLimitInGbs": { "type": "number" }, "vcpusLimit": { "type": "number" } }, "type": "object", "required": [ "memoryLimitInGbs", "vcpusLimit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainerSecurityContext:getContainerInstanceContainerSecurityContext": { "properties": { "capabilities": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceContainerSecurityContextCapability:getContainerInstanceContainerSecurityContextCapability" } }, "isNonRootUserCheckEnabled": { "type": "boolean" }, "isRootFileSystemReadonly": { "type": "boolean" }, "runAsGroup": { "type": "integer" }, "runAsUser": { "type": "integer" }, "securityContextType": { "type": "string", "description": "The type of security context\n" } }, "type": "object", "required": [ "capabilities", "isNonRootUserCheckEnabled", "isRootFileSystemReadonly", "runAsGroup", "runAsUser", "securityContextType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainerSecurityContextCapability:getContainerInstanceContainerSecurityContextCapability": { "properties": { "addCapabilities": { "type": "array", "items": { "type": "string" } }, "dropCapabilities": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "addCapabilities", "dropCapabilities" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceContainerVolumeMount:getContainerInstanceContainerVolumeMount": { "properties": { "isReadOnly": { "type": "boolean" }, "mountPath": { "type": "string" }, "partition": { "type": "integer" }, "subPath": { "type": "string" }, "volumeName": { "type": "string" } }, "type": "object", "required": [ "isReadOnly", "mountPath", "partition", "subPath", "volumeName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceDnsConfig:getContainerInstanceDnsConfig": { "properties": { "nameservers": { "type": "array", "items": { "type": "string" }, "description": "IP address of the name server..\n" }, "options": { "type": "array", "items": { "type": "string" }, "description": "Options allows certain internal resolver variables to be modified.\n" }, "searches": { "type": "array", "items": { "type": "string" }, "description": "Search list for hostname lookup.\n" } }, "type": "object", "required": [ "nameservers", "options", "searches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceImagePullSecret:getContainerInstanceImagePullSecret": { "properties": { "password": { "type": "string", "secret": true }, "registryEndpoint": { "type": "string", "description": "The registry endpoint of the container image.\n" }, "secretId": { "type": "string", "description": "The OCID of the secret for registry credentials.\n" }, "secretType": { "type": "string", "description": "The type of ImagePullSecret.\n" }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "registryEndpoint", "secretId", "secretType", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceSecurityContext:getContainerInstanceSecurityContext": { "properties": { "fsGroup": { "type": "integer", "description": "A special supplemental group that applies to all containers in the container instance. Some volume types allow the container instance to change ownership of the volume. The owning GID will be the fsGroup, the setgid bit will be set (new files will be owned by the fsGroup), and the permission bits are OR'd with rw-rw----. If unset, the container instance will not modify the ownership and permissions of volumes.\n" }, "fsGroupChangePolicy": { "type": "string", "description": "Defines behavior of changing ownership and permission of the volume before being exposed inside the containers. This only applies to volumes which support fsGroup ownership and permissions, and will have no effect on ephemeral volumes. ON_ROOT_MISMATCH only changes permissions and ownership if the permission and ownership of the root directory does not match the expected permissions and ownership of the volume. This can improve container instance start times. ALWAYS changes permission and ownership of the volume when it is mounted. If unset, ALWAYS is used.\n" }, "securityContextType": { "type": "string", "description": "The type of security context\n" } }, "type": "object", "required": [ "fsGroup", "fsGroupChangePolicy", "securityContextType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapeConfig:getContainerInstanceShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the container instance, in gigabytes.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "The networking bandwidth available to the container instance, in gigabits per second.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the container instance.\n" }, "processorDescription": { "type": "string", "description": "A short description of the container instance's processor (CPU).\n" } }, "type": "object", "required": [ "memoryInGbs", "networkingBandwidthInGbps", "ocpus", "processorDescription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapeItem:getContainerInstanceShapeItem": { "properties": { "memoryOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapeItemMemoryOption:getContainerInstanceShapeItemMemoryOption" }, "description": "For a flexible shape, the amount of memory available for instances that use this shape.\n" }, "name": { "type": "string", "description": "The name identifying the shape.\n" }, "networkingBandwidthOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapeItemNetworkingBandwidthOption:getContainerInstanceShapeItemNetworkingBandwidthOption" }, "description": "For a flexible shape, the amount of networking bandwidth available for instances that use this shape.\n" }, "ocpuOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapeItemOcpuOption:getContainerInstanceShapeItemOcpuOption" }, "description": "For a flexible shape, the number of OCPUs available for instances that use this shape.\n" }, "processorDescription": { "type": "string", "description": "A short description of the Instance's processor (CPU).\n" } }, "type": "object", "required": [ "memoryOptions", "name", "networkingBandwidthOptions", "ocpuOptions", "processorDescription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapeItemMemoryOption:getContainerInstanceShapeItemMemoryOption": { "properties": { "defaultPerOcpuInGbs": { "type": "number", "description": "The default amount of memory per OCPU available for this shape, in gigabytes.\n" }, "maxInGbs": { "type": "number", "description": "The maximum amount of memory, in gigabytes.\n" }, "maxPerOcpuInGbs": { "type": "number", "description": "The maximum amount of memory per OCPU available for this shape, in gigabytes.\n" }, "minInGbs": { "type": "number", "description": "The minimum amount of memory, in gigabytes.\n" }, "minPerOcpuInGbs": { "type": "number", "description": "The minimum amount of memory per OCPU available for this shape, in gigabytes.\n" } }, "type": "object", "required": [ "defaultPerOcpuInGbs", "maxInGbs", "maxPerOcpuInGbs", "minInGbs", "minPerOcpuInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapeItemNetworkingBandwidthOption:getContainerInstanceShapeItemNetworkingBandwidthOption": { "properties": { "defaultPerOcpuInGbps": { "type": "number", "description": "The default amount of networking bandwidth per OCPU, in gigabits per second.\n" }, "maxInGbps": { "type": "number", "description": "The maximum amount of networking bandwidth, in gigabits per second.\n" }, "minInGbps": { "type": "number", "description": "The minimum amount of networking bandwidth, in gigabits per second.\n" } }, "type": "object", "required": [ "defaultPerOcpuInGbps", "maxInGbps", "minInGbps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapeItemOcpuOption:getContainerInstanceShapeItemOcpuOption": { "properties": { "max": { "type": "number", "description": "The maximum number of OCPUs.\n" }, "min": { "type": "number", "description": "The minimum number of OCPUs.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollection:getContainerInstanceShapesContainerInstanceShapeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItem:getContainerInstanceShapesContainerInstanceShapeCollectionItem" }, "description": "A list of shapes.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItem:getContainerInstanceShapesContainerInstanceShapeCollectionItem": { "properties": { "memoryOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItemMemoryOption:getContainerInstanceShapesContainerInstanceShapeCollectionItemMemoryOption" }, "description": "For a flexible shape, the amount of memory available for container instances that use this shape.\n" }, "name": { "type": "string", "description": "The name identifying the shape.\n" }, "networkingBandwidthOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItemNetworkingBandwidthOption:getContainerInstanceShapesContainerInstanceShapeCollectionItemNetworkingBandwidthOption" }, "description": "For a flexible shape, the amount of networking bandwidth available for container instances that use this shape.\n" }, "ocpuOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItemOcpuOption:getContainerInstanceShapesContainerInstanceShapeCollectionItemOcpuOption" }, "description": "For a flexible shape, the number of OCPUs available for container instances that use this shape.\n" }, "processorDescription": { "type": "string", "description": "A short description of the container instance's processor (CPU).\n" } }, "type": "object", "required": [ "memoryOptions", "name", "networkingBandwidthOptions", "ocpuOptions", "processorDescription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItemMemoryOption:getContainerInstanceShapesContainerInstanceShapeCollectionItemMemoryOption": { "properties": { "defaultPerOcpuInGbs": { "type": "number", "description": "The default amount of memory per OCPU available for this shape (GB).\n" }, "maxInGbs": { "type": "number", "description": "The maximum amount of memory (GB).\n" }, "maxPerOcpuInGbs": { "type": "number", "description": "The maximum amount of memory per OCPU available for this shape (GB).\n" }, "minInGbs": { "type": "number", "description": "The minimum amount of memory (GB).\n" }, "minPerOcpuInGbs": { "type": "number", "description": "The minimum amount of memory per OCPU available for this shape (GB).\n" } }, "type": "object", "required": [ "defaultPerOcpuInGbs", "maxInGbs", "maxPerOcpuInGbs", "minInGbs", "minPerOcpuInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItemNetworkingBandwidthOption:getContainerInstanceShapesContainerInstanceShapeCollectionItemNetworkingBandwidthOption": { "properties": { "defaultPerOcpuInGbps": { "type": "number", "description": "The default amount of networking bandwidth per OCPU, in gigabits per second.\n" }, "maxInGbps": { "type": "number", "description": "The maximum amount of networking bandwidth, in gigabits per second.\n" }, "minInGbps": { "type": "number", "description": "The minimum amount of networking bandwidth, in gigabits per second.\n" } }, "type": "object", "required": [ "defaultPerOcpuInGbps", "maxInGbps", "minInGbps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapesContainerInstanceShapeCollectionItemOcpuOption:getContainerInstanceShapesContainerInstanceShapeCollectionItemOcpuOption": { "properties": { "max": { "type": "number", "description": "The maximum number of OCPUs.\n" }, "min": { "type": "number", "description": "The minimum number of OCPUs.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceShapesFilter:getContainerInstanceShapesFilter": { "properties": { "name": { "type": "string", "description": "The name identifying the shape.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:ContainerInstances/getContainerInstanceVnic:getContainerInstanceVnic": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string" }, "isPublicIpAssigned": { "type": "boolean" }, "nsgIds": { "type": "array", "items": { "type": "string" } }, "privateIp": { "type": "string" }, "skipSourceDestCheck": { "type": "boolean" }, "subnetId": { "type": "string", "description": "Specifies the network interface to be used for the Oracle Cloud Infrastructure File Storage Service (FSS) volume. This is a required parameter when a Container Instance is attached to more than one subnets.\n" }, "vnicId": { "type": "string", "description": "The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.\n" } }, "type": "object", "required": [ "definedTags", "displayName", "freeformTags", "hostnameLabel", "isPublicIpAssigned", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vnicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolume:getContainerInstanceVolume": { "properties": { "backingStore": { "type": "string", "description": "The volume type of the empty directory, can be either File Storage or Memory.\n" }, "configs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceVolumeConfig:getContainerInstanceVolumeConfig" }, "description": "Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.\n" }, "exports": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceVolumeExport:getContainerInstanceVolumeExport" }, "description": "An Oracle Cloud Infrastructure File Storage Service (FSS) Export. Check https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/Export/ for more details.\n" }, "mountCommands": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceVolumeMountCommand:getContainerInstanceVolumeMountCommand" }, "description": "Specifications for the mount command to mount the Oracle Cloud Infrastructure File Storage Service (FSS) File System to Containers.\n" }, "mountTargets": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceVolumeMountTarget:getContainerInstanceVolumeMountTarget" }, "description": "An Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. Check https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/MountTarget for more details.\n" }, "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "securities": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceVolumeSecurity:getContainerInstanceVolumeSecurity" }, "description": "Security options for Oracle Cloud Infrastructure FSS File System.\n" }, "subnetId": { "type": "string", "description": "Specifies the network interface to be used for the Oracle Cloud Infrastructure File Storage Service (FSS) volume. This is a required parameter when a Container Instance is attached to more than one subnets.\n" }, "volumeType": { "type": "string", "description": "The type of volume.\n" } }, "type": "object", "required": [ "backingStore", "configs", "exports", "mountCommands", "mountTargets", "name", "securities", "subnetId", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolumeConfig:getContainerInstanceVolumeConfig": { "properties": { "data": { "type": "string", "description": "The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.\n" }, "fileName": { "type": "string", "description": "The name of the file. The fileName should be unique across the volume.\n" }, "path": { "type": "string", "description": "(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.\n" } }, "type": "object", "required": [ "data", "fileName", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolumeExport:getContainerInstanceVolumeExport": { "properties": { "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target.\n" }, "ociFssExportType": { "type": "string", "description": "Determines the mode for supplying the Oracle Cloud Infrastructure File Storage Service (FSS) Export details. The value must be an OCID unless your tenancy is allowed to use PATH as a value.\n" } }, "type": "object", "required": [ "id", "ociFssExportType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolumeMountCommand:getContainerInstanceVolumeMountCommand": { "properties": { "mountOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstanceVolumeMountCommandMountOption:getContainerInstanceVolumeMountCommandMountOption" }, "description": "List of mount options to be used in the mount command. The order of this array will be maintained while preparing the mount command.\n" } }, "type": "object", "required": [ "mountOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolumeMountCommandMountOption:getContainerInstanceVolumeMountCommandMountOption": { "properties": { "option": { "type": "string", "description": "A generic (https://man7.org/linux/man-pages/man8/mount.8.html) or nfs (https://man7.org/linux/man-pages/man5/nfs.5.html) mount option.\n" }, "value": { "type": "string", "description": "The value of the mount option.\n" } }, "type": "object", "required": [ "option", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolumeMountTarget:getContainerInstanceVolumeMountTarget": { "properties": { "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target.\n" }, "ociFssMountTargetType": { "type": "string", "description": "Determines the mode for supplying the Oracle Cloud Infrastructure File Storage Service (FSS) Mount target details. The value must be an OCID unless your tenancy is allowed to use HOST as a value.\n" } }, "type": "object", "required": [ "id", "ociFssMountTargetType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstanceVolumeSecurity:getContainerInstanceVolumeSecurity": { "properties": { "auth": { "type": "string", "description": "NFS authentication type to be used. Currently, only auth type SYS is supported.\n" }, "isEncryptedInTransit": { "type": "boolean", "description": "Determines whether in-transit encryption needs to be enables. Check https://docs.oracle.com/en-us/iaas/Content/File/Tasks/intransitencryption.htm#Using_Intransit_Encryption for more details.\n" } }, "type": "object", "required": [ "auth", "isEncryptedInTransit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollection:getContainerInstancesContainerInstanceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItem:getContainerInstancesContainerInstanceCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItem:getContainerInstancesContainerInstanceCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, "containerCount": { "type": "integer", "description": "The number of containers on the container instance.\n" }, "containerRestartPolicy": { "type": "string", "description": "The container restart policy is applied for all containers in container instance.\n" }, "containers": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainer:getContainerInstancesContainerInstanceCollectionItemContainer" }, "description": "The containers on the container instance.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "dnsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemDnsConfig:getContainerInstancesContainerInstanceCollectionItemDnsConfig" }, "description": "DNS settings for containers.\n" }, "faultDomain": { "type": "string", "description": "The fault domain to place the container instance.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "gracefulShutdownTimeoutInSeconds": { "type": "string", "description": "The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.\n" }, "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target.\n" }, "imagePullSecrets": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemImagePullSecret:getContainerInstancesContainerInstanceCollectionItemImagePullSecret" }, "description": "The image pulls secrets so you can access private registry to pull container images.\n" }, "lifecycleDetails": { "type": "string", "description": "A message that describes the current state of the container in more detail. Can be used to provide actionable information.\n" }, "securityContexts": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemSecurityContext:getContainerInstancesContainerInstanceCollectionItemSecurityContext" }, "description": "Security context for all containers in a container instance.\n" }, "shape": { "type": "string", "description": "The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemShapeConfig:getContainerInstancesContainerInstanceCollectionItemShapeConfig" }, "description": "The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`.\n" }, "tenantId": { "type": "string", "description": "TenantId id of the container instance.\n" }, "timeCreated": { "type": "string", "description": "The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "timeUpdated": { "type": "string", "description": "The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "vnics": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVnic:getContainerInstancesContainerInstanceCollectionItemVnic" }, "description": "The virtual networks available to the containers in the container instance.\n" }, "volumeCount": { "type": "integer", "description": "The number of volumes that are attached to the container instance.\n" }, "volumes": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolume:getContainerInstancesContainerInstanceCollectionItemVolume" }, "description": "A volume is a directory with data that is accessible across multiple containers in a container instance.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "containerCount", "containerRestartPolicy", "containers", "definedTags", "displayName", "dnsConfigs", "faultDomain", "freeformTags", "gracefulShutdownTimeoutInSeconds", "id", "imagePullSecrets", "lifecycleDetails", "securityContexts", "shape", "shapeConfigs", "state", "systemTags", "tenantId", "timeCreated", "timeUpdated", "vnics", "volumeCount", "volumes" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainer:getContainerInstancesContainerInstanceCollectionItemContainer": { "properties": { "arguments": { "type": "array", "items": { "type": "string" } }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "commands": { "type": "array", "items": { "type": "string" } }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.\n" }, "containerId": { "type": "string", "description": "The OCID of the container.\n" }, "containerInstanceId": { "type": "string" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "environmentVariables": { "type": "object", "additionalProperties": { "type": "string" } }, "exitCode": { "type": "integer" }, "faultDomain": { "type": "string", "description": "The fault domain to place the container instance.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "healthChecks": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerHealthCheck:getContainerInstancesContainerInstanceCollectionItemContainerHealthCheck" } }, "imageUrl": { "type": "string" }, "isResourcePrincipalDisabled": { "type": "boolean" }, "lifecycleDetails": { "type": "string", "description": "A message that describes the current state of the container in more detail. Can be used to provide actionable information.\n" }, "resourceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerResourceConfig:getContainerInstancesContainerInstanceCollectionItemContainerResourceConfig" } }, "securityContexts": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerSecurityContext:getContainerInstancesContainerInstanceCollectionItemContainerSecurityContext" }, "description": "Security context for all containers in a container instance.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`.\n" }, "timeCreated": { "type": "string", "description": "The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "timeTerminated": { "type": "string" }, "timeUpdated": { "type": "string", "description": "The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).\n" }, "volumeMounts": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerVolumeMount:getContainerInstancesContainerInstanceCollectionItemContainerVolumeMount" } }, "workingDirectory": { "type": "string" } }, "type": "object", "required": [ "arguments", "availabilityDomain", "commands", "compartmentId", "containerId", "containerInstanceId", "definedTags", "displayName", "environmentVariables", "exitCode", "faultDomain", "freeformTags", "healthChecks", "imageUrl", "isResourcePrincipalDisabled", "lifecycleDetails", "resourceConfigs", "securityContexts", "state", "systemTags", "timeCreated", "timeTerminated", "timeUpdated", "volumeMounts", "workingDirectory" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerHealthCheck:getContainerInstancesContainerInstanceCollectionItemContainerHealthCheck": { "properties": { "failureAction": { "type": "string" }, "failureThreshold": { "type": "integer" }, "headers": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerHealthCheckHeader:getContainerInstancesContainerInstanceCollectionItemContainerHealthCheckHeader" } }, "healthCheckType": { "type": "string" }, "initialDelayInSeconds": { "type": "integer" }, "intervalInSeconds": { "type": "integer" }, "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "path": { "type": "string", "description": "(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.\n" }, "port": { "type": "integer" }, "status": { "type": "string" }, "statusDetails": { "type": "string" }, "successThreshold": { "type": "integer" }, "timeoutInSeconds": { "type": "integer" } }, "type": "object", "required": [ "failureAction", "failureThreshold", "headers", "healthCheckType", "initialDelayInSeconds", "intervalInSeconds", "name", "path", "port", "status", "statusDetails", "successThreshold", "timeoutInSeconds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerHealthCheckHeader:getContainerInstancesContainerInstanceCollectionItemContainerHealthCheckHeader": { "properties": { "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "value": { "type": "string", "description": "The value of the mount option.\n" } }, "type": "object", "required": [ "name", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerResourceConfig:getContainerInstancesContainerInstanceCollectionItemContainerResourceConfig": { "properties": { "memoryLimitInGbs": { "type": "number" }, "vcpusLimit": { "type": "number" } }, "type": "object", "required": [ "memoryLimitInGbs", "vcpusLimit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerSecurityContext:getContainerInstancesContainerInstanceCollectionItemContainerSecurityContext": { "properties": { "capabilities": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerSecurityContextCapability:getContainerInstancesContainerInstanceCollectionItemContainerSecurityContextCapability" } }, "isNonRootUserCheckEnabled": { "type": "boolean" }, "isRootFileSystemReadonly": { "type": "boolean" }, "runAsGroup": { "type": "integer" }, "runAsUser": { "type": "integer" }, "securityContextType": { "type": "string", "description": "The type of security context\n" } }, "type": "object", "required": [ "capabilities", "isNonRootUserCheckEnabled", "isRootFileSystemReadonly", "runAsGroup", "runAsUser", "securityContextType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerSecurityContextCapability:getContainerInstancesContainerInstanceCollectionItemContainerSecurityContextCapability": { "properties": { "addCapabilities": { "type": "array", "items": { "type": "string" } }, "dropCapabilities": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "addCapabilities", "dropCapabilities" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemContainerVolumeMount:getContainerInstancesContainerInstanceCollectionItemContainerVolumeMount": { "properties": { "isReadOnly": { "type": "boolean" }, "mountPath": { "type": "string" }, "partition": { "type": "integer" }, "subPath": { "type": "string" }, "volumeName": { "type": "string" } }, "type": "object", "required": [ "isReadOnly", "mountPath", "partition", "subPath", "volumeName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemDnsConfig:getContainerInstancesContainerInstanceCollectionItemDnsConfig": { "properties": { "nameservers": { "type": "array", "items": { "type": "string" }, "description": "IP address of the name server..\n" }, "options": { "type": "array", "items": { "type": "string" }, "description": "Options allows certain internal resolver variables to be modified.\n" }, "searches": { "type": "array", "items": { "type": "string" }, "description": "Search list for hostname lookup.\n" } }, "type": "object", "required": [ "nameservers", "options", "searches" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemImagePullSecret:getContainerInstancesContainerInstanceCollectionItemImagePullSecret": { "properties": { "password": { "type": "string", "secret": true }, "registryEndpoint": { "type": "string", "description": "The registry endpoint of the container image.\n" }, "secretId": { "type": "string", "description": "The OCID of the secret for registry credentials.\n" }, "secretType": { "type": "string", "description": "The type of ImagePullSecret.\n" }, "username": { "type": "string" } }, "type": "object", "required": [ "password", "registryEndpoint", "secretId", "secretType", "username" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemSecurityContext:getContainerInstancesContainerInstanceCollectionItemSecurityContext": { "properties": { "fsGroup": { "type": "integer", "description": "A special supplemental group that applies to all containers in the container instance. Some volume types allow the container instance to change ownership of the volume. The owning GID will be the fsGroup, the setgid bit will be set (new files will be owned by the fsGroup), and the permission bits are OR'd with rw-rw----. If unset, the container instance will not modify the ownership and permissions of volumes.\n" }, "fsGroupChangePolicy": { "type": "string", "description": "Defines behavior of changing ownership and permission of the volume before being exposed inside the containers. This only applies to volumes which support fsGroup ownership and permissions, and will have no effect on ephemeral volumes. ON_ROOT_MISMATCH only changes permissions and ownership if the permission and ownership of the root directory does not match the expected permissions and ownership of the volume. This can improve container instance start times. ALWAYS changes permission and ownership of the volume when it is mounted. If unset, ALWAYS is used.\n" }, "securityContextType": { "type": "string", "description": "The type of security context\n" } }, "type": "object", "required": [ "fsGroup", "fsGroupChangePolicy", "securityContextType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemShapeConfig:getContainerInstancesContainerInstanceCollectionItemShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the container instance, in gigabytes.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "The networking bandwidth available to the container instance, in gigabits per second.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the container instance.\n" }, "processorDescription": { "type": "string", "description": "A short description of the container instance's processor (CPU).\n" } }, "type": "object", "required": [ "memoryInGbs", "networkingBandwidthInGbps", "ocpus", "processorDescription" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVnic:getContainerInstancesContainerInstanceCollectionItemVnic": { "properties": { "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the entire display name given.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`\n" }, "hostnameLabel": { "type": "string" }, "isPublicIpAssigned": { "type": "boolean" }, "nsgIds": { "type": "array", "items": { "type": "string" } }, "privateIp": { "type": "string" }, "skipSourceDestCheck": { "type": "boolean" }, "subnetId": { "type": "string", "description": "Specifies the network interface to be used for the Oracle Cloud Infrastructure File Storage Service (FSS) volume. This is a required parameter when a Container Instance is attached to more than one subnets.\n" }, "vnicId": { "type": "string", "description": "The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.\n" } }, "type": "object", "required": [ "definedTags", "displayName", "freeformTags", "hostnameLabel", "isPublicIpAssigned", "nsgIds", "privateIp", "skipSourceDestCheck", "subnetId", "vnicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolume:getContainerInstancesContainerInstanceCollectionItemVolume": { "properties": { "backingStore": { "type": "string", "description": "The volume type of the empty directory, can be either File Storage or Memory.\n" }, "configs": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeConfig:getContainerInstancesContainerInstanceCollectionItemVolumeConfig" }, "description": "Contains string key value pairs which can be mounted as individual files inside the container. The value needs to be base64 encoded. It is decoded to plain text before the mount.\n" }, "exports": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeExport:getContainerInstancesContainerInstanceCollectionItemVolumeExport" }, "description": "An Oracle Cloud Infrastructure File Storage Service (FSS) Export. Check https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/Export/ for more details.\n" }, "mountCommands": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeMountCommand:getContainerInstancesContainerInstanceCollectionItemVolumeMountCommand" }, "description": "Specifications for the mount command to mount the Oracle Cloud Infrastructure File Storage Service (FSS) File System to Containers.\n" }, "mountTargets": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeMountTarget:getContainerInstancesContainerInstanceCollectionItemVolumeMountTarget" }, "description": "An Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target. Check https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/MountTarget for more details.\n" }, "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "securities": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeSecurity:getContainerInstancesContainerInstanceCollectionItemVolumeSecurity" }, "description": "Security options for Oracle Cloud Infrastructure FSS File System.\n" }, "subnetId": { "type": "string", "description": "Specifies the network interface to be used for the Oracle Cloud Infrastructure File Storage Service (FSS) volume. This is a required parameter when a Container Instance is attached to more than one subnets.\n" }, "volumeType": { "type": "string", "description": "The type of volume.\n" } }, "type": "object", "required": [ "backingStore", "configs", "exports", "mountCommands", "mountTargets", "name", "securities", "subnetId", "volumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeConfig:getContainerInstancesContainerInstanceCollectionItemVolumeConfig": { "properties": { "data": { "type": "string", "description": "The base64 encoded contents of the file. The contents are decoded to plain text before mounted as a file to a container inside container instance.\n" }, "fileName": { "type": "string", "description": "The name of the file. The fileName should be unique across the volume.\n" }, "path": { "type": "string", "description": "(Optional) Relative path for this file inside the volume mount directory. By default, the file is presented at the root of the volume mount path.\n" } }, "type": "object", "required": [ "data", "fileName", "path" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeExport:getContainerInstancesContainerInstanceCollectionItemVolumeExport": { "properties": { "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target.\n" }, "ociFssExportType": { "type": "string", "description": "Determines the mode for supplying the Oracle Cloud Infrastructure File Storage Service (FSS) Export details. The value must be an OCID unless your tenancy is allowed to use PATH as a value.\n" } }, "type": "object", "required": [ "id", "ociFssExportType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeMountCommand:getContainerInstancesContainerInstanceCollectionItemVolumeMountCommand": { "properties": { "mountOptions": { "type": "array", "items": { "$ref": "#/types/oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeMountCommandMountOption:getContainerInstancesContainerInstanceCollectionItemVolumeMountCommandMountOption" }, "description": "List of mount options to be used in the mount command. The order of this array will be maintained while preparing the mount command.\n" } }, "type": "object", "required": [ "mountOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeMountCommandMountOption:getContainerInstancesContainerInstanceCollectionItemVolumeMountCommandMountOption": { "properties": { "option": { "type": "string", "description": "A generic (https://man7.org/linux/man-pages/man8/mount.8.html) or nfs (https://man7.org/linux/man-pages/man5/nfs.5.html) mount option.\n" }, "value": { "type": "string", "description": "The value of the mount option.\n" } }, "type": "object", "required": [ "option", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeMountTarget:getContainerInstancesContainerInstanceCollectionItemVolumeMountTarget": { "properties": { "id": { "type": "string", "description": "The OCID of the Oracle Cloud Infrastructure File Storage Service (FSS) Mount Target.\n" }, "ociFssMountTargetType": { "type": "string", "description": "Determines the mode for supplying the Oracle Cloud Infrastructure File Storage Service (FSS) Mount target details. The value must be an OCID unless your tenancy is allowed to use HOST as a value.\n" } }, "type": "object", "required": [ "id", "ociFssMountTargetType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesContainerInstanceCollectionItemVolumeSecurity:getContainerInstancesContainerInstanceCollectionItemVolumeSecurity": { "properties": { "auth": { "type": "string", "description": "NFS authentication type to be used. Currently, only auth type SYS is supported.\n" }, "isEncryptedInTransit": { "type": "boolean", "description": "Determines whether in-transit encryption needs to be enables. Check https://docs.oracle.com/en-us/iaas/Content/File/Tasks/intransitencryption.htm#Using_Intransit_Encryption for more details.\n" } }, "type": "object", "required": [ "auth", "isEncryptedInTransit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:ContainerInstances/getContainerInstancesFilter:getContainerInstancesFilter": { "properties": { "name": { "type": "string", "description": "The name of the volume. This must be unique within a single container instance.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/BootVolumeAutotunePolicy:BootVolumeAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "(Updatable) This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "(Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType" ], "language": { "nodejs": { "requiredOutputs": [ "autotuneType", "maxVpusPerGb" ] } } }, "oci:Core/BootVolumeBackupSourceDetails:BootVolumeBackupSourceDetails": { "properties": { "bootVolumeBackupId": { "type": "string", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.\n", "willReplaceOnChanges": true }, "region": { "type": "string", "description": "The region of the volume backup source.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "bootVolumeBackupId", "region" ] }, "oci:Core/BootVolumeBootVolumeReplica:BootVolumeBootVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1`\n" }, "bootVolumeReplicaId": { "type": "string", "description": "The boot volume replica's Oracle ID (OCID).\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "kmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n" }, "xrrKmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Vault service key which is the master encryption key for the cross region boot volume replicas, which will be used in the destination region to encrypt the boot volume replica's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "bootVolumeReplicaId", "displayName", "kmsKeyId", "xrrKmsKeyId" ] } } }, "oci:Core/BootVolumeSourceDetails:BootVolumeSourceDetails": { "properties": { "changeBlockSizeInBytes": { "type": "string", "description": "Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).\n", "willReplaceOnChanges": true }, "firstBackupId": { "type": "string", "description": "The OCID of the first boot volume backup.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "The OCID of the boot volume replica.\n", "willReplaceOnChanges": true }, "secondBackupId": { "type": "string", "description": "The OCID of the second boot volume backup.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "oci:Core/ByoasnByoipRange:ByoasnByoipRange": { "properties": { "asPathPrependLength": { "type": "integer", "description": "The as path prepend length.\n" }, "byoipRangeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.\n" }, "cidrBlock": { "type": "string", "description": "The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.\n" }, "ipv6cidrBlock": { "type": "string", "description": "The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "asPathPrependLength", "byoipRangeId", "cidrBlock", "ipv6cidrBlock" ] } } }, "oci:Core/CaptureFilterFlowLogCaptureFilterRule:CaptureFilterFlowLogCaptureFilterRule": { "properties": { "destinationCidr": { "type": "string", "description": "(Updatable) Traffic to this CIDR will be captured in the flow log.\n" }, "flowLogType": { "type": "string", "description": "(Updatable) Type or types of flow logs to store. `ALL` includes records for both accepted traffic and rejected traffic.\n" }, "icmpOptions": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleIcmpOptions:CaptureFilterFlowLogCaptureFilterRuleIcmpOptions", "description": "(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n\nIf you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify multiple codes for a single type, create a separate security list rule for each.\n" }, "isEnabled": { "type": "boolean", "description": "(Updatable) Indicates whether a flow log capture filter rule is enabled.\n" }, "priority": { "type": "integer", "description": "(Updatable) A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority.\n" }, "protocol": { "type": "string", "description": "(Updatable) The transport protocol the filter uses.\n" }, "ruleAction": { "type": "string", "description": "(Updatable) Include or exclude a ruleAction object.\n" }, "samplingRate": { "type": "integer", "description": "(Updatable) Sampling interval as 1 of X, where X is an integer not greater than 100000.\n" }, "sourceCidr": { "type": "string", "description": "(Updatable) Traffic from this CIDR will be captured in the flow log.\n" }, "tcpOptions": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleTcpOptions:CaptureFilterFlowLogCaptureFilterRuleTcpOptions", "description": "(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "udpOptions": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleUdpOptions:CaptureFilterFlowLogCaptureFilterRuleUdpOptions", "description": "(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationCidr", "flowLogType", "icmpOptions", "isEnabled", "priority", "protocol", "ruleAction", "samplingRate", "sourceCidr", "tcpOptions", "udpOptions" ] } } }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleIcmpOptions:CaptureFilterFlowLogCaptureFilterRuleIcmpOptions": { "properties": { "code": { "type": "integer", "description": "(Updatable) The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "(Updatable) The ICMP type.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "code", "type" ] } } }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleTcpOptions:CaptureFilterFlowLogCaptureFilterRuleTcpOptions": { "properties": { "destinationPortRange": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleTcpOptionsDestinationPortRange:CaptureFilterFlowLogCaptureFilterRuleTcpOptionsDestinationPortRange", "description": "(Updatable)\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleTcpOptionsSourcePortRange:CaptureFilterFlowLogCaptureFilterRuleTcpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationPortRange", "sourcePortRange" ] } } }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleTcpOptionsDestinationPortRange:CaptureFilterFlowLogCaptureFilterRuleTcpOptionsDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleTcpOptionsSourcePortRange:CaptureFilterFlowLogCaptureFilterRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleUdpOptions:CaptureFilterFlowLogCaptureFilterRuleUdpOptions": { "properties": { "destinationPortRange": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleUdpOptionsDestinationPortRange:CaptureFilterFlowLogCaptureFilterRuleUdpOptionsDestinationPortRange", "description": "(Updatable)\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/CaptureFilterFlowLogCaptureFilterRuleUdpOptionsSourcePortRange:CaptureFilterFlowLogCaptureFilterRuleUdpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationPortRange", "sourcePortRange" ] } } }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleUdpOptionsDestinationPortRange:CaptureFilterFlowLogCaptureFilterRuleUdpOptionsDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterFlowLogCaptureFilterRuleUdpOptionsSourcePortRange:CaptureFilterFlowLogCaptureFilterRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterVtapCaptureFilterRule:CaptureFilterVtapCaptureFilterRule": { "properties": { "destinationCidr": { "type": "string", "description": "(Updatable) Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.\n" }, "icmpOptions": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleIcmpOptions:CaptureFilterVtapCaptureFilterRuleIcmpOptions", "description": "(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n\nIf you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify multiple codes for a single type, create a separate security list rule for each.\n" }, "protocol": { "type": "string", "description": "(Updatable) The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:\n* 1 = ICMP\n* 6 = TCP\n* 17 = UDP\n" }, "ruleAction": { "type": "string", "description": "(Updatable) Include or exclude packets meeting this definition from mirrored traffic.\n" }, "sourceCidr": { "type": "string", "description": "(Updatable) Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.\n" }, "tcpOptions": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleTcpOptions:CaptureFilterVtapCaptureFilterRuleTcpOptions", "description": "(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "trafficDirection": { "type": "string", "description": "(Updatable) The traffic direction the VTAP is configured to mirror.\n" }, "udpOptions": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleUdpOptions:CaptureFilterVtapCaptureFilterRuleUdpOptions", "description": "(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "trafficDirection" ], "language": { "nodejs": { "requiredOutputs": [ "destinationCidr", "icmpOptions", "protocol", "ruleAction", "sourceCidr", "tcpOptions", "trafficDirection", "udpOptions" ] } } }, "oci:Core/CaptureFilterVtapCaptureFilterRuleIcmpOptions:CaptureFilterVtapCaptureFilterRuleIcmpOptions": { "properties": { "code": { "type": "integer", "description": "(Updatable) The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "(Updatable) The ICMP type.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "code", "type" ] } } }, "oci:Core/CaptureFilterVtapCaptureFilterRuleTcpOptions:CaptureFilterVtapCaptureFilterRuleTcpOptions": { "properties": { "destinationPortRange": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange:CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange", "description": "(Updatable)\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange:CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationPortRange", "sourcePortRange" ] } } }, "oci:Core/CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange:CaptureFilterVtapCaptureFilterRuleTcpOptionsDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange:CaptureFilterVtapCaptureFilterRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterVtapCaptureFilterRuleUdpOptions:CaptureFilterVtapCaptureFilterRuleUdpOptions": { "properties": { "destinationPortRange": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange:CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange", "description": "(Updatable)\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange:CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationPortRange", "sourcePortRange" ] } } }, "oci:Core/CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange:CaptureFilterVtapCaptureFilterRuleUdpOptionsDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange:CaptureFilterVtapCaptureFilterRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/ClusterNetworkClusterConfiguration:ClusterNetworkClusterConfiguration": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island.\n", "willReplaceOnChanges": true }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of network block OCIDs.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "hpcIslandId" ], "language": { "nodejs": { "requiredOutputs": [ "hpcIslandId", "networkBlockIds" ] } } }, "oci:Core/ClusterNetworkInstancePool:ClusterNetworkInstancePool": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance pool.\n" }, "currentSize": { "type": "integer", "description": "Count of instance in running state associated to the Instance Pool.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instanceConfigurationId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool.\n" }, "instanceDisplayNameFormatter": { "type": "string" }, "instanceHostnameFormatter": { "type": "string" }, "loadBalancers": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkInstancePoolLoadBalancer:ClusterNetworkInstancePoolLoadBalancer" }, "description": "The load balancers attached to the instance pool.\n" }, "placementConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkInstancePoolPlacementConfiguration:ClusterNetworkInstancePoolPlacementConfiguration" }, "description": "The placement configurations for the instance pool.\n" }, "poolType": { "type": "string", "description": "The type of resources managed by the pool.\n" }, "size": { "type": "integer", "description": "(Updatable) The number of instances that should be in the instance pool.\n" }, "state": { "type": "string", "description": "The current state of the cluster network.\n" }, "timeCreated": { "type": "string", "description": "The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "instanceConfigurationId", "size" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "currentSize", "definedTags", "displayName", "freeformTags", "id", "instanceConfigurationId", "instanceDisplayNameFormatter", "instanceHostnameFormatter", "loadBalancers", "placementConfigurations", "poolType", "size", "state", "timeCreated" ] } } }, "oci:Core/ClusterNetworkInstancePoolLoadBalancer:ClusterNetworkInstancePoolLoadBalancer": { "properties": { "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment.\n" }, "loadBalancerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool.\n" }, "port": { "type": "integer", "description": "The port value used for the backends.\n" }, "state": { "type": "string", "description": "The current state of the cluster network.\n" }, "vnicSelection": { "type": "string", "description": "Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "backendSetName", "id", "instancePoolId", "loadBalancerId", "port", "state", "vnicSelection" ] } } }, "oci:Core/ClusterNetworkInstancePoolPlacementConfiguration:ClusterNetworkInstancePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domains to place instances.\n" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet:ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet:ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "computeClusterId", "faultDomains", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ] } } }, "oci:Core/ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet:ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ] } } }, "oci:Core/ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6subnetCidr" ] } } }, "oci:Core/ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet:ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ] } } }, "oci:Core/ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6subnetCidr" ] } } }, "oci:Core/ClusterNetworkPlacementConfiguration:ClusterNetworkPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "placementConstraint": { "type": "string", "willReplaceOnChanges": true }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n", "willReplaceOnChanges": true }, "primaryVnicSubnets": { "$ref": "#/types/oci:Core/ClusterNetworkPlacementConfigurationPrimaryVnicSubnets:ClusterNetworkPlacementConfigurationPrimaryVnicSubnets", "description": "Details about the IPv6 primary subnet.\n", "willReplaceOnChanges": true }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkPlacementConfigurationSecondaryVnicSubnet:ClusterNetworkPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "placementConstraint", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ] } } }, "oci:Core/ClusterNetworkPlacementConfigurationPrimaryVnicSubnets:ClusterNetworkPlacementConfigurationPrimaryVnicSubnets": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n", "willReplaceOnChanges": true }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ] } } }, "oci:Core/ClusterNetworkPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6subnetCidr" ] } } }, "oci:Core/ClusterNetworkPlacementConfigurationSecondaryVnicSubnet:ClusterNetworkPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.\n", "willReplaceOnChanges": true }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/ClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n", "willReplaceOnChanges": true }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ] } } }, "oci:Core/ClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:ClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6subnetCidr" ] } } }, "oci:Core/ComputeCapacityReportShapeAvailability:ComputeCapacityReportShapeAvailability": { "properties": { "availabilityStatus": { "type": "string", "description": "A flag denoting whether capacity is available.\n" }, "availableCount": { "type": "string", "description": "The total number of new instances that can be created with the specified shape configuration.\n" }, "faultDomain": { "type": "string", "description": "The fault domain for the capacity report.\n\nIf you do not specify a fault domain, the capacity report includes information about all fault domains.\n", "willReplaceOnChanges": true }, "instanceShape": { "type": "string", "description": "The shape that you want to request a capacity report for. You can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes).\n", "willReplaceOnChanges": true }, "instanceShapeConfig": { "$ref": "#/types/oci:Core/ComputeCapacityReportShapeAvailabilityInstanceShapeConfig:ComputeCapacityReportShapeAvailabilityInstanceShapeConfig", "description": "The shape configuration for a shape in a capacity report.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceShape" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityStatus", "availableCount", "faultDomain", "instanceShape", "instanceShapeConfig" ] } } }, "oci:Core/ComputeCapacityReportShapeAvailabilityInstanceShapeConfig:ComputeCapacityReportShapeAvailabilityInstanceShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n\nThe following values are supported:\n* `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.\n* `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.\n* `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.\n", "willReplaceOnChanges": true }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n", "willReplaceOnChanges": true }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage.\n", "willReplaceOnChanges": true }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "memoryInGbs", "nvmes", "ocpus" ] } } }, "oci:Core/ComputeCapacityReservationInstanceReservationConfig:ComputeCapacityReservationInstanceReservationConfig": { "properties": { "clusterConfig": { "$ref": "#/types/oci:Core/ComputeCapacityReservationInstanceReservationConfigClusterConfig:ComputeCapacityReservationInstanceReservationConfigClusterConfig", "description": "(Updatable) The HPC cluster configuration requested when launching instances in a compute capacity reservation.\n\nIf the parameter is provided, the reservation is created with the HPC island and a list of HPC blocks that you specify. If a list of HPC blocks are missing or not provided, the reservation is created with any HPC blocks in the HPC island that you specify. If the values of HPC island or HPC block that you provide are not valid, an error is returned.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "(Updatable) The OCID of the cluster placement group for this instance reservation capacity configuration.\n" }, "faultDomain": { "type": "string", "description": "(Updatable) The fault domain to use for instances created using this capacity configuration. For more information, see [Fault Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm#fault). If you do not specify the fault domain, the capacity is available for an instance that does not specify a fault domain. To change the fault domain for a reservation, delete the reservation and create a new one in the preferred fault domain.\n\nTo retrieve a list of fault domains, use the `ListFaultDomains` operation in the [Identity and Access Management Service API](https://www.terraform.io/iaas/api/#/en/identity/20160918/).\n\nExample: `FAULT-DOMAIN-1`\n" }, "instanceShape": { "type": "string", "description": "(Updatable) The shape requested when launching instances using reserved capacity. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).\n" }, "instanceShapeConfig": { "$ref": "#/types/oci:Core/ComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig:ComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig", "description": "(Updatable) The shape configuration requested when launching instances in a compute capacity reservation.\n\nIf the parameter is provided, the reservation is created with the resources that you specify. If some properties are missing or the parameter is not provided, the reservation is created with the default configuration values for the \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e that you specify.\n\nEach shape only supports certain configurable values. If the values that you provide are not valid for the specified \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e, an error is returned.\n\nFor more information about customizing the resources that are allocated to flexible shapes, see [Flexible Shapes](https://docs.cloud.oracle.com/iaas/Content/Compute/References/computeshapes.htm#flexible).\n" }, "reservedCount": { "type": "string", "description": "(Updatable) The total number of instances that can be launched from the capacity configuration.\n" }, "usedCount": { "type": "string", "description": "The amount of capacity in use out of the total capacity reserved in this capacity configuration.\n" } }, "type": "object", "required": [ "instanceShape", "reservedCount" ], "language": { "nodejs": { "requiredOutputs": [ "clusterConfig", "instanceShape", "instanceShapeConfig", "reservedCount", "usedCount" ] } } }, "oci:Core/ComputeCapacityReservationInstanceReservationConfigClusterConfig:ComputeCapacityReservationInstanceReservationConfigClusterConfig": { "properties": { "hpcIslandId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island.\n" }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The list of OCIDs of the network blocks.\n" } }, "type": "object", "required": [ "hpcIslandId" ], "language": { "nodejs": { "requiredOutputs": [ "hpcIslandId", "networkBlockIds" ] } } }, "oci:Core/ComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig:ComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "(Updatable) The total amount of memory available to the instance, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "(Updatable) The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "memoryInGbs", "ocpus", "resourceManagement" ] } } }, "oci:Core/ComputeCapacityTopologyCapacitySource:ComputeCapacityTopologyCapacitySource": { "properties": { "capacityType": { "type": "string", "description": "(Updatable) The capacity type of bare metal hosts.\n" }, "compartmentId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment of this capacity source.\n" } }, "type": "object", "required": [ "capacityType" ], "language": { "nodejs": { "requiredOutputs": [ "capacityType", "compartmentId" ] } } }, "oci:Core/ComputeClusterPlacementConstraintDetails:ComputeClusterPlacementConstraintDetails": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island for the compute cluster.\n\nThis field cannot be updated after creation of the compute cluster.\n", "willReplaceOnChanges": true }, "logicalPlacementConstraint": { "type": "string", "description": "The logical placement strategy to apply. Allowed values are `SINGLE_TIER`, `SINGLE_BLOCK`, and `PACKED_DISTRIBUTION_MULTI_BLOCK`.\n" }, "targetMemoryFabricIds": { "type": "array", "items": { "type": "string" }, "description": "The list of target GPU memory fabric OCIDs to constrain placement. Up to 15 items are allowed.\n\nIf GMFs are passed in, the `hpcIslandId` must be set on the compute cluster, and the provided GMFs must belong to that same HPC island.\n\nThe ordering of the array will be preserved. Ensure that all items in the array are unique.\n" }, "targetNetworkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of target network block OCIDs to constrain placement. Up to 15 items are allowed.\n\nIf `targetNetworkBlockIds` is provided, the `hpcIslandId` must be set on the compute cluster, and the provided network blocks must belong to that same HPC island.\n\nThe ordering of the array will be preserved. Ensure that all items in the array are unique.\n" }, "type": { "type": "string", "description": "(Updatable) The type for the placement constraints. Supported value: `COMPUTE_CLUSTER`.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "logicalPlacementConstraint", "type" ] } } }, "oci:Core/ComputeGpuMemoryClusterGpuMemoryClusterScaleConfig:ComputeGpuMemoryClusterGpuMemoryClusterScaleConfig": { "properties": { "isDownsizeEnabled": { "type": "boolean", "description": "(Updatable) Enables downsizing towards the target size.\n" }, "isUpsizeEnabled": { "type": "boolean", "description": "(Updatable) Enables upsizing towards the target size.\n" }, "targetSize": { "type": "string", "description": "(Updatable) The configured target size for the GPU Memory Cluster.\n" } }, "type": "object", "required": [ "isUpsizeEnabled" ], "language": { "nodejs": { "requiredOutputs": [ "isDownsizeEnabled", "isUpsizeEnabled", "targetSize" ] } } }, "oci:Core/ComputeGpuMemoryFabricMemoryFabricPreferences:ComputeGpuMemoryFabricMemoryFabricPreferences": { "properties": { "customerDesiredFirmwareBundleId": { "type": "string", "description": "(Updatable) The desired firmware bundle id on the GPU memory fabric.\n" }, "fabricRecycleLevel": { "type": "string", "description": "(Updatable) The recycle level of GPU memory fabric. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customerDesiredFirmwareBundleId", "fabricRecycleLevel" ] } } }, "oci:Core/ComputeHostConfigurationData:ComputeHostConfigurationData": { "properties": { "checkDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/ComputeHostConfigurationDataCheckDetail:ComputeHostConfigurationDataCheckDetail" }, "description": "Compute Host Group Configuration Details Check\n" }, "timeLastApply": { "type": "string", "description": "The time that was last applied.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "checkDetails", "timeLastApply" ] } } }, "oci:Core/ComputeHostConfigurationDataCheckDetail:ComputeHostConfigurationDataCheckDetail": { "properties": { "configurationState": { "type": "string", "description": "Configuration state of the Compute Bare Metal Host.\n" }, "firmwareBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host.\n" }, "recycleLevel": { "type": "string", "description": "Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" }, "type": { "type": "string", "description": "The type of configuration\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configurationState", "firmwareBundleId", "recycleLevel", "type" ] } } }, "oci:Core/ComputeHostGroupConfiguration:ComputeHostGroupConfiguration": { "properties": { "firmwareBundleId": { "type": "string", "description": "(Updatable) The OCID for firmware bundle\n" }, "recycleLevel": { "type": "string", "description": "(Updatable) Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" }, "state": { "type": "string", "description": "(Updatable) The state of the host group configuration.\n" }, "target": { "type": "string", "description": "(Updatable) Either the platform name or compute shape that the configuration is targeting\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "firmwareBundleId", "recycleLevel", "state", "target" ] } } }, "oci:Core/ComputeHostRecycleDetail:ComputeHostRecycleDetail": { "properties": { "computeHostGroupId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute host group this host was attached to at the time of recycle.\n" }, "recycleLevel": { "type": "string", "description": "Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "computeHostGroupId", "recycleLevel" ] } } }, "oci:Core/CrossConnectGroupMacsecProperties:CrossConnectGroupMacsecProperties": { "properties": { "encryptionCipher": { "type": "string", "description": "(Updatable) Type of encryption cipher suite to use for the MACsec connection.\n" }, "isUnprotectedTrafficAllowed": { "type": "boolean", "description": "(Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.\n" }, "primaryKey": { "$ref": "#/types/oci:Core/CrossConnectGroupMacsecPropertiesPrimaryKey:CrossConnectGroupMacsecPropertiesPrimaryKey", "description": "(Updatable) Defines the secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s held in Vault that represent the MACsec key.\n" }, "state": { "type": "string", "description": "(Updatable) Indicates whether or not MACsec is enabled.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "state" ], "language": { "nodejs": { "requiredOutputs": [ "encryptionCipher", "isUnprotectedTrafficAllowed", "primaryKey", "state" ] } } }, "oci:Core/CrossConnectGroupMacsecPropertiesPrimaryKey:CrossConnectGroupMacsecPropertiesPrimaryKey": { "properties": { "connectivityAssociationKeySecretId": { "type": "string", "description": "(Updatable) Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.\n" }, "connectivityAssociationKeySecretVersion": { "type": "string", "description": "(Updatable) The secret version of the \u003cspan pulumi-lang-nodejs=\"`connectivityAssociationKeySecretId`\" pulumi-lang-dotnet=\"`ConnectivityAssociationKeySecretId`\" pulumi-lang-go=\"`connectivityAssociationKeySecretId`\" pulumi-lang-python=\"`connectivity_association_key_secret_id`\" pulumi-lang-yaml=\"`connectivityAssociationKeySecretId`\" pulumi-lang-java=\"`connectivityAssociationKeySecretId`\" pulumi-lang-hcl=\"`connectivity_association_key_secret_id`\"\u003e`connectivityAssociationKeySecretId`\u003c/span\u003e secret in Vault.\n\nNOTE: Only the latest secret version will be used.\n" }, "connectivityAssociationNameSecretId": { "type": "string", "description": "(Updatable) Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.\n" }, "connectivityAssociationNameSecretVersion": { "type": "string", "description": "(Updatable) The secret version of the \u003cspan pulumi-lang-nodejs=\"`connectivityAssociationNameSecretId`\" pulumi-lang-dotnet=\"`ConnectivityAssociationNameSecretId`\" pulumi-lang-go=\"`connectivityAssociationNameSecretId`\" pulumi-lang-python=\"`connectivity_association_name_secret_id`\" pulumi-lang-yaml=\"`connectivityAssociationNameSecretId`\" pulumi-lang-java=\"`connectivityAssociationNameSecretId`\" pulumi-lang-hcl=\"`connectivity_association_name_secret_id`\"\u003e`connectivityAssociationNameSecretId`\u003c/span\u003e secret in Vault.\n\nNOTE: Only the latest secret version will be used.\n" } }, "type": "object", "required": [ "connectivityAssociationKeySecretId", "connectivityAssociationNameSecretId" ], "language": { "nodejs": { "requiredOutputs": [ "connectivityAssociationKeySecretId", "connectivityAssociationKeySecretVersion", "connectivityAssociationNameSecretId", "connectivityAssociationNameSecretVersion" ] } } }, "oci:Core/CrossConnectMacsecProperties:CrossConnectMacsecProperties": { "properties": { "encryptionCipher": { "type": "string", "description": "(Updatable) Type of encryption cipher suite to use for the MACsec connection.\n" }, "isUnprotectedTrafficAllowed": { "type": "boolean", "description": "(Updatable) Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.\n" }, "primaryKey": { "$ref": "#/types/oci:Core/CrossConnectMacsecPropertiesPrimaryKey:CrossConnectMacsecPropertiesPrimaryKey", "description": "(Updatable) Defines the secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s held in Vault that represent the MACsec key.\n" }, "state": { "type": "string", "description": "The cross-connect's current state.\n" } }, "type": "object", "required": [ "state" ], "language": { "nodejs": { "requiredOutputs": [ "encryptionCipher", "isUnprotectedTrafficAllowed", "primaryKey", "state" ] } } }, "oci:Core/CrossConnectMacsecPropertiesPrimaryKey:CrossConnectMacsecPropertiesPrimaryKey": { "properties": { "connectivityAssociationKeySecretId": { "type": "string", "description": "(Updatable) Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.\n" }, "connectivityAssociationKeySecretVersion": { "type": "string", "description": "The secret version of the `connectivityAssociationKey` secret in Vault.\n" }, "connectivityAssociationNameSecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.\n" }, "connectivityAssociationNameSecretVersion": { "type": "string", "description": "The secret version of the connectivity association name secret in Vault.\n" } }, "type": "object", "required": [ "connectivityAssociationKeySecretId", "connectivityAssociationNameSecretId" ], "language": { "nodejs": { "requiredOutputs": [ "connectivityAssociationKeySecretId", "connectivityAssociationKeySecretVersion", "connectivityAssociationNameSecretId", "connectivityAssociationNameSecretVersion" ] } } }, "oci:Core/DedicatedVmHostCapacityBin:DedicatedVmHostCapacityBin": { "properties": { "capacityIndex": { "type": "integer", "description": "Zero-based index for the corresponding capacity bucket.\n" }, "remainingLocalVolumeInGbs": { "type": "number", "description": "The current available local volume of the dedicated VM host, in GBs.\n" }, "remainingMemoryInGbs": { "type": "number", "description": "The current available memory of the dedicated VM host, in GBs.\n" }, "remainingOcpus": { "type": "number", "description": "The current available OCPUs of the dedicated VM host.\n" }, "supportedShapes": { "type": "array", "items": { "type": "string" }, "description": "List of VMI shapes supported on each capacity bucket.\n" }, "totalLocalVolumeInGbs": { "type": "number", "description": "The current total local volume of the dedicated VM host, in GBs.\n" }, "totalMemoryInGbs": { "type": "number", "description": "The current total memory of the dedicated VM host, in GBs.\n" }, "totalOcpus": { "type": "number", "description": "The current total OCPUs of the dedicated VM host.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "capacityIndex", "remainingLocalVolumeInGbs", "remainingMemoryInGbs", "remainingOcpus", "supportedShapes", "totalLocalVolumeInGbs", "totalMemoryInGbs", "totalOcpus" ] } } }, "oci:Core/DedicatedVmHostPlacementConstraintDetails:DedicatedVmHostPlacementConstraintDetails": { "properties": { "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host. This is only available for dedicated capacity customers.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type for the placement constraints. Use `COMPUTE_BARE_METAL_HOST` when specifying the compute bare metal host OCID. Use `HOST_GROUP` when specifying the compute host group OCID. \n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "computeBareMetalHostId", "type" ] } } }, "oci:Core/DefaultDhcpOptionsOption:DefaultDhcpOptionsOption": { "properties": { "customDnsServers": { "type": "array", "items": { "type": "string" } }, "searchDomainNames": { "type": "array", "items": { "type": "string" } }, "serverType": { "type": "string" }, "type": { "type": "string" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "searchDomainNames", "serverType", "type" ] } } }, "oci:Core/DefaultRouteTableRouteRule:DefaultRouteTableRouteRule": { "properties": { "cidrBlock": { "type": "string", "deprecationMessage": "The 'cidr_block' field has been deprecated. Please use 'destination' instead." }, "description": { "type": "string" }, "destination": { "type": "string" }, "destinationType": { "type": "string" }, "networkEntityId": { "type": "string" }, "routeType": { "type": "string" } }, "type": "object", "required": [ "networkEntityId" ], "language": { "nodejs": { "requiredOutputs": [ "cidrBlock", "description", "destination", "destinationType", "networkEntityId", "routeType" ] } } }, "oci:Core/DefaultSecurityListEgressSecurityRule:DefaultSecurityListEgressSecurityRule": { "properties": { "description": { "type": "string" }, "destination": { "type": "string" }, "destinationType": { "type": "string" }, "icmpOptions": { "$ref": "#/types/oci:Core/DefaultSecurityListEgressSecurityRuleIcmpOptions:DefaultSecurityListEgressSecurityRuleIcmpOptions" }, "protocol": { "type": "string" }, "stateless": { "type": "boolean" }, "tcpOptions": { "$ref": "#/types/oci:Core/DefaultSecurityListEgressSecurityRuleTcpOptions:DefaultSecurityListEgressSecurityRuleTcpOptions" }, "udpOptions": { "$ref": "#/types/oci:Core/DefaultSecurityListEgressSecurityRuleUdpOptions:DefaultSecurityListEgressSecurityRuleUdpOptions" } }, "type": "object", "required": [ "destination", "protocol" ], "language": { "nodejs": { "requiredOutputs": [ "description", "destination", "destinationType", "protocol", "stateless" ] } } }, "oci:Core/DefaultSecurityListEgressSecurityRuleIcmpOptions:DefaultSecurityListEgressSecurityRuleIcmpOptions": { "properties": { "code": { "type": "integer" }, "type": { "type": "integer" } }, "type": "object", "required": [ "type" ] }, "oci:Core/DefaultSecurityListEgressSecurityRuleTcpOptions:DefaultSecurityListEgressSecurityRuleTcpOptions": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" }, "sourcePortRange": { "$ref": "#/types/oci:Core/DefaultSecurityListEgressSecurityRuleTcpOptionsSourcePortRange:DefaultSecurityListEgressSecurityRuleTcpOptionsSourcePortRange" } }, "type": "object" }, "oci:Core/DefaultSecurityListEgressSecurityRuleTcpOptionsSourcePortRange:DefaultSecurityListEgressSecurityRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/DefaultSecurityListEgressSecurityRuleUdpOptions:DefaultSecurityListEgressSecurityRuleUdpOptions": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" }, "sourcePortRange": { "$ref": "#/types/oci:Core/DefaultSecurityListEgressSecurityRuleUdpOptionsSourcePortRange:DefaultSecurityListEgressSecurityRuleUdpOptionsSourcePortRange" } }, "type": "object" }, "oci:Core/DefaultSecurityListEgressSecurityRuleUdpOptionsSourcePortRange:DefaultSecurityListEgressSecurityRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/DefaultSecurityListIngressSecurityRule:DefaultSecurityListIngressSecurityRule": { "properties": { "description": { "type": "string" }, "icmpOptions": { "$ref": "#/types/oci:Core/DefaultSecurityListIngressSecurityRuleIcmpOptions:DefaultSecurityListIngressSecurityRuleIcmpOptions" }, "protocol": { "type": "string" }, "source": { "type": "string" }, "sourceType": { "type": "string" }, "stateless": { "type": "boolean" }, "tcpOptions": { "$ref": "#/types/oci:Core/DefaultSecurityListIngressSecurityRuleTcpOptions:DefaultSecurityListIngressSecurityRuleTcpOptions" }, "udpOptions": { "$ref": "#/types/oci:Core/DefaultSecurityListIngressSecurityRuleUdpOptions:DefaultSecurityListIngressSecurityRuleUdpOptions" } }, "type": "object", "required": [ "protocol", "source" ], "language": { "nodejs": { "requiredOutputs": [ "description", "protocol", "source", "sourceType" ] } } }, "oci:Core/DefaultSecurityListIngressSecurityRuleIcmpOptions:DefaultSecurityListIngressSecurityRuleIcmpOptions": { "properties": { "code": { "type": "integer" }, "type": { "type": "integer" } }, "type": "object", "required": [ "type" ] }, "oci:Core/DefaultSecurityListIngressSecurityRuleTcpOptions:DefaultSecurityListIngressSecurityRuleTcpOptions": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" }, "sourcePortRange": { "$ref": "#/types/oci:Core/DefaultSecurityListIngressSecurityRuleTcpOptionsSourcePortRange:DefaultSecurityListIngressSecurityRuleTcpOptionsSourcePortRange" } }, "type": "object" }, "oci:Core/DefaultSecurityListIngressSecurityRuleTcpOptionsSourcePortRange:DefaultSecurityListIngressSecurityRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/DefaultSecurityListIngressSecurityRuleUdpOptions:DefaultSecurityListIngressSecurityRuleUdpOptions": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" }, "sourcePortRange": { "$ref": "#/types/oci:Core/DefaultSecurityListIngressSecurityRuleUdpOptionsSourcePortRange:DefaultSecurityListIngressSecurityRuleUdpOptionsSourcePortRange" } }, "type": "object" }, "oci:Core/DefaultSecurityListIngressSecurityRuleUdpOptionsSourcePortRange:DefaultSecurityListIngressSecurityRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer" }, "min": { "type": "integer" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/DhcpOptionsOption:DhcpOptionsOption": { "properties": { "customDnsServers": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) If you set `serverType` to `CustomDnsServer`, specify the IP address of at least one DNS server of your choice (three maximum).\n" }, "searchDomainNames": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A single search domain name according to [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). During a DNS query, the OS will append this search domain name to the value being queried.\n\nIf you set [DhcpDnsOption](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DhcpDnsOption/) to `VcnLocalPlusInternet`, and you assign a DNS label to the VCN during creation, the search domain name in the VCN's default set of DHCP options is automatically set to the VCN domain (for example, `vcn1.oraclevcn.com`).\n\nIf you don't want to use a search domain name, omit this option from the set of DHCP options. Do not include this option with an empty list of search domain names, or with an empty string as the value for any search domain name.\n" }, "serverType": { "type": "string", "description": "(Updatable) \n* **VcnLocal:** Reserved for future use.\n* **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).\n* **CustomDnsServer:** Instances use a DNS server of your choice (three maximum).\n" }, "type": { "type": "string", "description": "(Updatable) The specific DHCP option. Either `DomainNameServer` (for [DhcpDnsOption](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DhcpDnsOption/)) or `SearchDomain` (for [DhcpSearchDomainOption](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DhcpSearchDomainOption/)).\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "searchDomainNames", "serverType", "type" ] } } }, "oci:Core/DrgAttachmentManagementNetworkDetails:DrgAttachmentManagementNetworkDetails": { "properties": { "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.\n" }, "ipsecConnectionId": { "type": "string", "description": "The IPSec connection that contains the attached IPSec tunnel.\n" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using.\n\nFor information about why you would associate a route table with a DRG attachment, see:\n* [Transit Routing: Access to Multiple VCNs in Same Region](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)\n* [Transit Routing: Private Access to Oracle Services](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)\n" }, "type": { "type": "string", "description": "The type can be one of these values: `IPSEC_TUNNEL`, `REMOTE_PEERING_CONNECTION`, `VCN`,`VIRTUAL_CIRCUIT`\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredOutputs": [ "id", "ipsecConnectionId", "routeTableId", "type" ] } } }, "oci:Core/DrgAttachmentNetworkDetails:DrgAttachmentNetworkDetails": { "properties": { "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.\n", "willReplaceOnChanges": true }, "ids": { "type": "array", "items": { "type": "string" }, "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target IPSec tunnel attachment.\n" }, "ipsecConnectionId": { "type": "string", "description": "The IPSec connection that contains the attached IPSec tunnel.\n" }, "routeTableId": { "type": "string", "description": "(Updatable) This is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table that is used to route the traffic as it enters a VCN through this attachment.\n\nFor information about why you would associate a route table with a DRG attachment, see [Advanced Scenario: Transit Routing](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm). For information about why you would associate a route table with a DRG attachment, see:\n* [Transit Routing: Access to Multiple VCNs in Same Region](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitrouting.htm)\n* [Transit Routing: Private Access to Oracle Services](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)\n" }, "transportAttachmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit's DRG attachment.\n" }, "transportOnlyMode": { "type": "boolean", "description": "Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "type": { "type": "string", "description": "(Updatable) The type can be one of these values: `IPSEC_TUNNEL`, `LOOPBACK`, `REMOTE_PEERING_CONNECTION`, `VCN`, `VIRTUAL_CIRCUIT`\n" }, "vcnRouteType": { "type": "string", "description": "(Updatable) Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "id", "ids", "ipsecConnectionId", "routeTableId", "transportAttachmentId", "transportOnlyMode", "type", "vcnRouteType" ] } } }, "oci:Core/DrgAttachmentsListDrgAllAttachment:DrgAttachmentsListDrgAllAttachment": { "properties": { "id": { "type": "string", "description": "The Oracle-assigned ID of the DRG attachment\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "id" ] } } }, "oci:Core/DrgDefaultDrgRouteTable:DrgDefaultDrgRouteTable": { "properties": { "ipsecTunnel": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table assigned to DRG attachments of type IPSEC_TUNNEL on creation.\n" }, "remotePeeringConnection": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type REMOTE_PEERING_CONNECTION on creation.\n" }, "vcn": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type VCN on creation.\n" }, "virtualCircuit": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type VIRTUAL_CIRCUIT on creation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipsecTunnel", "remotePeeringConnection", "vcn", "virtualCircuit" ] } } }, "oci:Core/DrgRouteDistributionStatementMatchCriteria:DrgRouteDistributionStatementMatchCriteria": { "properties": { "attachmentType": { "type": "string", "description": "The type of the network resource to be included in this match. A match for a network type implies that all DRG attachments of that type insert routes into the table.\n" }, "drgAttachmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment.\n" }, "matchType": { "type": "string", "description": "(Updatable) The type of the match criteria for a route distribution statement.\n" } }, "type": "object" }, "oci:Core/ImageAgentFeature:ImageAgentFeature": { "properties": { "isManagementSupported": { "type": "boolean", "description": "This attribute is not used.\n" }, "isMonitoringSupported": { "type": "boolean", "description": "This attribute is not used.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isManagementSupported", "isMonitoringSupported" ] } } }, "oci:Core/ImageImageSourceDetails:ImageImageSourceDetails": { "properties": { "bucketName": { "type": "string", "description": "The Object Storage bucket for the image.\n", "willReplaceOnChanges": true }, "namespaceName": { "type": "string", "description": "The Object Storage namespace for the image.\n", "willReplaceOnChanges": true }, "objectName": { "type": "string", "description": "The Object Storage name for the image.\n", "willReplaceOnChanges": true }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n", "willReplaceOnChanges": true }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n", "willReplaceOnChanges": true }, "sourceImageType": { "type": "string", "description": "The format of the image to be imported. Only monolithic images are supported. This attribute is not used for exported Oracle images with the Oracle Cloud Infrastructure image format. Allowed values are:\n* `QCOW2`\n* `VMDK`\n", "willReplaceOnChanges": true }, "sourceType": { "type": "string", "description": "The source type for the image. Use `objectStorageTuple` when specifying the namespace, bucket name, and object name. Use `objectStorageUri` when specifying the Object Storage URL.\n", "willReplaceOnChanges": true }, "sourceUri": { "type": "string", "description": "The Object Storage URL for the image.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sourceType" ] }, "oci:Core/ImageLaunchOption:ImageLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ] } } }, "oci:Core/InstanceAgentConfig:InstanceAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "(Updatable) Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n\nTo get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "isManagementDisabled": { "type": "boolean", "description": "(Updatable) Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n\nThese are the management plugins: OS Management Service Agent and Compute Instance Run Command.\n\nThe management plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.\n* If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of the per-plugin configuration.\n* If `isManagementDisabled` is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "(Updatable) Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n\nThese are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.\n\nThe monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.\n* If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.\n* If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceAgentConfigPluginsConfig:InstanceAgentConfigPluginsConfig" }, "description": "(Updatable) The configuration of plugins associated with this instance.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ] } } }, "oci:Core/InstanceAgentConfigPluginsConfig:InstanceAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "(Updatable) Whether the plugin should be enabled or disabled.\n\nTo enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false.\n" }, "name": { "type": "string", "description": "(Updatable) The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ] }, "oci:Core/InstanceAvailabilityConfig:InstanceAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "(Updatable) Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "(Updatable) The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isLiveMigrationPreferred", "recoveryAction" ] } } }, "oci:Core/InstanceConfigurationGmcConfigs:InstanceConfigurationGmcConfigs": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain for this GMC configuration entry.\n", "willReplaceOnChanges": true }, "compartmentId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with this GMC configuration entry.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "gpuMemoryClusterScaleConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationGmcConfigsGpuMemoryClusterScaleConfig:InstanceConfigurationGmcConfigsGpuMemoryClusterScaleConfig", "description": "Configuration settings for GPU Memory Cluster scaling.\n", "willReplaceOnChanges": true }, "instanceConfigurationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the base compute instance configuration associated with this GMC configuration entry.\n", "willReplaceOnChanges": true }, "size": { "type": "string", "description": "The desired number of instances for this GMC configuration entry.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "instanceConfigurationId" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "gpuMemoryClusterScaleConfig", "instanceConfigurationId", "size" ] } } }, "oci:Core/InstanceConfigurationGmcConfigsGpuMemoryClusterScaleConfig:InstanceConfigurationGmcConfigsGpuMemoryClusterScaleConfig": { "properties": { "isDownsizeEnabled": { "type": "boolean", "description": "Enables downsizing towards the target size.\n", "willReplaceOnChanges": true }, "isUpsizeEnabled": { "type": "boolean", "description": "Enables upsizing towards the target size.\n", "willReplaceOnChanges": true }, "targetSize": { "type": "string", "description": "The configured target size for the GPU Memory Cluster.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "isUpsizeEnabled" ], "language": { "nodejs": { "requiredOutputs": [ "isDownsizeEnabled", "isUpsizeEnabled", "targetSize" ] } } }, "oci:Core/InstanceConfigurationInstanceDetails:InstanceConfigurationInstanceDetails": { "properties": { "blockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsBlockVolume:InstanceConfigurationInstanceDetailsBlockVolume" }, "description": "Block volume parameters.\n", "willReplaceOnChanges": true }, "instanceType": { "type": "string", "description": "The type of instance details. Supported instanceType is compute\n", "willReplaceOnChanges": true }, "launchDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetails:InstanceConfigurationInstanceDetailsLaunchDetails", "description": "Instance launch details for creating an instance from an instance configuration. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\nSee [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/LaunchInstanceDetails) for more information.\n", "willReplaceOnChanges": true }, "options": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOption:InstanceConfigurationInstanceDetailsOption" }, "description": "Multiple Compute Instance Configuration instance details.\n", "willReplaceOnChanges": true }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsSecondaryVnic:InstanceConfigurationInstanceDetailsSecondaryVnic" }, "description": "Secondary VNIC parameters.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "instanceType" ], "language": { "nodejs": { "requiredOutputs": [ "blockVolumes", "instanceType", "launchDetails", "options", "secondaryVnics" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsBlockVolume:InstanceConfigurationInstanceDetailsBlockVolume": { "properties": { "attachDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeAttachDetails:InstanceConfigurationInstanceDetailsBlockVolumeAttachDetails", "description": "Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/)\n", "willReplaceOnChanges": true }, "createDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetails:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetails", "description": "Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/)\n", "willReplaceOnChanges": true }, "volumeId": { "type": "string", "description": "The OCID of the volume.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachDetails", "createDetails", "volumeId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeAttachDetails:InstanceConfigurationInstanceDetailsBlockVolumeAttachDetails": { "properties": { "device": { "type": "string", "description": "The device name.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.\n", "willReplaceOnChanges": true }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment should be created in read-only mode.\n", "willReplaceOnChanges": true }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of volume. The only supported values are \"iscsi\" and \"paravirtualized\"\n", "willReplaceOnChanges": true }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "device", "displayName", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "type", "useChap" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetails:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetails": { "properties": { "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsAutotunePolicy:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n", "willReplaceOnChanges": true }, "availabilityDomain": { "type": "string", "description": "The availability domain of the volume. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "backupPolicyId": { "type": "string", "description": "If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.\n", "willReplaceOnChanges": true }, "blockVolumeReplicas": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsBlockVolumeReplicas:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsBlockVolumeReplicas", "description": "The list of block volume replicas to be enabled for this volume in the specified destination availability domains.\n", "willReplaceOnChanges": true }, "clusterPlacementGroupId": { "type": "string", "description": "The clusterPlacementGroup Id of the volume for volume placement.\n", "willReplaceOnChanges": true }, "compartmentId": { "type": "string", "description": "The OCID of the compartment that contains the volume.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n", "willReplaceOnChanges": true }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n", "willReplaceOnChanges": true }, "sourceDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsSourceDetails:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsSourceDetails", "willReplaceOnChanges": true }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n", "willReplaceOnChanges": true }, "xrcKmsKeyId": { "type": "string", "description": "The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autotunePolicies", "availabilityDomain", "backupPolicyId", "blockVolumeReplicas", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "isAutoTuneEnabled", "kmsKeyId", "sizeInGbs", "sourceDetails", "vpusPerGb", "xrcKmsKeyId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsAutotunePolicy:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n", "willReplaceOnChanges": true }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "autotuneType" ], "language": { "nodejs": { "requiredOutputs": [ "autotuneType", "maxVpusPerGb" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsBlockVolumeReplicas:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsBlockVolumeReplicas": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "The display name of the block volume replica. You may optionally specify a *display name* for the block volume replica, otherwise a default is provided.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "displayName" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsSourceDetails:InstanceConfigurationInstanceDetailsBlockVolumeCreateDetailsSourceDetails": { "properties": { "id": { "type": "string", "description": "The OCID of the volume backup.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type can be one of these values: \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e, `volumeBackup`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "id", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetails:InstanceConfigurationInstanceDetailsLaunchDetails": { "properties": { "agentConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfig:InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfig", "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n", "willReplaceOnChanges": true }, "availabilityConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsAvailabilityConfig:InstanceConfigurationInstanceDetailsLaunchDetailsAvailabilityConfig", "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n", "willReplaceOnChanges": true }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation this instance is launched under.\n", "willReplaceOnChanges": true }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n", "willReplaceOnChanges": true }, "compartmentId": { "type": "string", "description": "The OCID of the compartment containing the instance. Instances created from instance configurations are placed in the same compartment as the instance that was used to create the instance configuration.\n", "willReplaceOnChanges": true }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n", "willReplaceOnChanges": true }, "createVnicDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetails:InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetails", "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n", "willReplaceOnChanges": true }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host to place the instance on.\n\nDedicated VM hosts can be used when launching individual instances from an instance configuration. They cannot be used to launch instance pools.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n\nThey are distinguished from \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e fields in that these can be nested JSON objects (whereas \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e fields are string/string maps only).\n\nThe combined size of the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e and `extendedMetadata` objects can be a maximum of 32,000 bytes.\n", "willReplaceOnChanges": true }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n\nIf you do not specify the fault domain, the system selects one for you.\n\nTo get a list of fault domains, use the [ListFaultDomains](https://docs.cloud.oracle.com/iaas/api/#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API.\n\nExample: `FAULT-DOMAIN-1`\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "instanceOptions": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsInstanceOptions:InstanceConfigurationInstanceDetailsLaunchDetailsInstanceOptions", "description": "Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints.\n", "willReplaceOnChanges": true }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n\nWhen a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.\n\nIf you want more control over the boot process, you can provide your own custom iPXE script that will run when the instance boots; however, you should be aware that the same iPXE script will run every time an instance boots; not only after the initial LaunchInstance call.\n\nThe default iPXE script connects to the instance's local boot volume over iSCSI and performs a network boot. If you use a custom iPXE script and want to network-boot from the instance's local boot volume over iSCSI the same way as the default iPXE script, you should use the following iSCSI IP address: 169.254.0.2, and boot volume IQN: iqn.2015-02.oracle.boot.\n\nFor more information about the Bring Your Own Image feature of Oracle Cloud Infrastructure, see [Bring Your Own Image](https://docs.cloud.oracle.com/iaas/Content/Compute/References/bringyourownimage.htm).\n\nFor more information about iPXE, see http://ipxe.org.\n", "willReplaceOnChanges": true }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether to enable AI enterprise on the instance.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.\n", "willReplaceOnChanges": true }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n", "willReplaceOnChanges": true }, "launchOptions": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsLaunchOptions:InstanceConfigurationInstanceDetailsLaunchDetailsLaunchOptions", "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n", "willReplaceOnChanges": true }, "licensingConfigs": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsLicensingConfigs:InstanceConfigurationInstanceDetailsLaunchDetailsLicensingConfigs", "description": "List of licensing configurations associated with target launch values.\n", "willReplaceOnChanges": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.\n\nA metadata service runs on every launched instance. The service is an HTTP endpoint listening on 169.254.169.254. You can use the service to:\n* Provide information to [Cloud-Init](https://cloudinit.readthedocs.org/en/latest/) to be used for various system initialization tasks.\n* Get information about the instance, including the custom metadata that you provide when you launch the instance.\n\n**Providing Cloud-Init Metadata**\n\nYou can use the following metadata key names to provide information to Cloud-Init:\n\n**\u003cspan pulumi-lang-nodejs=\"\"sshAuthorizedKeys\"\" pulumi-lang-dotnet=\"\"SshAuthorizedKeys\"\" pulumi-lang-go=\"\"sshAuthorizedKeys\"\" pulumi-lang-python=\"\"ssh_authorized_keys\"\" pulumi-lang-yaml=\"\"sshAuthorizedKeys\"\" pulumi-lang-java=\"\"sshAuthorizedKeys\"\" pulumi-lang-hcl=\"\"ssh_authorized_keys\"\"\u003e\"sshAuthorizedKeys\"\u003c/span\u003e** - Provide one or more public SSH keys to be included in the `~/.ssh/authorized_keys` file for the default user on the instance. Use a newline character to separate multiple keys. The SSH keys must be in the format necessary for the \u003cspan pulumi-lang-nodejs=\"`authorizedKeys`\" pulumi-lang-dotnet=\"`AuthorizedKeys`\" pulumi-lang-go=\"`authorizedKeys`\" pulumi-lang-python=\"`authorized_keys`\" pulumi-lang-yaml=\"`authorizedKeys`\" pulumi-lang-java=\"`authorizedKeys`\" pulumi-lang-hcl=\"`authorized_keys`\"\u003e`authorizedKeys`\u003c/span\u003e file, as shown in the example below.\n\n**\u003cspan pulumi-lang-nodejs=\"\"userData\"\" pulumi-lang-dotnet=\"\"UserData\"\" pulumi-lang-go=\"\"userData\"\" pulumi-lang-python=\"\"user_data\"\" pulumi-lang-yaml=\"\"userData\"\" pulumi-lang-java=\"\"userData\"\" pulumi-lang-hcl=\"\"user_data\"\"\u003e\"userData\"\u003c/span\u003e** - Provide your own base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For information about how to take advantage of user data, see the [Cloud-Init Documentation](http://cloudinit.readthedocs.org/en/latest/topics/format.html).\n\n**Metadata Example**\n\n\"metadata\" : { \u003cspan pulumi-lang-nodejs=\"\"quakeBotLevel\"\" pulumi-lang-dotnet=\"\"QuakeBotLevel\"\" pulumi-lang-go=\"\"quakeBotLevel\"\" pulumi-lang-python=\"\"quake_bot_level\"\" pulumi-lang-yaml=\"\"quakeBotLevel\"\" pulumi-lang-java=\"\"quakeBotLevel\"\" pulumi-lang-hcl=\"\"quake_bot_level\"\"\u003e\"quakeBotLevel\"\u003c/span\u003e : \"Severe\", \u003cspan pulumi-lang-nodejs=\"\"sshAuthorizedKeys\"\" pulumi-lang-dotnet=\"\"SshAuthorizedKeys\"\" pulumi-lang-go=\"\"sshAuthorizedKeys\"\" pulumi-lang-python=\"\"ssh_authorized_keys\"\" pulumi-lang-yaml=\"\"sshAuthorizedKeys\"\" pulumi-lang-java=\"\"sshAuthorizedKeys\"\" pulumi-lang-hcl=\"\"ssh_authorized_keys\"\"\u003e\"sshAuthorizedKeys\"\u003c/span\u003e : \"ssh-rsa \u003cyour_public_SSH_key\u003e== rsa-key-20160227\", \u003cspan pulumi-lang-nodejs=\"\"userData\"\" pulumi-lang-dotnet=\"\"UserData\"\" pulumi-lang-go=\"\"userData\"\" pulumi-lang-python=\"\"user_data\"\" pulumi-lang-yaml=\"\"userData\"\" pulumi-lang-java=\"\"userData\"\" pulumi-lang-hcl=\"\"user_data\"\"\u003e\"userData\"\u003c/span\u003e : \"\u003cyour_public_SSH_key\u003e==\" } **Getting Metadata on the Instance**\n\nTo get information about your instance, connect to the instance using SSH and issue any of the following GET requests:\n\ncurl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/ curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/ curl -H \"Authorization: Bearer Oracle\" http://169.254.169.254/opc/v2/instance/metadata/\u003cany-key-name\u003e\n\nYou'll get back a response that includes all the instance information; only the metadata information; or the metadata information for the specified key name, respectively.\n\nThe combined size of the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e and `extendedMetadata` objects can be a maximum of 32,000 bytes.\n", "willReplaceOnChanges": true }, "placementConstraintDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPlacementConstraintDetails:InstanceConfigurationInstanceDetailsLaunchDetailsPlacementConstraintDetails", "description": "The details for providing placement constraints.\n", "willReplaceOnChanges": true }, "platformConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPlatformConfig:InstanceConfigurationInstanceDetailsLaunchDetailsPlatformConfig", "description": "(Optional) (Updatable only for VM's) The platform configuration requested for the instance.\n\nIf you provide the parameter, the instance is created with the platform configuration that you specify. For any values that you omit, the instance uses the default configuration values for the \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e that you specify. If you don't provide the parameter, the default values for the \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e are used.\n\nEach shape only supports certain configurable values. If the values that you provide are not valid for the specified \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e, an error is returned.\n", "willReplaceOnChanges": true }, "preemptibleInstanceConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfig:InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfig", "description": "Configuration options for preemptible instances.\n", "willReplaceOnChanges": true }, "preferredMaintenanceAction": { "type": "string", "description": "The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.\n* `LIVE_MIGRATE` - Run maintenance using a live migration.\n* `REBOOT` - Run maintenance using a reboot.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n", "willReplaceOnChanges": true }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n\nYou can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes).\n", "willReplaceOnChanges": true }, "shapeConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsShapeConfig:InstanceConfigurationInstanceDetailsLaunchDetailsShapeConfig", "description": "The shape configuration requested for the instance.\n\nIf the parameter is provided, the instance is created with the resources that you specify. If some properties are missing or the entire parameter is not provided, the instance is created with the default configuration values for the \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e that you specify.\n\nEach shape only supports certain configurable values. If the values that you provide are not valid for the specified \u003cspan pulumi-lang-nodejs=\"`shape`\" pulumi-lang-dotnet=\"`Shape`\" pulumi-lang-go=\"`shape`\" pulumi-lang-python=\"`shape`\" pulumi-lang-yaml=\"`shape`\" pulumi-lang-java=\"`shape`\" pulumi-lang-hcl=\"`shape`\"\u003e`shape`\u003c/span\u003e, an error is returned.\n", "willReplaceOnChanges": true }, "sourceDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetails:InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetails", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentConfig", "availabilityConfig", "availabilityDomain", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfig", "preemptibleInstanceConfig", "preferredMaintenanceAction", "securityAttributes", "shape", "shapeConfig", "sourceDetails" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfig:InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n\nTo get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n", "willReplaceOnChanges": true }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n", "willReplaceOnChanges": true }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n", "willReplaceOnChanges": true }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfigPluginsConfig:InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfigPluginsConfig:InstanceConfigurationInstanceDetailsLaunchDetailsAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredState", "name" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsAvailabilityConfig:InstanceConfigurationInstanceDetailsLaunchDetailsAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isLiveMigrationPreferred", "recoveryAction" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetails:InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetails": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n", "willReplaceOnChanges": true }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignIpv6ip", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n", "willReplaceOnChanges": true }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n", "willReplaceOnChanges": true }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsInstanceOptions:InstanceConfigurationInstanceDetailsLaunchDetailsInstanceOptions": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areLegacyImdsEndpointsDisabled" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsLaunchOptions:InstanceConfigurationInstanceDetailsLaunchDetailsLaunchOptions": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n", "willReplaceOnChanges": true }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n", "willReplaceOnChanges": true }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n", "willReplaceOnChanges": true }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n", "willReplaceOnChanges": true }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsLicensingConfigs:InstanceConfigurationInstanceDetailsLaunchDetailsLicensingConfigs": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Operating System type of the Configuration.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "licenseType", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPlacementConstraintDetails:InstanceConfigurationInstanceDetailsLaunchDetailsPlacementConstraintDetails": { "properties": { "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group. This is only available for dedicated capacity customers.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type for the placement constraints. Use `HOST_GROUP` when specifying the compute host group OCID.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "computeHostGroupId", "type" ] }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPlatformConfig:InstanceConfigurationInstanceDetailsLaunchDetailsPlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n", "willReplaceOnChanges": true }, "configMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Instance Platform Configuration Configuration Map for flexible setting input.\n", "willReplaceOnChanges": true }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n", "willReplaceOnChanges": true }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n", "willReplaceOnChanges": true }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n", "willReplaceOnChanges": true }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n", "willReplaceOnChanges": true }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n", "willReplaceOnChanges": true }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "(Updatable only for AMD_VM and INTEL_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n\nIntel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.\n", "willReplaceOnChanges": true }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n", "willReplaceOnChanges": true }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n", "willReplaceOnChanges": true }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n\nIf the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of platform being configured.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "areVirtualInstructionsEnabled", "configMap", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfig:InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfig": { "properties": { "preemptionAction": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfigPreemptionAction:InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfigPreemptionAction", "description": "The action to run when the preemptible instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preemptionAction" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfigPreemptionAction:InstanceConfigurationInstanceDetailsLaunchDetailsPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "preserveBootVolume", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsShapeConfig:InstanceConfigurationInstanceDetailsLaunchDetailsShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n\nThe following values are supported:\n* `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.\n* `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.\n* `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.\n", "willReplaceOnChanges": true }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n", "willReplaceOnChanges": true }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n", "willReplaceOnChanges": true }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n", "willReplaceOnChanges": true }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n", "willReplaceOnChanges": true }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "localVolumeSizeInGbs", "memoryInGbs", "nvmes", "ocpus", "resourceManagement", "vcpus" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetails:InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetails": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n", "willReplaceOnChanges": true }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n", "willReplaceOnChanges": true }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n", "willReplaceOnChanges": true }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n", "willReplaceOnChanges": true }, "instanceSourceImageFilterDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails:InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails", "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n", "willReplaceOnChanges": true }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "instanceSourceImageFilterDetails", "kmsKeyId", "sourceType" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails:InstanceConfigurationInstanceDetailsLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The OCID of the compartment containing images to search\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n", "willReplaceOnChanges": true }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n", "willReplaceOnChanges": true }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOption:InstanceConfigurationInstanceDetailsOption": { "properties": { "blockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolume:InstanceConfigurationInstanceDetailsOptionBlockVolume" }, "description": "Block volume parameters.\n", "willReplaceOnChanges": true }, "launchDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetails", "description": "Instance launch details for creating an instance from an instance configuration. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n\nSee [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/LaunchInstanceDetails) for more information.\n", "willReplaceOnChanges": true }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionSecondaryVnic:InstanceConfigurationInstanceDetailsOptionSecondaryVnic" }, "description": "Secondary VNIC parameters.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "blockVolumes", "launchDetails", "secondaryVnics" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolume:InstanceConfigurationInstanceDetailsOptionBlockVolume": { "properties": { "attachDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeAttachDetails:InstanceConfigurationInstanceDetailsOptionBlockVolumeAttachDetails", "description": "Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/)\n", "willReplaceOnChanges": true }, "createDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetails:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetails", "description": "Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/)\n", "willReplaceOnChanges": true }, "volumeId": { "type": "string", "description": "The OCID of the volume.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "attachDetails", "createDetails", "volumeId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeAttachDetails:InstanceConfigurationInstanceDetailsOptionBlockVolumeAttachDetails": { "properties": { "device": { "type": "string", "description": "The device name.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.\n", "willReplaceOnChanges": true }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment should be created in read-only mode.\n", "willReplaceOnChanges": true }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of volume. The only supported values are \"iscsi\" and \"paravirtualized\".\n", "willReplaceOnChanges": true }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "device", "displayName", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "type", "useChap" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetails:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetails": { "properties": { "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsAutotunePolicy:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n", "willReplaceOnChanges": true }, "availabilityDomain": { "type": "string", "description": "The availability domain of the volume. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "backupPolicyId": { "type": "string", "description": "If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.\n", "willReplaceOnChanges": true }, "blockVolumeReplicas": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsBlockVolumeReplicas:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsBlockVolumeReplicas", "description": "The list of block volume replicas to be enabled for this volume in the specified destination availability domains.\n", "willReplaceOnChanges": true }, "clusterPlacementGroupId": { "type": "string", "description": "The clusterPlacementGroup Id of the volume for volume placement.\n", "willReplaceOnChanges": true }, "compartmentId": { "type": "string", "description": "(Updatable) The OCID of the compartment that contains the volume.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n", "willReplaceOnChanges": true }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n", "willReplaceOnChanges": true }, "sourceDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsSourceDetails:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsSourceDetails", "willReplaceOnChanges": true }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n", "willReplaceOnChanges": true }, "xrcKmsKeyId": { "type": "string", "description": "The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "autotunePolicies", "availabilityDomain", "backupPolicyId", "blockVolumeReplicas", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "isAutoTuneEnabled", "kmsKeyId", "sizeInGbs", "sourceDetails", "vpusPerGb", "xrcKmsKeyId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsAutotunePolicy:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n", "willReplaceOnChanges": true }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "autotuneType" ], "language": { "nodejs": { "requiredOutputs": [ "autotuneType", "maxVpusPerGb" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsBlockVolumeReplicas:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsBlockVolumeReplicas": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "displayName" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsSourceDetails:InstanceConfigurationInstanceDetailsOptionBlockVolumeCreateDetailsSourceDetails": { "properties": { "id": { "type": "string", "description": "The OCID of the volume backup.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type can be one of these values: \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e, `volumeBackup`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "id", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetails": { "properties": { "agentConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfig", "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n", "willReplaceOnChanges": true }, "availabilityConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsAvailabilityConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsAvailabilityConfig", "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n", "willReplaceOnChanges": true }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n", "willReplaceOnChanges": true }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation this instance is launched under.\n", "willReplaceOnChanges": true }, "clusterPlacementGroupId": { "type": "string", "description": "The clusterPlacementGroup Id of the volume for volume placement.\n", "willReplaceOnChanges": true }, "compartmentId": { "type": "string", "description": "(Updatable) The OCID of the compartment containing the instance. Instances created from instance configurations are placed in the same compartment as the instance that was used to create the instance configuration.\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n", "willReplaceOnChanges": true }, "createVnicDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetails", "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n", "willReplaceOnChanges": true }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host to place the instance on.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n", "willReplaceOnChanges": true }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "instanceOptions": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsInstanceOptions:InstanceConfigurationInstanceDetailsOptionLaunchDetailsInstanceOptions", "description": "Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints.\n", "willReplaceOnChanges": true }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n", "willReplaceOnChanges": true }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether to enable AI enterprise on the instance.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n", "willReplaceOnChanges": true }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n", "willReplaceOnChanges": true }, "launchOptions": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsLaunchOptions:InstanceConfigurationInstanceDetailsOptionLaunchDetailsLaunchOptions", "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n", "willReplaceOnChanges": true }, "licensingConfigs": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsLicensingConfigs:InstanceConfigurationInstanceDetailsOptionLaunchDetailsLicensingConfigs", "description": "List of licensing configurations associated with target launch values.\n", "willReplaceOnChanges": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.\n", "willReplaceOnChanges": true }, "placementConstraintDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlacementConstraintDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlacementConstraintDetails", "description": "The details for providing placement constraints.\n", "willReplaceOnChanges": true }, "platformConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlatformConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlatformConfig", "description": "The platform configuration requested for the instance.\n", "willReplaceOnChanges": true }, "preemptibleInstanceConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfig", "description": "Configuration options for preemptible instances.\n", "willReplaceOnChanges": true }, "preferredMaintenanceAction": { "type": "string", "description": "The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.\n* `LIVE_MIGRATE` - Run maintenance using a live migration.\n* `REBOOT` - Run maintenance using a reboot.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n", "willReplaceOnChanges": true }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n", "willReplaceOnChanges": true }, "shapeConfig": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsShapeConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsShapeConfig", "description": "The shape configuration requested for the instance.\n", "willReplaceOnChanges": true }, "sourceDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetails", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "agentConfig", "availabilityConfig", "availabilityDomain", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfig", "preemptibleInstanceConfig", "preferredMaintenanceAction", "securityAttributes", "shape", "shapeConfig", "sourceDetails" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n\nTo get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n", "willReplaceOnChanges": true }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n\nThese are the management plugins: OS Management Service Agent and Compute Instance Run Command.\n\nThe management plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.\n* If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of the per-plugin configuration.\n* If `isManagementDisabled` is false, all of the management plugins are enabled. You can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.\n", "willReplaceOnChanges": true }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n\nThese are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.\n\nThe monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.\n* If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of the per-plugin configuration.\n* If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.\n", "willReplaceOnChanges": true }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfigPluginsConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfigPluginsConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n\nTo enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false.\n", "willReplaceOnChanges": true }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "desiredState", "name" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsAvailabilityConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "isLiveMigrationPreferred", "recoveryAction" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetails": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. Defaults to true. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n", "willReplaceOnChanges": true }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsOptionLaunchDetailsCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n", "willReplaceOnChanges": true }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n", "willReplaceOnChanges": true }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsInstanceOptions:InstanceConfigurationInstanceDetailsOptionLaunchDetailsInstanceOptions": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areLegacyImdsEndpointsDisabled" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsLaunchOptions:InstanceConfigurationInstanceDetailsOptionLaunchDetailsLaunchOptions": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n", "willReplaceOnChanges": true }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n", "willReplaceOnChanges": true }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n", "willReplaceOnChanges": true }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n", "willReplaceOnChanges": true }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsLicensingConfigs:InstanceConfigurationInstanceDetailsOptionLaunchDetailsLicensingConfigs": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "licenseType", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlacementConstraintDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlacementConstraintDetails": { "properties": { "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group. This is only available for dedicated capacity customers.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "computeHostGroupId", "type" ] }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlatformConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n", "willReplaceOnChanges": true }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n", "willReplaceOnChanges": true }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n", "willReplaceOnChanges": true }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n", "willReplaceOnChanges": true }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n", "willReplaceOnChanges": true }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n", "willReplaceOnChanges": true }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n", "willReplaceOnChanges": true }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n", "willReplaceOnChanges": true }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n", "willReplaceOnChanges": true }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "areVirtualInstructionsEnabled", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfig": { "properties": { "preemptionAction": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfigPreemptionAction:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfigPreemptionAction", "description": "The action to run when the preemptible instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preemptionAction" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfigPreemptionAction:InstanceConfigurationInstanceDetailsOptionLaunchDetailsPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "preserveBootVolume", "type" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsShapeConfig:InstanceConfigurationInstanceDetailsOptionLaunchDetailsShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n", "willReplaceOnChanges": true }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n", "willReplaceOnChanges": true }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n", "willReplaceOnChanges": true }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n", "willReplaceOnChanges": true }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n", "willReplaceOnChanges": true }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "localVolumeSizeInGbs", "memoryInGbs", "nvmes", "ocpus", "resourceManagement", "vcpus" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetails": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n", "willReplaceOnChanges": true }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n", "willReplaceOnChanges": true }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n", "willReplaceOnChanges": true }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n", "willReplaceOnChanges": true }, "instanceSourceImageFilterDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails", "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n", "willReplaceOnChanges": true }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n", "willReplaceOnChanges": true }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "instanceSourceImageFilterDetails", "kmsKeyId", "sourceType" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails:InstanceConfigurationInstanceDetailsOptionLaunchDetailsSourceDetailsInstanceSourceImageFilterDetails": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance configuration.\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n", "willReplaceOnChanges": true }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n", "willReplaceOnChanges": true }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionSecondaryVnic:InstanceConfigurationInstanceDetailsOptionSecondaryVnic": { "properties": { "createVnicDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetails:InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetails", "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createVnicDetails", "displayName", "nicIndex" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetails:InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetails": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n", "willReplaceOnChanges": true }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsOptionSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n", "willReplaceOnChanges": true }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n", "willReplaceOnChanges": true }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsSecondaryVnic:InstanceConfigurationInstanceDetailsSecondaryVnic": { "properties": { "createVnicDetails": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetails:InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetails", "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "createVnicDetails", "displayName", "nicIndex" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetails:InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetails": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n", "willReplaceOnChanges": true }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n", "willReplaceOnChanges": true }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n", "willReplaceOnChanges": true }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefixes from which the VNIC should be assigned an IPv6 address. You can provide only the prefix and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n", "willReplaceOnChanges": true }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignIpv6ip", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ] } } }, "oci:Core/InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceConfigurationInstanceDetailsSecondaryVnicCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n", "willReplaceOnChanges": true }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n", "willReplaceOnChanges": true }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ] } } }, "oci:Core/InstanceCreateVnicDetails:InstanceCreateVnicDetails": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, there will be no DNS record registration for the VNIC. If set to true, the DNS record will be registered. The default value is true.\nIf you specify a `hostnameLabel`, the `assignPrivateDnsRecord` is require to be set to true.\n", "willReplaceOnChanges": true }, "assignPublicIp": { "type": "string", "description": "(Updatable) Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n\n**Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n\n**Note:** There's a limit to the number of [public IPs](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PublicIp/) a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see [Public IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\nExample: \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n\nIf you specify a `vlanId`, then `assignPublicIp` must be set to false. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "(Updatable) The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \u003cspan pulumi-lang-nodejs=\"`bminstance1`\" pulumi-lang-dotnet=\"`Bminstance1`\" pulumi-lang-go=\"`bminstance1`\" pulumi-lang-python=\"`bminstance1`\" pulumi-lang-yaml=\"`bminstance1`\" pulumi-lang-java=\"`bminstance1`\" pulumi-lang-hcl=\"`bminstance1`\"\u003e`bminstance1`\u003c/span\u003e in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n\nFor more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).\n\nWhen launching an instance, use this `hostnameLabel` instead of the deprecated `hostnameLabel` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). If you provide both, the values must match.\n\nExample: \u003cspan pulumi-lang-nodejs=\"`bminstance1`\" pulumi-lang-dotnet=\"`Bminstance1`\" pulumi-lang-go=\"`bminstance1`\" pulumi-lang-python=\"`bminstance1`\" pulumi-lang-yaml=\"`bminstance1`\" pulumi-lang-java=\"`bminstance1`\" pulumi-lang-hcl=\"`bminstance1`\"\u003e`bminstance1`\u003c/span\u003e\n\nIf you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN can not be assigned a hostname. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address within that range to use.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n\nIf a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n\nIf you specify a `vlanId`, the `privateIp` cannot be specified. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nIf you specify a 'privateIpId', the 'privateIp' cannot be specified.\n\nExample: `10.0.3.3`\n", "willReplaceOnChanges": true }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC.\n", "willReplaceOnChanges": true }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR.MaxEgressCount.value\": \"42\", \"Oracle-DataSecurity-ZPR.MaxEgressCount.mode\": \"audit\"}`\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "(Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you would skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n\nIf you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nExample: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28`\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC in. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n\nIf you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails.\n", "willReplaceOnChanges": true }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nProvide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignIpv6ip", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId", "vlanId" ] } } }, "oci:Core/InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:InstanceCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. If an IPv6 address is not provided:\n* Oracle will automatically assign an IPv6 address from the subnet's IPv6 prefix if and only if there is only one IPv6 prefix on the subnet.\n* Oracle will automatically assign an IPv6 address from the subnet's IPv6 Oracle GUA prefix if it exists on the subnet.\n", "willReplaceOnChanges": true }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n", "willReplaceOnChanges": true }, "ipv6subnetCidr": { "type": "string", "description": "The IPv6 prefix allocated to the subnet.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ] } } }, "oci:Core/InstanceInstanceOptions:InstanceInstanceOptions": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "(Updatable) Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "areLegacyImdsEndpointsDisabled" ] } } }, "oci:Core/InstanceLaunchOptions:InstanceLaunchOptions": { "properties": { "bootVolumeType": { "type": "string", "description": "(Updatable) Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n", "willReplaceOnChanges": true }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n", "willReplaceOnChanges": true }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "(Updatable) Use this for update operation only. This field is Deprecated during create. For create use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/datatypes/LaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "(Updatable) Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ] } } }, "oci:Core/InstanceLaunchVolumeAttachment:InstanceLaunchVolumeAttachment": { "properties": { "device": { "type": "string", "description": "The device name. To retrieve a list of devices for a given instance, see [ListInstanceDevices](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Device/ListInstanceDevices).\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "encryptionInTransitType": { "type": "string", "description": "Refer the top-level definition of encryptionInTransitType. The default value is NONE.\n" }, "isAgentAutoIscsiLoginEnabled": { "type": "boolean", "description": "Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false.\n" }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment was created in read-only mode.\n" }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n" }, "launchCreateVolumeDetails": { "$ref": "#/types/oci:Core/InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails:InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails", "description": "Define a volume that will be created and attached or attached to an instance on creation.\n" }, "type": { "type": "string", "description": "The type of volume attachment. Currently, the only supported values are \"iscsi\" and \"paravirtualized\".\n" }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n" }, "volumeId": { "type": "string", "description": "The OCID of the volume. If CreateVolumeDetails is specified, this field must be omitted from the request.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "device", "displayName", "encryptionInTransitType", "isAgentAutoIscsiLoginEnabled", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "launchCreateVolumeDetails", "type", "useChap", "volumeId" ] } } }, "oci:Core/InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails:InstanceLaunchVolumeAttachmentLaunchCreateVolumeDetails": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The OCID of the compartment that contains the volume. If not provided, it will be inherited from the instance.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" }, "volumeCreationType": { "type": "string", "description": "Specifies the method for volume creation.\n" }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n" } }, "type": "object", "required": [ "sizeInGbs", "volumeCreationType" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "displayName", "kmsKeyId", "sizeInGbs", "volumeCreationType", "vpusPerGb" ] } } }, "oci:Core/InstanceLicensingConfigs:InstanceLicensingConfigs": { "properties": { "licenseType": { "type": "string", "description": "(Updatable) License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "osVersion": { "type": "string", "description": "The Operating System version of the license config.\n" }, "type": { "type": "string", "description": "(Updatable) Operating System type of the Configuration.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "licenseType", "osVersion", "type" ] } } }, "oci:Core/InstancePlacementConstraintDetails:InstancePlacementConstraintDetails": { "properties": { "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host.\n", "willReplaceOnChanges": true }, "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "Determines the type of targeted launch.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "computeBareMetalHostId", "computeHostGroupId", "type" ] } } }, "oci:Core/InstancePlatformConfig:InstancePlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n", "willReplaceOnChanges": true }, "configMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Instance Platform Configuration Configuration Map for flexible setting input.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n", "willReplaceOnChanges": true }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n", "willReplaceOnChanges": true }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n", "willReplaceOnChanges": true }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n", "willReplaceOnChanges": true }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n", "willReplaceOnChanges": true }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "(Updatable only for INTEL_VM and AMD_VM) Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n\nIntel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n", "willReplaceOnChanges": true }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n", "willReplaceOnChanges": true }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n\nIf the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of platform being configured.\n" } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "areVirtualInstructionsEnabled", "configMap", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ] } } }, "oci:Core/InstancePoolInstanceLoadBalancerBackend:InstancePoolInstanceLoadBalancerBackend": { "properties": { "backendHealthStatus": { "type": "string", "description": "The health of the backend as observed by the load balancer.\n" }, "backendName": { "type": "string", "description": "The name of the backend in the backend set.\n" }, "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "loadBalancerId": { "type": "string", "description": "The OCID of the load balancer attached to the instance pool.\n" }, "state": { "type": "string", "description": "The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance) resource.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "backendHealthStatus", "backendName", "backendSetName", "loadBalancerId", "state" ] } } }, "oci:Core/InstancePoolLifecycleManagement:InstancePoolLifecycleManagement": { "properties": { "lifecycleActions": { "$ref": "#/types/oci:Core/InstancePoolLifecycleManagementLifecycleActions:InstancePoolLifecycleManagementLifecycleActions", "description": "(Updatable) The lifecycle actions for the instance pool.\n" } }, "type": "object", "required": [ "lifecycleActions" ] }, "oci:Core/InstancePoolLifecycleManagementLifecycleActions:InstancePoolLifecycleManagementLifecycleActions": { "properties": { "preTermination": { "$ref": "#/types/oci:Core/InstancePoolLifecycleManagementLifecycleActionsPreTermination:InstancePoolLifecycleManagementLifecycleActionsPreTermination", "description": "(Updatable) The data for pre-termination action for an instance pool\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "preTermination" ] } } }, "oci:Core/InstancePoolLifecycleManagementLifecycleActionsPreTermination:InstancePoolLifecycleManagementLifecycleActionsPreTermination": { "properties": { "isEnabled": { "type": "boolean", "description": "(Updatable) Whether pre-termination action is enabled or not.\n" }, "onTimeout": { "$ref": "#/types/oci:Core/InstancePoolLifecycleManagementLifecycleActionsPreTerminationOnTimeout:InstancePoolLifecycleManagementLifecycleActionsPreTerminationOnTimeout", "description": "(Updatable) Options to handle timeout for pre-termination action.\n" }, "timeout": { "type": "integer", "description": "(Updatable) The timeout in seconds for pre-termination action for an instance pool(min = 0 sec, max = 7200 secs).\n" } }, "type": "object", "required": [ "isEnabled", "onTimeout", "timeout" ] }, "oci:Core/InstancePoolLifecycleManagementLifecycleActionsPreTerminationOnTimeout:InstancePoolLifecycleManagementLifecycleActionsPreTerminationOnTimeout": { "properties": { "preserveBlockVolumeMode": { "type": "string", "description": "(Updatable) Whether the block volume should be preserved after termination.\n" }, "preserveBootVolumeMode": { "type": "string", "description": "(Updatable) Whether the boot volume should be preserved after termination.\n" } }, "type": "object", "required": [ "preserveBlockVolumeMode", "preserveBootVolumeMode" ] }, "oci:Core/InstancePoolLoadBalancer:InstancePoolLoadBalancer": { "properties": { "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer to add instances to.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment.\n" }, "loadBalancerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer to attach to the instance pool.\n" }, "port": { "type": "integer", "description": "The port value to use when creating the backend set.\n" }, "state": { "type": "string", "description": "(Updatable) The target state for the instance pool update operation (ignored at create time and should not be set). Could be set to RUNNING or STOPPED.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" }, "vnicSelection": { "type": "string", "description": "Indicates which VNIC on each instance in the pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.\n" } }, "type": "object", "required": [ "backendSetName", "loadBalancerId", "port", "vnicSelection" ], "language": { "nodejs": { "requiredOutputs": [ "backendSetName", "id", "instancePoolId", "loadBalancerId", "port", "state", "vnicSelection" ] } } }, "oci:Core/InstancePoolPlacementConfiguration:InstancePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n\nMake sure the compute cluster belongs to the same availability domain as specified in placement configuration otherwise the request will be rejected with 400. Once this field is set, it cannot be updated. Also any update to the availability domain in placement configuration will be blocked.\n", "willReplaceOnChanges": true }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) The fault domains to place instances.\n\nIf you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity.\n\nTo distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability.\n\nTo get a list of fault domains, use the [ListFaultDomains](https://docs.cloud.oracle.com/iaas/api/#/en/identity/20160918/FaultDomain/ListFaultDomains) operation in the Identity and Access Management Service API.\n\nExample: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]`\n" }, "primarySubnetId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "$ref": "#/types/oci:Core/InstancePoolPlacementConfigurationPrimaryVnicSubnets:InstancePoolPlacementConfigurationPrimaryVnicSubnets", "description": "(Updatable) Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstancePoolPlacementConfigurationSecondaryVnicSubnet:InstancePoolPlacementConfigurationSecondaryVnicSubnet" }, "description": "(Updatable) The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "faultDomains", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ] } } }, "oci:Core/InstancePoolPlacementConfigurationPrimaryVnicSubnets:InstancePoolPlacementConfigurationPrimaryVnicSubnets": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstancePoolPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail:InstancePoolPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail" }, "description": "(Updatable) A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "(Updatable) Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "(Updatable) The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ] } } }, "oci:Core/InstancePoolPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail:InstancePoolPlacementConfigurationPrimaryVnicSubnetsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "(Updatable) Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6subnetCidr" ] } } }, "oci:Core/InstancePoolPlacementConfigurationSecondaryVnicSubnet:InstancePoolPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "(Updatable) The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/InstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:InstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "(Updatable) A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "(Updatable) Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "(Updatable) The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "subnetId" ], "language": { "nodejs": { "requiredOutputs": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ] } } }, "oci:Core/InstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:InstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "(Updatable) Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6subnetCidr" ] } } }, "oci:Core/InstancePreemptibleInstanceConfig:InstancePreemptibleInstanceConfig": { "properties": { "preemptionAction": { "$ref": "#/types/oci:Core/InstancePreemptibleInstanceConfigPreemptionAction:InstancePreemptibleInstanceConfigPreemptionAction", "description": "The action to run when the preemptible instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "preemptionAction" ] }, "oci:Core/InstancePreemptibleInstanceConfigPreemptionAction:InstancePreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ], "language": { "nodejs": { "requiredOutputs": [ "preserveBootVolume", "type" ] } } }, "oci:Core/InstanceShapeConfig:InstanceShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "(Updatable) The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n\nThe following values are supported:\n* `BASELINE_1_8` - baseline usage is 1/8 of an OCPU.\n* `BASELINE_1_2` - baseline usage is 1/2 of an OCPU.\n* `BASELINE_1_1` - baseline usage is an entire OCPU. This represents a non-burstable instance.\n" }, "gpuDescription": { "type": "string", "description": "A short description of the instance's graphics processing unit (GPU).\n" }, "gpus": { "type": "integer", "description": "The number of GPUs available to the instance.\n" }, "localDiskDescription": { "type": "string", "description": "A short description of the local disks available to this instance.\n" }, "localDisks": { "type": "integer", "description": "The number of local disks available to the instance.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "The aggregate size of all local disks, in gigabytes.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "(Updatable) The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n" }, "maxVnicAttachments": { "type": "integer", "description": "The maximum number of VNIC attachments for the instance.\n" }, "memoryInGbs": { "type": "number", "description": "(Updatable) The total amount of memory available to the instance, in gigabytes.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "The networking bandwidth available to the instance, in gigabits per second.\n" }, "nvmes": { "type": "integer", "description": "(Updatable) The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "number", "description": "(Updatable) The total number of OCPUs available to the instance.\n" }, "processorDescription": { "type": "string", "description": "A short description of the instance's processor (CPU).\n" }, "resourceManagement": { "type": "string", "description": "(Updatable) This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "(Updatable) The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "baselineOcpuUtilization", "gpuDescription", "gpus", "localDiskDescription", "localDisks", "localDisksTotalSizeInGbs", "localVolumeSizeInGbs", "maxVnicAttachments", "memoryInGbs", "networkingBandwidthInGbps", "nvmes", "ocpus", "processorDescription", "resourceManagement", "vcpus" ] } } }, "oci:Core/InstanceSourceDetails:InstanceSourceDetails": { "properties": { "bootVolumeSizeInGbs": { "type": "string", "description": "(Updatable) The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n\nAllowed values:\n", "willReplaceOnChanges": true }, "instanceSourceImageFilterDetails": { "$ref": "#/types/oci:Core/InstanceSourceDetailsInstanceSourceImageFilterDetails:InstanceSourceDetailsInstanceSourceImageFilterDetails", "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n", "willReplaceOnChanges": true }, "isPreserveBootVolumeEnabled": { "type": "boolean", "description": "(Updatable) Whether to preserve the boot volume that was previously attached to the instance after a successful replacement of that boot volume.\n" }, "kmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n" }, "sourceId": { "type": "string", "description": "(Updatable) The OCID of the boot volume used to boot the instance. Updates are supported only for linux Images. The user will need to manually destroy and re-create the resource for other image types.\n" }, "sourceType": { "type": "string", "description": "(Updatable) The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "sourceType" ], "language": { "nodejs": { "requiredOutputs": [ "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "instanceSourceImageFilterDetails", "sourceId", "sourceType" ] } } }, "oci:Core/InstanceSourceDetailsInstanceSourceImageFilterDetails:InstanceSourceDetailsInstanceSourceImageFilterDetails": { "properties": { "compartmentId": { "type": "string", "description": "(Updatable) The OCID of the compartment containing images to search\n", "willReplaceOnChanges": true }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n", "willReplaceOnChanges": true }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n", "willReplaceOnChanges": true }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "compartmentId" ], "language": { "nodejs": { "requiredOutputs": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ] } } }, "oci:Core/IpsecConnectionTunnelManagementBgpSessionInfo:IpsecConnectionTunnelManagementBgpSessionInfo": { "properties": { "bgpIpv6State": { "type": "string", "description": "The state of the BGP IPv6 session.\n" }, "bgpIpv6state": { "type": "string", "deprecationMessage": "The 'bgp_session_info.0.bgp_ipv6state' field has been deprecated. Please use 'bgp_session_info.0.bgp_ipv6_state' instead." }, "bgpState": { "type": "string", "description": "The state of the BGP session.\n" }, "customerBgpAsn": { "type": "string", "description": "If the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `BGP` (see [IPSecConnectionTunnel](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnectionTunnel/)), this ASN is required and used for the tunnel's BGP session. This is the ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses \"asplain\" format.\n\nIf the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `STATIC`, the `customerBgpAsn` must be null.\n\nExample: \u003cspan pulumi-lang-nodejs=\"`12345`\" pulumi-lang-dotnet=\"`12345`\" pulumi-lang-go=\"`12345`\" pulumi-lang-python=\"`12345`\" pulumi-lang-yaml=\"`12345`\" pulumi-lang-java=\"`12345`\" pulumi-lang-hcl=\"`12345`\"\u003e`12345`\u003c/span\u003e (2-byte) or \u003cspan pulumi-lang-nodejs=\"`1587232876`\" pulumi-lang-dotnet=\"`1587232876`\" pulumi-lang-go=\"`1587232876`\" pulumi-lang-python=\"`1587232876`\" pulumi-lang-yaml=\"`1587232876`\" pulumi-lang-java=\"`1587232876`\" pulumi-lang-hcl=\"`1587232876`\"\u003e`1587232876`\u003c/span\u003e (4-byte)\n" }, "customerInterfaceIp": { "type": "string", "description": "The IP address for the CPE end of the inside tunnel interface.\n\nIf the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `BGP` (see [IPSecConnectionTunnel](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnectionTunnel/)), this IP address is required and used for the tunnel's BGP session.\n\nIf \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel.\n\nThe value must be a /30 or /31.\n\nExample: `10.0.0.5/31`\n" }, "customerInterfaceIpv6": { "type": "string", "description": "The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional.\n\nIf the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `BGP` (see [IPSecConnectionTunnel](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel's BGP session.\n\nIf \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel.\n\nOnly subnet masks from /64 up to /127 are allowed.\n\nExample: `2001:db8::1/64`\n" }, "oracleBgpAsn": { "type": "string", "description": "The Oracle BGP ASN.\n" }, "oracleInterfaceIp": { "type": "string", "description": "The IP address for the Oracle end of the inside tunnel interface.\n\nIf the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `BGP` (see [IPSecConnectionTunnel](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/20160918/IPSecConnectionTunnel/)), this IP address is required and used for the tunnel's BGP session.\n\nIf \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel.\n\nThe value must be a /30 or /31.\n\nExample: `10.0.0.4/31`\n" }, "oracleInterfaceIpv6": { "type": "string", "description": "The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional.\n\nIf the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `BGP` (see [IPSecConnectionTunnel](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel's BGP session.\n\nIf \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel.\n\nOnly subnet masks from /64 up to /127 are allowed.\n\nExample: `2001:db8::1/64`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bgpIpv6State", "bgpIpv6state", "bgpState", "customerBgpAsn", "customerInterfaceIp", "customerInterfaceIpv6", "oracleBgpAsn", "oracleInterfaceIp", "oracleInterfaceIpv6" ] } } }, "oci:Core/IpsecConnectionTunnelManagementDpdConfig:IpsecConnectionTunnelManagementDpdConfig": { "properties": { "dpdMode": { "type": "string", "description": "This option defines whether DPD can be initiated from the Oracle side of the connection. `INITIATE_AND_RESPOND` or `RESPOND_ONLY`\n" }, "dpdTimeoutInSec": { "type": "integer", "description": "DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds.\n" } }, "type": "object" }, "oci:Core/IpsecConnectionTunnelManagementEncryptionDomainConfig:IpsecConnectionTunnelManagementEncryptionDomainConfig": { "properties": { "cpeTrafficSelectors": { "type": "array", "items": { "type": "string" }, "description": "Lists IPv4 or IPv6-enabled subnets in your on-premises network.\n" }, "oracleTrafficSelectors": { "type": "array", "items": { "type": "string" }, "description": "Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "cpeTrafficSelectors", "oracleTrafficSelectors" ] } } }, "oci:Core/IpsecConnectionTunnelManagementPhaseOneDetails:IpsecConnectionTunnelManagementPhaseOneDetails": { "properties": { "customAuthenticationAlgorithm": { "type": "string", "description": "The custom authentication algorithm proposed during phase one tunnel negotiation.\n" }, "customDhGroup": { "type": "string", "description": "The custom Diffie-Hellman group proposed during phase one tunnel negotiation.\n" }, "customEncryptionAlgorithm": { "type": "string", "description": "The custom encryption algorithm proposed during phase one tunnel negotiation.\n" }, "isCustomPhaseOneConfig": { "type": "boolean", "description": "Indicates whether custom configuration is enabled for phase one options.\n" }, "isIkeEstablished": { "type": "boolean", "description": "Indicates whether IKE phase one is established.\n" }, "lifetime": { "type": "integer", "description": "Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours.\n" }, "negotiatedAuthenticationAlgorithm": { "type": "string", "description": "The negotiated phase two authentication algorithm.\n" }, "negotiatedDhGroup": { "type": "string", "description": "The negotiated Diffie-Hellman group.\n" }, "negotiatedEncryptionAlgorithm": { "type": "string", "description": "The negotiated encryption algorithm.\n" }, "remainingLifetime": { "type": "string", "deprecationMessage": "The 'phase_one_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_one_details.0.remaining_lifetime_int' instead." }, "remainingLifetimeInt": { "type": "integer", "description": "The remaining lifetime before the key is refreshed.\n" }, "remainingLifetimeLastRetrieved": { "type": "string", "description": "The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customAuthenticationAlgorithm", "customDhGroup", "customEncryptionAlgorithm", "isCustomPhaseOneConfig", "isIkeEstablished", "lifetime", "negotiatedAuthenticationAlgorithm", "negotiatedDhGroup", "negotiatedEncryptionAlgorithm", "remainingLifetime", "remainingLifetimeInt", "remainingLifetimeLastRetrieved" ] } } }, "oci:Core/IpsecConnectionTunnelManagementPhaseTwoDetails:IpsecConnectionTunnelManagementPhaseTwoDetails": { "properties": { "customAuthenticationAlgorithm": { "type": "string", "description": "The authentication algorithm proposed during phase two tunnel negotiation.\n" }, "customEncryptionAlgorithm": { "type": "string", "description": "The encryption algorithm proposed during phase two tunnel negotiation.\n" }, "dhGroup": { "type": "string", "description": "The Diffie-Hellman group used for PFS, if PFS is enabled.\n" }, "isCustomPhaseTwoConfig": { "type": "boolean", "description": "Indicates whether custom configuration is enabled for phase two options.\n" }, "isEspEstablished": { "type": "boolean", "description": "Indicates that ESP phase two is established.\n" }, "isPfsEnabled": { "type": "boolean", "description": "Indicates whether perfect forward secrecy (PFS) is enabled.\n" }, "lifetime": { "type": "integer", "description": "Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour.\n" }, "negotiatedAuthenticationAlgorithm": { "type": "string", "description": "The negotiated phase two authentication algorithm.\n" }, "negotiatedDhGroup": { "type": "string", "description": "The negotiated Diffie-Hellman group.\n" }, "negotiatedEncryptionAlgorithm": { "type": "string", "description": "The negotiated encryption algorithm.\n" }, "remainingLifetime": { "type": "string", "deprecationMessage": "The 'phase_two_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_two_details.0.remaining_lifetime_int' instead." }, "remainingLifetimeInt": { "type": "integer", "description": "The remaining lifetime before the key is refreshed.\n" }, "remainingLifetimeLastRetrieved": { "type": "string", "description": "The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "customAuthenticationAlgorithm", "customEncryptionAlgorithm", "dhGroup", "isCustomPhaseTwoConfig", "isEspEstablished", "isPfsEnabled", "lifetime", "negotiatedAuthenticationAlgorithm", "negotiatedDhGroup", "negotiatedEncryptionAlgorithm", "remainingLifetime", "remainingLifetimeInt", "remainingLifetimeLastRetrieved" ] } } }, "oci:Core/IpsecTunnelConfiguration:IpsecTunnelConfiguration": { "properties": { "associatedVirtualCircuits": { "type": "array", "items": { "type": "string" } }, "drgRouteTableId": { "type": "string" }, "oracleTunnelIp": { "type": "string" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "associatedVirtualCircuits", "drgRouteTableId", "oracleTunnelIp" ] } } }, "oci:Core/NetworkSecurityGroupSecurityRuleIcmpOptions:NetworkSecurityGroupSecurityRuleIcmpOptions": { "properties": { "code": { "type": "integer", "description": "The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "The ICMP type.\n" } }, "type": "object", "required": [ "type" ] }, "oci:Core/NetworkSecurityGroupSecurityRuleTcpOptions:NetworkSecurityGroupSecurityRuleTcpOptions": { "properties": { "destinationPortRange": { "$ref": "#/types/oci:Core/NetworkSecurityGroupSecurityRuleTcpOptionsDestinationPortRange:NetworkSecurityGroupSecurityRuleTcpOptionsDestinationPortRange" }, "sourcePortRange": { "$ref": "#/types/oci:Core/NetworkSecurityGroupSecurityRuleTcpOptionsSourcePortRange:NetworkSecurityGroupSecurityRuleTcpOptionsSourcePortRange" } }, "type": "object" }, "oci:Core/NetworkSecurityGroupSecurityRuleTcpOptionsDestinationPortRange:NetworkSecurityGroupSecurityRuleTcpOptionsDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/NetworkSecurityGroupSecurityRuleTcpOptionsSourcePortRange:NetworkSecurityGroupSecurityRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/NetworkSecurityGroupSecurityRuleUdpOptions:NetworkSecurityGroupSecurityRuleUdpOptions": { "properties": { "destinationPortRange": { "$ref": "#/types/oci:Core/NetworkSecurityGroupSecurityRuleUdpOptionsDestinationPortRange:NetworkSecurityGroupSecurityRuleUdpOptionsDestinationPortRange" }, "sourcePortRange": { "$ref": "#/types/oci:Core/NetworkSecurityGroupSecurityRuleUdpOptionsSourcePortRange:NetworkSecurityGroupSecurityRuleUdpOptionsSourcePortRange" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "destinationPortRange", "sourcePortRange" ] } } }, "oci:Core/NetworkSecurityGroupSecurityRuleUdpOptionsDestinationPortRange:NetworkSecurityGroupSecurityRuleUdpOptionsDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/NetworkSecurityGroupSecurityRuleUdpOptionsSourcePortRange:NetworkSecurityGroupSecurityRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/RouteTableRouteRule:RouteTableRouteRule": { "properties": { "cidrBlock": { "type": "string", "description": "(Updatable) Deprecated. Instead use \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e and `destinationType`. Requests that include both `cidrBlock` and \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e will be rejected.\n\nA destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target).\n\nCannot be an IPv6 prefix.\n\nExample: `0.0.0.0/0`\n", "deprecationMessage": "The 'cidr_block' field has been deprecated. Please use 'destination' instead." }, "description": { "type": "string", "description": "(Updatable) An optional description of your choice for the rule.\n" }, "destination": { "type": "string", "description": "(Updatable) Conceptually, this is the range of IP addresses used for matching when routing traffic. Required if you provide a `destinationType`.\n\nAllowed values:\n* IP address range in CIDR notation. Can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. If you set this to an IPv6 prefix, the route rule's target can only be a DRG or internet gateway. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).\n* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/), if you're setting up a route rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.\n" }, "destinationType": { "type": "string", "description": "(Updatable) Type of destination for the rule. Required if you provide a \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e.\n* `CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e is an IP address range in CIDR notation.\n* `SERVICE_CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e is the `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/) (the rule is for traffic destined for a particular `Service` through a service gateway).\n" }, "networkEntityId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the route rule's target. For information about the type of targets you can specify, see [Route Tables](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).\n" }, "routeType": { "type": "string", "description": "(Updatable) A route rule can be STATIC if manually added to the route table, LOCAL if added by Oracle Cloud Infrastructure to the route table.\n" } }, "type": "object", "required": [ "networkEntityId" ], "language": { "nodejs": { "requiredOutputs": [ "cidrBlock", "description", "destination", "destinationType", "networkEntityId", "routeType" ] } } }, "oci:Core/SecurityListEgressSecurityRule:SecurityListEgressSecurityRule": { "properties": { "description": { "type": "string", "description": "(Updatable) An optional description of your choice for the rule.\n" }, "destination": { "type": "string", "description": "(Updatable) Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.\n\nAllowed values:\n* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56` Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).\n* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/), if you're setting up a security list rule for traffic destined for a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.\n" }, "destinationType": { "type": "string", "description": "(Updatable) Type of destination for the rule. The default is `CIDR_BLOCK`.\n\nAllowed values:\n* `CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e is an IP address range in CIDR notation.\n* `SERVICE_CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e is the `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/) (the rule is for traffic destined for a particular `Service` through a service gateway).\n" }, "icmpOptions": { "$ref": "#/types/oci:Core/SecurityListEgressSecurityRuleIcmpOptions:SecurityListEgressSecurityRuleIcmpOptions", "description": "(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n\nIf you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify multiple codes for a single type, create a separate security list rule for each.\n" }, "protocol": { "type": "string", "description": "(Updatable) The transport protocol. Specify either \u003cspan pulumi-lang-nodejs=\"`all`\" pulumi-lang-dotnet=\"`All`\" pulumi-lang-go=\"`all`\" pulumi-lang-python=\"`all`\" pulumi-lang-yaml=\"`all`\" pulumi-lang-java=\"`all`\" pulumi-lang-hcl=\"`all`\"\u003e`all`\u003c/span\u003e or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP (\"1\"), TCP (\"6\"), UDP (\"17\"), and ICMPv6 (\"58\").\n" }, "stateless": { "type": "boolean", "description": "(Updatable) A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.\n" }, "tcpOptions": { "$ref": "#/types/oci:Core/SecurityListEgressSecurityRuleTcpOptions:SecurityListEgressSecurityRuleTcpOptions", "description": "(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "udpOptions": { "$ref": "#/types/oci:Core/SecurityListEgressSecurityRuleUdpOptions:SecurityListEgressSecurityRuleUdpOptions", "description": "(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "destination", "protocol" ], "language": { "nodejs": { "requiredOutputs": [ "description", "destination", "destinationType", "protocol", "stateless" ] } } }, "oci:Core/SecurityListEgressSecurityRuleIcmpOptions:SecurityListEgressSecurityRuleIcmpOptions": { "properties": { "code": { "type": "integer", "description": "(Updatable) The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "(Updatable) The ICMP type.\n" } }, "type": "object", "required": [ "type" ] }, "oci:Core/SecurityListEgressSecurityRuleTcpOptions:SecurityListEgressSecurityRuleTcpOptions": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/SecurityListEgressSecurityRuleTcpOptionsSourcePortRange:SecurityListEgressSecurityRuleTcpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object" }, "oci:Core/SecurityListEgressSecurityRuleTcpOptionsSourcePortRange:SecurityListEgressSecurityRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/SecurityListEgressSecurityRuleUdpOptions:SecurityListEgressSecurityRuleUdpOptions": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/SecurityListEgressSecurityRuleUdpOptionsSourcePortRange:SecurityListEgressSecurityRuleUdpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object" }, "oci:Core/SecurityListEgressSecurityRuleUdpOptionsSourcePortRange:SecurityListEgressSecurityRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/SecurityListIngressSecurityRule:SecurityListIngressSecurityRule": { "properties": { "description": { "type": "string", "description": "(Updatable) An optional description of your choice for the rule.\n" }, "icmpOptions": { "$ref": "#/types/oci:Core/SecurityListIngressSecurityRuleIcmpOptions:SecurityListIngressSecurityRuleIcmpOptions", "description": "(Updatable) Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n\nIf you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 (\"Destination Unreachable\") code 4 (\"Fragmentation Needed and Don't Fragment was Set\"). If you need to specify multiple codes for a single type, create a separate security list rule for each.\n" }, "protocol": { "type": "string", "description": "(Updatable) The transport protocol. Specify either \u003cspan pulumi-lang-nodejs=\"`all`\" pulumi-lang-dotnet=\"`All`\" pulumi-lang-go=\"`all`\" pulumi-lang-python=\"`all`\" pulumi-lang-yaml=\"`all`\" pulumi-lang-java=\"`all`\" pulumi-lang-hcl=\"`all`\"\u003e`all`\u003c/span\u003e or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP (\"1\"), TCP (\"6\"), UDP (\"17\"), and ICMPv6 (\"58\").\n" }, "source": { "type": "string", "description": "(Updatable) Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.\n\nAllowed values:\n* IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).\n* The `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/), if you're setting up a security list rule for traffic coming from a particular `Service` through a service gateway. For example: `oci-phx-objectstorage`.\n" }, "sourceType": { "type": "string", "description": "(Updatable) Type of source for the rule. The default is `CIDR_BLOCK`.\n* `CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is an IP address range in CIDR notation.\n* `SERVICE_CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is the `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/) (the rule is for traffic coming from a particular `Service` through a service gateway).\n" }, "stateless": { "type": "boolean", "description": "(Updatable) A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if ingress traffic allows TCP destination port 80, there should be an egress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.\n" }, "tcpOptions": { "$ref": "#/types/oci:Core/SecurityListIngressSecurityRuleTcpOptions:SecurityListIngressSecurityRuleTcpOptions", "description": "(Updatable) Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "udpOptions": { "$ref": "#/types/oci:Core/SecurityListIngressSecurityRuleUdpOptions:SecurityListIngressSecurityRuleUdpOptions", "description": "(Updatable) Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "protocol", "source" ], "language": { "nodejs": { "requiredOutputs": [ "description", "protocol", "source", "sourceType" ] } } }, "oci:Core/SecurityListIngressSecurityRuleIcmpOptions:SecurityListIngressSecurityRuleIcmpOptions": { "properties": { "code": { "type": "integer", "description": "(Updatable) The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "(Updatable) The ICMP type.\n" } }, "type": "object", "required": [ "type" ] }, "oci:Core/SecurityListIngressSecurityRuleTcpOptions:SecurityListIngressSecurityRuleTcpOptions": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/SecurityListIngressSecurityRuleTcpOptionsSourcePortRange:SecurityListIngressSecurityRuleTcpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object" }, "oci:Core/SecurityListIngressSecurityRuleTcpOptionsSourcePortRange:SecurityListIngressSecurityRuleTcpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/SecurityListIngressSecurityRuleUdpOptions:SecurityListIngressSecurityRuleUdpOptions": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" }, "sourcePortRange": { "$ref": "#/types/oci:Core/SecurityListIngressSecurityRuleUdpOptionsSourcePortRange:SecurityListIngressSecurityRuleUdpOptionsSourcePortRange", "description": "(Updatable)\n" } }, "type": "object" }, "oci:Core/SecurityListIngressSecurityRuleUdpOptionsSourcePortRange:SecurityListIngressSecurityRuleUdpOptionsSourcePortRange": { "properties": { "max": { "type": "integer", "description": "(Updatable) The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "(Updatable) The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ] }, "oci:Core/ServiceGatewayService:ServiceGatewayService": { "properties": { "serviceId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/).\n" }, "serviceName": { "type": "string", "description": "The name of the service.\n" } }, "type": "object", "required": [ "serviceId" ], "language": { "nodejs": { "requiredOutputs": [ "serviceId", "serviceName" ] } } }, "oci:Core/VcnByoipv6cidrDetail:VcnByoipv6cidrDetail": { "properties": { "byoipv6rangeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.\n" }, "ipv6cidrBlock": { "type": "string", "description": "An IPv6 prefix required to create a VCN with a BYOIP prefix. It could be the whole prefix identified in `byoipv6RangeId`, or a subrange. Example: `2001:0db8:0123::/48` \n\nWhen updating \u003cspan pulumi-lang-nodejs=\"`byoipv6cidrDetails`\" pulumi-lang-dotnet=\"`Byoipv6cidrDetails`\" pulumi-lang-go=\"`byoipv6cidrDetails`\" pulumi-lang-python=\"`byoipv6cidr_details`\" pulumi-lang-yaml=\"`byoipv6cidrDetails`\" pulumi-lang-java=\"`byoipv6cidrDetails`\" pulumi-lang-hcl=\"`byoipv6cidr_details`\"\u003e`byoipv6cidrDetails`\u003c/span\u003e, Terraform can add, remove, or replace multiple BYO IPv6 CIDR entries in a single `pulumi up`. This means you can update several BYO IPv6 prefixes at once instead of being limited to a single list edit per apply.\n" } }, "type": "object", "required": [ "byoipv6rangeId", "ipv6cidrBlock" ] }, "oci:Core/VirtualCircuitCrossConnectMapping:VirtualCircuitCrossConnectMapping": { "properties": { "bgpMd5authKey": { "type": "string", "description": "(Updatable) The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don't use BGP MD5 authentication.\n" }, "crossConnectOrCrossConnectGroupId": { "type": "string", "description": "(Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider).\n" }, "customerBgpPeeringIp": { "type": "string", "description": "(Updatable) The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider's edge router. Must use a subnet mask from /28 to /31.\n\nThere's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.\n\nExample: `10.0.0.18/31`\n" }, "customerBgpPeeringIpv6": { "type": "string", "description": "(Updatable) IPv6 is currently supported only in the Government Cloud. The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer's edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider's edge router. Only subnet masks from /64 up to /127 are allowed.\n\nThere's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.\n\nIPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).\n\nExample: `2001:db8::1/64`\n" }, "oracleBgpPeeringIp": { "type": "string", "description": "(Updatable) The IPv4 address for Oracle's end of the BGP session. Must use a subnet mask from /28 to /31. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.\n\nThere's one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses.\n\nExample: `10.0.0.19/31`\n" }, "oracleBgpPeeringIpv6": { "type": "string", "description": "(Updatable) IPv6 is currently supported only in the Government Cloud. The IPv6 address for Oracle's end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer's edge router, the customer specifies this information. If the session goes from Oracle to a provider's edge router, the provider specifies this.\n\nThere's one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses.\n\nNote that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).\n\nExample: `2001:db8::2/64`\n" }, "vlan": { "type": "integer", "description": "(Updatable) The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: \u003cspan pulumi-lang-nodejs=\"`200`\" pulumi-lang-dotnet=\"`200`\" pulumi-lang-go=\"`200`\" pulumi-lang-python=\"`200`\" pulumi-lang-yaml=\"`200`\" pulumi-lang-java=\"`200`\" pulumi-lang-hcl=\"`200`\"\u003e`200`\u003c/span\u003e\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "bgpMd5authKey", "crossConnectOrCrossConnectGroupId", "customerBgpPeeringIp", "customerBgpPeeringIpv6", "oracleBgpPeeringIp", "oracleBgpPeeringIpv6", "vlan" ] } } }, "oci:Core/VirtualCircuitPublicPrefix:VirtualCircuitPublicPrefix": { "properties": { "cidrBlock": { "type": "string", "description": "(Updatable) An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed.\n" } }, "type": "object", "required": [ "cidrBlock" ] }, "oci:Core/VirtualCircuitVirtualCircuitRedundancyMetadata:VirtualCircuitVirtualCircuitRedundancyMetadata": { "properties": { "configuredRedundancyLevel": { "type": "string", "description": "The configured redundancy level of the virtual circuit.\n" }, "ipv4bgpSessionRedundancyStatus": { "type": "string", "description": "Indicates if the configured level is met for IPv4 BGP redundancy.\n" }, "ipv6bgpSessionRedundancyStatus": { "type": "string", "description": "Indicates if the configured level is met for IPv6 BGP redundancy.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "configuredRedundancyLevel", "ipv4bgpSessionRedundancyStatus", "ipv6bgpSessionRedundancyStatus" ] } } }, "oci:Core/VirtualNetworkByoipv6cidrDetail:VirtualNetworkByoipv6cidrDetail": { "properties": { "byoipv6rangeId": { "type": "string" }, "ipv6cidrBlock": { "type": "string" } }, "type": "object", "required": [ "byoipv6rangeId", "ipv6cidrBlock" ] }, "oci:Core/VnicAttachmentCreateVnicDetails:VnicAttachmentCreateVnicDetails": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n", "willReplaceOnChanges": true }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a DNS record. If set to false, no DNS record registion for the VNIC; if set to true, DNS record will be registered. Example: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n\nIf you specify a `hostnameLabel`, the `assignPrivateDnsRecord` is require to be set to true.\n", "willReplaceOnChanges": true }, "assignPublicIp": { "type": "string", "description": "Whether the VNIC should be assigned a public IP address. Defaults to whether the subnet is public or private. If not set and the VNIC is being created in a private subnet (that is, where `prohibitPublicIpOnVnic` = true in the [Subnet](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Subnet/)), then no public IP address is assigned. If not set and the subnet is public (`prohibitPublicIpOnVnic` = false), then a public IP address is assigned. If set to true and `prohibitPublicIpOnVnic` = true, an error is returned.\n\n**Note:** This public IP address is associated with the primary private IP on the VNIC. For more information, see [IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n\n**Note:** There's a limit to the number of [public IPs](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PublicIp/) a VNIC or instance can have. If you try to create a secondary VNIC with an assigned public IP for an instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see [Public IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\nExample: \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n\nIf you specify a `vlanId`, then `assignPublicIp` must be set to false. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n", "willReplaceOnChanges": true }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "(Updatable) The hostname for the VNIC's primary private IP. Used for DNS. The value is the hostname portion of the primary private IP's fully qualified domain name (FQDN) (for example, \u003cspan pulumi-lang-nodejs=\"`bminstance1`\" pulumi-lang-dotnet=\"`Bminstance1`\" pulumi-lang-go=\"`bminstance1`\" pulumi-lang-python=\"`bminstance1`\" pulumi-lang-yaml=\"`bminstance1`\" pulumi-lang-java=\"`bminstance1`\" pulumi-lang-hcl=\"`bminstance1`\"\u003e`bminstance1`\u003c/span\u003e in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n\nFor more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).\n\nWhen launching an instance, use this `hostnameLabel` instead of the deprecated `hostnameLabel` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). If you provide both, the values must match.\n\nExample: \u003cspan pulumi-lang-nodejs=\"`bminstance1`\" pulumi-lang-dotnet=\"`Bminstance1`\" pulumi-lang-go=\"`bminstance1`\" pulumi-lang-python=\"`bminstance1`\" pulumi-lang-yaml=\"`bminstance1`\" pulumi-lang-java=\"`bminstance1`\" pulumi-lang-hcl=\"`bminstance1`\"\u003e`bminstance1`\u003c/span\u003e\n\nIf you specify a `vlanId`, the `hostnameLabel` cannot be specified. VNICs on a VLAN can not be assigned a hostname. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/VnicAttachmentCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:VnicAttachmentCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC is assigned an IPv6 address. You can provide only the prefix ranges from which Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address within that range to use.\n", "willReplaceOnChanges": true }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "(Updatable) A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n\nIf a `vlanId` is specified, the `nsgIds` cannot be specified. The `vlanId` indicates that the VNIC will belong to a VLAN instead of a subnet. With VLANs, all VNICs in the VLAN belong to the NSGs that are associated with the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. If you don't specify a value, Oracle automatically assigns a private IP address from the subnet. This is the VNIC's *primary* private IP address. The value appears in the [Vnic](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vnic/) object and also the [PrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/PrivateIp/GetPrivateIp).\n\nIf you specify a `vlanId`, the `privateIp` cannot be specified. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nIf you specify a 'privateIpId', the 'privateIp' cannot be specified.\n\nExample: `10.0.3.3`\n", "willReplaceOnChanges": true }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC.\n", "willReplaceOnChanges": true }, "routeTableId": { "type": "string" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR.MaxEgressCount.value\": \"42\", \"Oracle-DataSecurity-ZPR.MaxEgressCount.mode\": \"audit\"}`\n", "willReplaceOnChanges": true }, "skipSourceDestCheck": { "type": "boolean", "description": "(Updatable) Whether the source/destination check is disabled on the VNIC. Defaults to \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e, which means the check is performed. For information about why you would skip the source/destination check, see [Using a Private IP as a Route Target](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip).\n\nIf you specify a `vlanId`, the `skipSourceDestCheck` cannot be specified because the source/destination check is always disabled for VNICs in a VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nExample: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28`\n", "willReplaceOnChanges": true }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet to create the VNIC in. When launching an instance, use this `subnetId` instead of the deprecated `subnetId` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/requests/LaunchInstanceDetails). At least one of them is required; if you provide both, the values must match.\n\nIf you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN instead of a subnet, provide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails.\n", "willReplaceOnChanges": true }, "vlanId": { "type": "string", "description": "Provide this attribute only if you are an Oracle Cloud VMware Solution customer and creating a secondary VNIC in a VLAN. The value is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Vlan).\n\nProvide a `vlanId` instead of a `subnetId`. If you provide both a `vlanId` and `subnetId`, the request fails.\n", "willReplaceOnChanges": true } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "assignIpv6ip", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId", "vlanId" ] } } }, "oci:Core/VnicAttachmentCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail:VnicAttachmentCreateVnicDetailsIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "An IPv6 address of your choice. Must be an available IPv6 address within the subnet's prefix. If an IPv6 address is not provided:\n* Oracle will automatically assign an IPv6 address from the subnet's IPv6 prefix if and only if there is only one IPv6 prefix on the subnet.\n* Oracle will automatically assign an IPv6 address from the subnet's IPv6 Oracle GUA prefix if it exists on the subnet.\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n", "willReplaceOnChanges": true }, "ipv6subnetCidr": { "type": "string", "description": "The IPv6 prefix allocated to the subnet.\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv6id" ] } } }, "oci:Core/VolumeAttachmentMultipathDevice:VolumeAttachmentMultipathDevice": { "properties": { "ipv4": { "type": "string", "description": "The volume's iSCSI IP address. Example: `169.254.2.2`\n" }, "iqn": { "type": "string", "description": "The target volume's iSCSI Qualified Name in the format defined by [RFC 3720](https://tools.ietf.org/html/rfc3720#page-32). Example: `iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195`\n" }, "port": { "type": "integer", "description": "The volume's iSCSI port, usually port 860 or 3260. Example: \u003cspan pulumi-lang-nodejs=\"`3260`\" pulumi-lang-dotnet=\"`3260`\" pulumi-lang-go=\"`3260`\" pulumi-lang-python=\"`3260`\" pulumi-lang-yaml=\"`3260`\" pulumi-lang-java=\"`3260`\" pulumi-lang-hcl=\"`3260`\"\u003e`3260`\u003c/span\u003e\n" } }, "type": "object", "language": { "nodejs": { "requiredOutputs": [ "ipv4", "iqn", "port" ] } } }, "oci:Core/VolumeAutotunePolicy:VolumeAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "(Updatable) This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "(Updatable) This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType" ], "language": { "nodejs": { "requiredOutputs": [ "autotuneType", "maxVpusPerGb" ] } } }, "oci:Core/VolumeBackupPolicySchedule:VolumeBackupPolicySchedule": { "properties": { "backupType": { "type": "string", "description": "(Updatable) The type of volume backup to create.\n" }, "dayOfMonth": { "type": "integer", "description": "(Updatable) The day of the month to schedule the volume backup.\n" }, "dayOfWeek": { "type": "string", "description": "(Updatable) The day of the week to schedule the volume backup.\n" }, "hourOfDay": { "type": "integer", "description": "(Updatable) The hour of the day to schedule the volume backup.\n" }, "month": { "type": "string", "description": "(Updatable) The month of the year to schedule the volume backup.\n" }, "offsetSeconds": { "type": "integer", "description": "(Updatable) The number of seconds that the volume backup start time should be shifted from the default interval boundaries specified by the period. The volume backup start time is the frequency start time plus the offset.\n" }, "offsetType": { "type": "string", "description": "(Updatable) Indicates how the offset is defined. If value is `STRUCTURED`, then `hourOfDay`, `dayOfWeek`, `dayOfMonth`, and \u003cspan pulumi-lang-nodejs=\"`month`\" pulumi-lang-dotnet=\"`Month`\" pulumi-lang-go=\"`month`\" pulumi-lang-python=\"`month`\" pulumi-lang-yaml=\"`month`\" pulumi-lang-java=\"`month`\" pulumi-lang-hcl=\"`month`\"\u003e`month`\u003c/span\u003e fields are used and `offsetSeconds` will be ignored in requests and users should ignore its value from the responses.\n\n`hourOfDay` is applicable for periods `ONE_DAY`, `ONE_WEEK`, `ONE_MONTH` and `ONE_YEAR`.\n\n`dayOfWeek` is applicable for period `ONE_WEEK`.\n\n`dayOfMonth` is applicable for periods `ONE_MONTH` and `ONE_YEAR`.\n\n'month' is applicable for period 'ONE_YEAR'.\n\nThey will be ignored in the requests for inapplicable periods.\n\nIf value is `NUMERIC_SECONDS`, then `offsetSeconds` will be used for both requests and responses and the structured fields will be ignored in the requests and users should ignore their values from the responses.\n\nFor clients using older versions of Apis and not sending `offsetType` in their requests, the behaviour is just like `NUMERIC_SECONDS`.\n" }, "period": { "type": "string", "description": "(Updatable) The volume backup frequency.\n" }, "retentionSeconds": { "type": "integer", "description": "(Updatable) How long, in seconds, to keep the volume backups created by this schedule.\n" }, "timeZone": { "type": "string", "description": "(Updatable) Specifies what time zone is the schedule in\nenum:\n- `UTC`\n- `REGIONAL_DATA_CENTER_TIME`\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n" } }, "type": "object", "required": [ "backupType", "period", "retentionSeconds" ], "language": { "nodejs": { "requiredOutputs": [ "backupType", "period", "retentionSeconds", "timeZone" ] } } }, "oci:Core/VolumeBackupSourceDetails:VolumeBackupSourceDetails": { "properties": { "kmsKeyId": { "type": "string", "description": "The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.\n", "willReplaceOnChanges": true }, "region": { "type": "string", "description": "The region of the volume backup source.\n", "willReplaceOnChanges": true }, "volumeBackupId": { "type": "string", "description": "The OCID of the source volume backup.\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "region", "volumeBackupId" ] }, "oci:Core/VolumeBlockVolumeReplica:VolumeBlockVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain of the block volume replica. Example: `Uocm:PHX-AD-1`\n" }, "blockVolumeReplicaId": { "type": "string", "description": "The block volume replica's Oracle ID (OCID).\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "kmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "xrrKmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Vault service key which is the master encryption key for the cross region block volume replicas, which will be used in the destination region to encrypt the block volume replica's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "blockVolumeReplicaId", "displayName", "kmsKeyId", "xrrKmsKeyId" ] } } }, "oci:Core/VolumeGroupBackupSourceDetails:VolumeGroupBackupSourceDetails": { "properties": { "kmsKeyId": { "type": "string", "description": "The OCID of the KMS key in the destination region which will be the master encryption key for the copied volume backup.\n", "willReplaceOnChanges": true }, "region": { "type": "string", "description": "The region of the volume backup source.\n", "willReplaceOnChanges": true }, "volumeGroupBackupId": { "type": "string", "description": "The OCID of the source volume group backup.\n\n\n\n** IMPORTANT **\nAny change to a property that does not support update will force the destruction and recreation of the resource with the new property values\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "region", "volumeGroupBackupId" ] }, "oci:Core/VolumeGroupSourceDetails:VolumeGroupSourceDetails": { "properties": { "type": { "type": "string", "description": "The type can be one of these values: `volumeGroupBackupId`, `volumeGroupId`, `volumeGroupReplicaId`, `volumeIds`\n", "willReplaceOnChanges": true }, "volumeGroupBackupId": { "type": "string", "description": "The OCID of the volume group backup to restore from.\n", "willReplaceOnChanges": true }, "volumeGroupId": { "type": "string", "description": "The OCID of the volume group to clone from.\n", "willReplaceOnChanges": true }, "volumeGroupReplicaId": { "type": "string", "description": "The OCID of the volume group replica.\n", "willReplaceOnChanges": true }, "volumeIds": { "type": "array", "items": { "type": "string" }, "description": "OCIDs for the volumes used to create this volume group.\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "oci:Core/VolumeGroupVolumeGroupReplica:VolumeGroupVolumeGroupReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "(Updatable) The availability domain of the volume group replica. Example: `Uocm:PHX-AD-1`\n" }, "displayName": { "type": "string", "description": "(Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "volumeGroupReplicaId": { "type": "string", "description": "The volume group replica's Oracle ID (OCID).\n" }, "xrrKmsKeyId": { "type": "string", "description": "(Updatable) The OCID of the Vault service key which is the master encryption key for the cross region volume group's replicas, which will be used in the destination region to encrypt the volume group's replicas encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "availabilityDomain" ], "language": { "nodejs": { "requiredOutputs": [ "availabilityDomain", "displayName", "volumeGroupReplicaId", "xrrKmsKeyId" ] } } }, "oci:Core/VolumeSourceDetails:VolumeSourceDetails": { "properties": { "changeBlockSizeInBytes": { "type": "string", "description": "Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).\n", "willReplaceOnChanges": true }, "firstBackupId": { "type": "string", "description": "The OCID of the first volume backup.\n", "willReplaceOnChanges": true }, "id": { "type": "string", "description": "The OCID of the block volume replica.\n", "willReplaceOnChanges": true }, "secondBackupId": { "type": "string", "description": "The OCID of the second volume backup.\n", "willReplaceOnChanges": true }, "type": { "type": "string", "description": "The type can be one of these values: `blockVolumeReplica`, \u003cspan pulumi-lang-nodejs=\"`volume`\" pulumi-lang-dotnet=\"`Volume`\" pulumi-lang-go=\"`volume`\" pulumi-lang-python=\"`volume`\" pulumi-lang-yaml=\"`volume`\" pulumi-lang-java=\"`volume`\" pulumi-lang-hcl=\"`volume`\"\u003e`volume`\u003c/span\u003e, `volumeBackup`, `volumeBackupDelta`\n", "willReplaceOnChanges": true } }, "type": "object", "required": [ "type" ] }, "oci:Core/getAppCatalogListingResourceVersionsAppCatalogListingResourceVersion:getAppCatalogListingResourceVersionsAppCatalogListingResourceVersion": { "properties": { "accessiblePorts": { "type": "array", "items": { "type": "integer" }, "description": "List of accessible ports for instances launched with this listing resource version.\n" }, "allowedActions": { "type": "array", "items": { "type": "string" }, "description": "Allowed actions for the listing resource.\n" }, "availableRegions": { "type": "array", "items": { "type": "string" }, "description": "List of regions that this listing resource version is available.\n" }, "compatibleShapes": { "type": "array", "items": { "type": "string" }, "description": "Array of shapes compatible with this resource.\n" }, "listingId": { "type": "string", "description": "The OCID of the listing.\n" }, "listingResourceId": { "type": "string", "description": "OCID of the listing resource.\n" }, "listingResourceVersion": { "type": "string", "description": "Resource Version.\n" }, "timePublished": { "type": "string", "description": "Date and time the listing resource version was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. Example: `2018-03-20T12:32:53.532Z`\n" } }, "type": "object", "required": [ "accessiblePorts", "allowedActions", "availableRegions", "compatibleShapes", "listingId", "listingResourceId", "listingResourceVersion", "timePublished" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getAppCatalogListingResourceVersionsFilter:getAppCatalogListingResourceVersionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getAppCatalogListingsAppCatalogListing:getAppCatalogListingsAppCatalogListing": { "properties": { "contactUrl": { "type": "string", "description": "Listing's contact URL.\n" }, "description": { "type": "string", "description": "Description of the listing.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "listingId": { "type": "string", "description": "the region free ocid of the listing resource.\n" }, "publisherLogoUrl": { "type": "string", "description": "Publisher's logo URL.\n" }, "publisherName": { "type": "string", "description": "A filter to return only the publisher that matches the given publisher name exactly.\n" }, "summary": { "type": "string", "description": "The short summary for the listing.\n" }, "timePublished": { "type": "string", "description": "Date and time the listing was published, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. Example: `2018-03-20T12:32:53.532Z`\n" } }, "type": "object", "required": [ "contactUrl", "description", "displayName", "listingId", "publisherLogoUrl", "publisherName", "summary", "timePublished" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getAppCatalogListingsFilter:getAppCatalogListingsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getAppCatalogSubscriptionsAppCatalogSubscription:getAppCatalogSubscriptionsAppCatalogSubscription": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "eulaLink": { "type": "string" }, "listingId": { "type": "string", "description": "A filter to return only the listings that matches the given listing id.\n" }, "listingResourceId": { "type": "string", "description": "Listing resource id.\n" }, "listingResourceVersion": { "type": "string", "description": "Listing resource version.\n" }, "oracleTermsOfUseLink": { "type": "string" }, "publisherName": { "type": "string", "description": "Name of the publisher who published this listing.\n" }, "signature": { "type": "string" }, "summary": { "type": "string", "description": "The short summary to the listing.\n" }, "timeCreated": { "type": "string", "description": "Date and time at which the subscription was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format. Example: `2018-03-20T12:32:53.532Z`\n" }, "timeRetrieved": { "type": "string" } }, "type": "object", "required": [ "compartmentId", "displayName", "listingId", "listingResourceId", "listingResourceVersion", "oracleTermsOfUseLink", "publisherName", "signature", "summary", "timeCreated", "timeRetrieved" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getAppCatalogSubscriptionsFilter:getAppCatalogSubscriptionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getBlockVolumeReplicasBlockVolumeReplica:getBlockVolumeReplicasBlockVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "blockVolumeId": { "type": "string", "description": "The OCID of the source block volume.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The block volume replica's Oracle ID (OCID).\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the block volume replica, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" }, "sizeInGbs": { "type": "string", "description": "The size of the source block volume, in GBs.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the block volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "timeLastSynced": { "type": "string", "description": "The date and time the block volume replica was last synced from the source block volume. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "volumeGroupReplicaId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the volume group replica.\n" } }, "type": "object", "required": [ "availabilityDomain", "blockVolumeId", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "kmsKeyId", "sizeInGbs", "state", "timeCreated", "timeLastSynced", "volumeGroupReplicaId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBlockVolumeReplicasFilter:getBlockVolumeReplicasFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getBootVolumeAttachmentsBootVolumeAttachment:getBootVolumeAttachmentsBootVolumeAttachment": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "encryptionInTransitType": { "type": "string", "description": "Refer the top-level definition of encryptionInTransitType. The default value is NONE.\n" }, "id": { "type": "string", "description": "The OCID of the boot volume attachment.\n" }, "instanceId": { "type": "string", "description": "The OCID of the instance.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Whether in-transit encryption for the boot volume's paravirtualized attachment is enabled or not.\n" }, "state": { "type": "string", "description": "The current state of the boot volume attachment.\n" }, "timeCreated": { "type": "string", "description": "The date and time the boot volume was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the boot volume attachment was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "bootVolumeId", "compartmentId", "displayName", "encryptionInTransitType", "id", "instanceId", "isPvEncryptionInTransitEnabled", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeAttachmentsFilter:getBootVolumeAttachmentsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getBootVolumeAutotunePolicy:getBootVolumeAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType", "maxVpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeBackupSourceDetail:getBootVolumeBackupSourceDetail": { "properties": { "bootVolumeBackupId": { "type": "string", "description": "The OCID of the boot volume backup.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" }, "region": { "type": "string" } }, "type": "object", "required": [ "bootVolumeBackupId", "kmsKeyId", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeBackupsBootVolumeBackup:getBootVolumeBackupsBootVolumeBackup": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "expirationTime": { "type": "string", "description": "The date and time the volume backup will expire and be automatically deleted. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the boot volume backup.\n" }, "imageId": { "type": "string", "description": "The image OCID used to create the boot volume the backup is taken from.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" }, "sizeInGbs": { "type": "string", "description": "The size of the boot volume, in GBs.\n" }, "sourceBootVolumeBackupId": { "type": "string", "description": "A filter to return only resources that originated from the given source boot volume backup.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getBootVolumeBackupsBootVolumeBackupSourceDetail:getBootVolumeBackupsBootVolumeBackupSourceDetail" } }, "sourceType": { "type": "string", "description": "Specifies whether the backup was created manually, or via scheduled backup policy.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the boot volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "timeRequestReceived": { "type": "string", "description": "The date and time the request to create the boot volume backup was received. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "type": { "type": "string", "description": "The type of a volume backup. Supported values are 'FULL' or 'INCREMENTAL'.\n" }, "uniqueSizeInGbs": { "type": "string", "description": "The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the boot volume and whether the backup is full or incremental.\n" } }, "type": "object", "required": [ "bootVolumeId", "compartmentId", "definedTags", "displayName", "expirationTime", "freeformTags", "id", "imageId", "kmsKeyId", "sizeInGbs", "sourceBootVolumeBackupId", "sourceDetails", "sourceType", "state", "systemTags", "timeCreated", "timeRequestReceived", "type", "uniqueSizeInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeBackupsBootVolumeBackupSourceDetail:getBootVolumeBackupsBootVolumeBackupSourceDetail": { "properties": { "bootVolumeBackupId": { "type": "string" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service master encryption assigned to the boot volume backup. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" }, "region": { "type": "string" } }, "type": "object", "required": [ "bootVolumeBackupId", "kmsKeyId", "region" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeBackupsFilter:getBootVolumeBackupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getBootVolumeBootVolumeReplica:getBootVolumeBootVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the boot volume replica. Example: `Uocm:PHX-AD-1`\n" }, "bootVolumeReplicaId": { "type": "string", "description": "The boot volume replica's Oracle ID (OCID).\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service master encryption key assigned to the boot volume.\n" }, "xrrKmsKeyId": { "type": "string" } }, "type": "object", "required": [ "availabilityDomain", "bootVolumeReplicaId", "displayName", "kmsKeyId", "xrrKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeReplicasBootVolumeReplica:getBootVolumeReplicasBootVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "bootVolumeId": { "type": "string", "description": "The OCID of the source boot volume.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The boot volume replica's Oracle ID (OCID).\n" }, "imageId": { "type": "string", "description": "The image OCID used to create the boot volume the replica is replicated from.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the boot volume replica, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" }, "sizeInGbs": { "type": "string", "description": "The size of the source boot volume, in GBs.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the boot volume replica was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "timeLastSynced": { "type": "string", "description": "The date and time the boot volume replica was last synced from the source boot volume. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "volumeGroupReplicaId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the volume group replica.\n" } }, "type": "object", "required": [ "availabilityDomain", "bootVolumeId", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "imageId", "kmsKeyId", "sizeInGbs", "state", "timeCreated", "timeLastSynced", "volumeGroupReplicaId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumeReplicasFilter:getBootVolumeReplicasFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getBootVolumeSourceDetail:getBootVolumeSourceDetail": { "properties": { "changeBlockSizeInBytes": { "type": "string", "description": "(Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).\n" }, "firstBackupId": { "type": "string", "description": "(Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.\n" }, "id": { "type": "string", "description": "(Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.\n" }, "secondBackupId": { "type": "string", "description": "(Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.\n" }, "type": { "type": "string", "description": "(Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`\n" } }, "type": "object", "required": [ "changeBlockSizeInBytes", "firstBackupId", "id", "secondBackupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumesBootVolume:getBootVolumesBootVolume": { "properties": { "autoTunedVpusPerGb": { "type": "string", "description": "The number of Volume Performance Units per GB that this boot volume is effectively tuned to.\n" }, "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/getBootVolumesBootVolumeAutotunePolicy:getBootVolumesBootVolumeAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n" }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "backupPolicyId": { "type": "string", "deprecationMessage": "The 'backup_policy_id' field has been deprecated. Please use the 'oci_core_volume_backup_policy_assignment' resource instead." }, "bootVolumeReplicas": { "type": "array", "items": { "$ref": "#/types/oci:Core/getBootVolumesBootVolumeBootVolumeReplica:getBootVolumesBootVolumeBootVolumeReplica" }, "description": "The list of boot volume replicas of this boot volume\n" }, "bootVolumeReplicasDeletion": { "type": "boolean" }, "clusterPlacementGroupId": { "type": "string", "description": "The clusterPlacementGroup Id of the volume for volume placement.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "(Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.\n" }, "imageId": { "type": "string", "description": "The image OCID used to create the boot volume.\n" }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `DetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n" }, "isHydrated": { "type": "boolean", "description": "Specifies whether the boot volume's data has finished copying from the source boot volume or boot volume backup.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service master encryption key assigned to the boot volume.\n" }, "sizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs.\n" }, "sizeInMbs": { "type": "string", "description": "The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use \u003cspan pulumi-lang-nodejs=\"`sizeInGbs`\" pulumi-lang-dotnet=\"`SizeInGbs`\" pulumi-lang-go=\"`sizeInGbs`\" pulumi-lang-python=\"`size_in_gbs`\" pulumi-lang-yaml=\"`sizeInGbs`\" pulumi-lang-java=\"`sizeInGbs`\" pulumi-lang-hcl=\"`size_in_gbs`\"\u003e`sizeInGbs`\u003c/span\u003e.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getBootVolumesBootVolumeSourceDetail:getBootVolumesBootVolumeSourceDetail" } }, "state": { "type": "string", "description": "The current state of a boot volume.\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the boot volume was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "volumeGroupId": { "type": "string", "description": "The OCID of the volume group.\n" }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this boot volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "xrcKmsKeyId": { "type": "string" } }, "type": "object", "required": [ "autoTunedVpusPerGb", "autotunePolicies", "availabilityDomain", "backupPolicyId", "bootVolumeReplicas", "bootVolumeReplicasDeletion", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "imageId", "isAutoTuneEnabled", "isHydrated", "kmsKeyId", "sizeInGbs", "sizeInMbs", "sourceDetails", "state", "systemTags", "timeCreated", "volumeGroupId", "vpusPerGb", "xrcKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumesBootVolumeAutotunePolicy:getBootVolumesBootVolumeAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType", "maxVpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumesBootVolumeBootVolumeReplica:getBootVolumesBootVolumeBootVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "bootVolumeReplicaId": { "type": "string", "description": "The boot volume replica's Oracle ID (OCID).\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service master encryption key assigned to the boot volume.\n" }, "xrrKmsKeyId": { "type": "string" } }, "type": "object", "required": [ "availabilityDomain", "bootVolumeReplicaId", "displayName", "kmsKeyId", "xrrKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumesBootVolumeSourceDetail:getBootVolumesBootVolumeSourceDetail": { "properties": { "changeBlockSizeInBytes": { "type": "string", "description": "(Applicable when type=bootVolumeBackupDelta) Block size in bytes to be considered while performing volume restore. The value must be a power of 2; ranging from 4KB (4096 bytes) to 1MB (1048576 bytes). If omitted, defaults to 4,096 bytes (4 KiB).\n" }, "firstBackupId": { "type": "string", "description": "(Required when type=bootVolumeBackupDelta) The OCID of the first boot volume backup.\n" }, "id": { "type": "string", "description": "(Required when type=bootVolume | bootVolumeBackup | bootVolumeReplica) The OCID of the boot volume replica.\n" }, "secondBackupId": { "type": "string", "description": "(Required when type=bootVolumeBackupDelta) The OCID of the second boot volume backup.\n" }, "type": { "type": "string", "description": "(Required) The type can be one of these values: `bootVolume`, `bootVolumeBackup`, `bootVolumeBackupDelta`, `bootVolumeReplica`\n" } }, "type": "object", "required": [ "changeBlockSizeInBytes", "firstBackupId", "id", "secondBackupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getBootVolumesFilter:getBootVolumesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getByoasnByoipRange:getByoasnByoipRange": { "properties": { "asPathPrependLength": { "type": "integer", "description": "The as path prepend length.\n" }, "byoipRangeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.\n" }, "cidrBlock": { "type": "string", "description": "The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.\n" }, "ipv6cidrBlock": { "type": "string", "description": "The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.\n" } }, "type": "object", "required": [ "asPathPrependLength", "byoipRangeId", "cidrBlock", "ipv6cidrBlock" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoasnsByoasnCollection:getByoasnsByoasnCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getByoasnsByoasnCollectionItem:getByoasnsByoasnCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoasnsByoasnCollectionItem:getByoasnsByoasnCollectionItem": { "properties": { "asn": { "type": "string", "description": "The Autonomous System Number (ASN) you are importing to the Oracle cloud.\n" }, "byoipRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getByoasnsByoasnCollectionItemByoipRange:getByoasnsByoasnCollectionItemByoipRange" }, "description": "The BYOIP Ranges that has the `Byoasn` as origin.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, "timeCreated": { "type": "string", "description": "The date and time the `Byoasn` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the `Byoasn` resource was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeValidated": { "type": "string", "description": "The date and time the `Byoasn` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "validationToken": { "type": "string", "description": "The validation token is an internally-generated ASCII string used in the validation process. See [Importing a Byoasn](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOASN.htm) for details.\n" } }, "type": "object", "required": [ "asn", "byoipRanges", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "state", "timeCreated", "timeUpdated", "timeValidated", "validationToken" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoasnsByoasnCollectionItemByoipRange:getByoasnsByoasnCollectionItemByoipRange": { "properties": { "asPathPrependLength": { "type": "integer", "description": "The as path prepend length.\n" }, "byoipRangeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.\n" }, "cidrBlock": { "type": "string", "description": "The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.\n" }, "ipv6cidrBlock": { "type": "string", "description": "The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.\n" } }, "type": "object", "required": [ "asPathPrependLength", "byoipRangeId", "cidrBlock", "ipv6cidrBlock" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoasnsFilter:getByoasnsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getByoipAllocatedRangesByoipAllocatedRangeCollection:getByoipAllocatedRangesByoipAllocatedRangeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getByoipAllocatedRangesByoipAllocatedRangeCollectionItem:getByoipAllocatedRangesByoipAllocatedRangeCollectionItem" }, "description": "A list of subranges of a BYOIP CIDR block allocated to an IP pool.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipAllocatedRangesByoipAllocatedRangeCollectionItem:getByoipAllocatedRangesByoipAllocatedRangeCollectionItem": { "properties": { "cidrBlock": { "type": "string", "description": "The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block.\n" }, "publicIpPoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IP pool containing the CIDR block.\n" } }, "type": "object", "required": [ "cidrBlock", "publicIpPoolId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipAllocatedRangesFilter:getByoipAllocatedRangesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getByoipRangeByoipRangeVcnIpv6allocation:getByoipRangeByoipRangeVcnIpv6allocation": { "properties": { "byoipRangeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block.\n" }, "ipv6cidrBlock": { "type": "string", "description": "The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs.\n" } }, "type": "object", "required": [ "byoipRangeId", "compartmentId", "ipv6cidrBlock", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipRangeOriginAsn:getByoipRangeOriginAsn": { "properties": { "asPathPrependLength": { "type": "integer", "description": "The as path prepend length.\n" }, "asn": { "type": "string", "description": "The Autonomous System Number (ASN) you are importing to the Oracle cloud.\n" }, "byoasnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource.\n" } }, "type": "object", "required": [ "asPathPrependLength", "asn", "byoasnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipRangesByoipRangeCollection:getByoipRangesByoipRangeCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getByoipRangesByoipRangeCollectionItem:getByoipRangesByoipRangeCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipRangesByoipRangeCollectionItem:getByoipRangesByoipRangeCollectionItem": { "properties": { "byoipRangeVcnIpv6allocations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getByoipRangesByoipRangeCollectionItemByoipRangeVcnIpv6allocation:getByoipRangesByoipRangeCollectionItemByoipRangeVcnIpv6allocation" }, "description": "A list of `ByoipRangeVcnIpv6AllocationSummary` objects.\n" }, "cidrBlock": { "type": "string", "description": "The public IPv4 CIDR block being imported from on-premises to the Oracle cloud.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource.\n" }, "ipAnycastId": { "type": "string" }, "ipv6cidrBlock": { "type": "string", "description": "The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.\n" }, "lifecycleDetails": { "type": "string", "description": "The `ByoipRange` resource's current status.\n" }, "monitorIp": { "type": "string" }, "originAsns": { "type": "array", "items": { "$ref": "#/types/oci:Core/getByoipRangesByoipRangeCollectionItemOriginAsn:getByoipRangesByoipRangeCollectionItemOriginAsn" }, "description": "Information about the origin asn.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given lifecycle state name exactly.\n" }, "timeAdvertised": { "type": "string", "description": "The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeCreated": { "type": "string", "description": "The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeValidated": { "type": "string", "description": "The date and time the `ByoipRange` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeWithdrawn": { "type": "string", "description": "The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "validationToken": { "type": "string", "description": "The validation token is an internally-generated ASCII string used in the validation process. See [Importing a CIDR block](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.\n" } }, "type": "object", "required": [ "byoipRangeVcnIpv6allocations", "definedTags", "displayName", "freeformTags", "id", "ipAnycastId", "ipv6cidrBlock", "lifecycleDetails", "monitorIp", "originAsns", "state", "timeAdvertised", "timeCreated", "timeValidated", "timeWithdrawn", "validationToken" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipRangesByoipRangeCollectionItemByoipRangeVcnIpv6allocation:getByoipRangesByoipRangeCollectionItemByoipRangeVcnIpv6allocation": { "properties": { "byoipRangeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "ipv6cidrBlock": { "type": "string", "description": "The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs.\n" } }, "type": "object", "required": [ "byoipRangeId", "compartmentId", "ipv6cidrBlock", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipRangesByoipRangeCollectionItemOriginAsn:getByoipRangesByoipRangeCollectionItemOriginAsn": { "properties": { "asPathPrependLength": { "type": "integer", "description": "The as path prepend length.\n" }, "asn": { "type": "string", "description": "The Autonomous System Number (ASN) you are importing to the Oracle cloud.\n" }, "byoasnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource.\n" } }, "type": "object", "required": [ "asPathPrependLength", "asn", "byoasnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getByoipRangesFilter:getByoipRangesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRule:getCaptureFilterFlowLogCaptureFilterRule": { "properties": { "destinationCidr": { "type": "string", "description": "Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.\n" }, "flowLogType": { "type": "string", "description": "Type or types of flow logs to store. `ALL` includes records for both accepted traffic and rejected traffic.\n" }, "icmpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleIcmpOption:getCaptureFilterFlowLogCaptureFilterRuleIcmpOption" }, "description": "Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n" }, "isEnabled": { "type": "boolean", "description": "Indicates whether a flow log capture filter rule is enabled.\n" }, "priority": { "type": "integer", "description": "A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority.\n" }, "protocol": { "type": "string", "description": "The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:\n* 1 = ICMP\n* 6 = TCP\n* 17 = UDP\n" }, "ruleAction": { "type": "string", "description": "Include or exclude packets meeting this definition from mirrored traffic.\n" }, "samplingRate": { "type": "integer", "description": "Sampling interval as 1 of X, where X is an integer not greater than 100000.\n" }, "sourceCidr": { "type": "string", "description": "Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.\n" }, "tcpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleTcpOption:getCaptureFilterFlowLogCaptureFilterRuleTcpOption" }, "description": "Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "udpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleUdpOption:getCaptureFilterFlowLogCaptureFilterRuleUdpOption" }, "description": "Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "destinationCidr", "flowLogType", "icmpOptions", "isEnabled", "priority", "protocol", "ruleAction", "samplingRate", "sourceCidr", "tcpOptions", "udpOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleIcmpOption:getCaptureFilterFlowLogCaptureFilterRuleIcmpOption": { "properties": { "code": { "type": "integer", "description": "The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "The ICMP type.\n" } }, "type": "object", "required": [ "code", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleTcpOption:getCaptureFilterFlowLogCaptureFilterRuleTcpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleUdpOption:getCaptureFilterFlowLogCaptureFilterRuleUdpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRule:getCaptureFilterVtapCaptureFilterRule": { "properties": { "destinationCidr": { "type": "string", "description": "Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.\n" }, "icmpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleIcmpOption:getCaptureFilterVtapCaptureFilterRuleIcmpOption" }, "description": "Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n" }, "protocol": { "type": "string", "description": "The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:\n* 1 = ICMP\n* 6 = TCP\n* 17 = UDP\n" }, "ruleAction": { "type": "string", "description": "Include or exclude packets meeting this definition from mirrored traffic.\n" }, "sourceCidr": { "type": "string", "description": "Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.\n" }, "tcpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleTcpOption:getCaptureFilterVtapCaptureFilterRuleTcpOption" }, "description": "Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "trafficDirection": { "type": "string", "description": "The traffic direction the VTAP is configured to mirror.\n" }, "udpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleUdpOption:getCaptureFilterVtapCaptureFilterRuleUdpOption" }, "description": "Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "destinationCidr", "icmpOptions", "protocol", "ruleAction", "sourceCidr", "tcpOptions", "trafficDirection", "udpOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleIcmpOption:getCaptureFilterVtapCaptureFilterRuleIcmpOption": { "properties": { "code": { "type": "integer", "description": "The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "The ICMP type.\n" } }, "type": "object", "required": [ "code", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleTcpOption:getCaptureFilterVtapCaptureFilterRuleTcpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleUdpOption:getCaptureFilterVtapCaptureFilterRuleUdpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilter:getCaptureFiltersCaptureFilter": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "filterType": { "type": "string", "description": "A filter to only return resources that match the given capture filterType. The filterType value is the string representation of enum - VTAP, FLOWLOG.\n" }, "flowLogCaptureFilterRules": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRule:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRule" }, "description": "The set of rules governing what traffic the Flow Log collects when creating a flow log capture filter.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The capture filter's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the given capture filter lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the capture filter was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2021-08-25T21:10:29.600Z`\n" }, "vtapCaptureFilterRules": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRule:getCaptureFiltersCaptureFilterVtapCaptureFilterRule" }, "description": "The set of rules governing what traffic a VTAP mirrors.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "filterType", "flowLogCaptureFilterRules", "freeformTags", "id", "state", "timeCreated", "vtapCaptureFilterRules" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRule:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRule": { "properties": { "destinationCidr": { "type": "string", "description": "Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.\n" }, "flowLogType": { "type": "string", "description": "Type or types of flow logs to store. `ALL` includes records for both accepted traffic and rejected traffic.\n" }, "icmpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleIcmpOption:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleIcmpOption" }, "description": "Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n" }, "isEnabled": { "type": "boolean", "description": "Indicates whether a flow log capture filter rule is enabled.\n" }, "priority": { "type": "integer", "description": "A lower number indicates a higher priority, range 0-9. Each rule must have a distinct priority.\n" }, "protocol": { "type": "string", "description": "The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:\n* 1 = ICMP\n* 6 = TCP\n* 17 = UDP\n" }, "ruleAction": { "type": "string", "description": "Include or exclude packets meeting this definition from mirrored traffic.\n" }, "samplingRate": { "type": "integer", "description": "Sampling interval as 1 of X, where X is an integer not greater than 100000.\n" }, "sourceCidr": { "type": "string", "description": "Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.\n" }, "tcpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOption:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOption" }, "description": "Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "udpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOption:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOption" }, "description": "Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "destinationCidr", "flowLogType", "icmpOptions", "isEnabled", "priority", "protocol", "ruleAction", "samplingRate", "sourceCidr", "tcpOptions", "udpOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleIcmpOption:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleIcmpOption": { "properties": { "code": { "type": "integer", "description": "The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "The ICMP type.\n" } }, "type": "object", "required": [ "code", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOption:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleTcpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOption:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFiltersCaptureFilterFlowLogCaptureFilterRuleUdpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRule:getCaptureFiltersCaptureFilterVtapCaptureFilterRule": { "properties": { "destinationCidr": { "type": "string", "description": "Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target.\n" }, "icmpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleIcmpOption:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleIcmpOption" }, "description": "Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n" }, "protocol": { "type": "string", "description": "The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter. Supported options are:\n* 1 = ICMP\n* 6 = TCP\n* 17 = UDP\n" }, "ruleAction": { "type": "string", "description": "Include or exclude packets meeting this definition from mirrored traffic.\n" }, "sourceCidr": { "type": "string", "description": "Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target.\n" }, "tcpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOption:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOption" }, "description": "Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "trafficDirection": { "type": "string", "description": "The traffic direction the VTAP is configured to mirror.\n" }, "udpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOption:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOption" }, "description": "Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "destinationCidr", "icmpOptions", "protocol", "ruleAction", "sourceCidr", "tcpOptions", "trafficDirection", "udpOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleIcmpOption:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleIcmpOption": { "properties": { "code": { "type": "integer", "description": "The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "The ICMP type.\n" } }, "type": "object", "required": [ "code", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOption:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleTcpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOption:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange:getCaptureFiltersCaptureFilterVtapCaptureFilterRuleUdpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number, which must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCaptureFiltersFilter:getCaptureFiltersFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getClusterNetworkClusterConfiguration:getClusterNetworkClusterConfiguration": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network.\n" }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of network block OCIDs of the HPC island.\n" } }, "type": "object", "required": [ "hpcIslandId", "networkBlockIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePool:getClusterNetworkInstancePool": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance pool.\n" }, "currentSize": { "type": "integer", "description": "Count of instance in running state associated to the Instance Pool.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instanceConfigurationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool.\n" }, "instanceDisplayNameFormatter": { "type": "string" }, "instanceHostnameFormatter": { "type": "string" }, "loadBalancers": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancePoolLoadBalancer:getClusterNetworkInstancePoolLoadBalancer" }, "description": "The load balancers attached to the instance pool.\n" }, "placementConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancePoolPlacementConfiguration:getClusterNetworkInstancePoolPlacementConfiguration" }, "description": "The placement configurations for the instance pool.\n" }, "poolType": { "type": "string", "description": "The type of resources managed by the pool.\n" }, "size": { "type": "integer", "description": "The number of instances that should be in the instance pool.\n" }, "state": { "type": "string", "description": "The current state of the cluster network.\n" }, "timeCreated": { "type": "string", "description": "The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "currentSize", "definedTags", "displayName", "freeformTags", "id", "instanceConfigurationId", "instanceDisplayNameFormatter", "instanceHostnameFormatter", "loadBalancers", "placementConfigurations", "poolType", "size", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePoolLoadBalancer:getClusterNetworkInstancePoolLoadBalancer": { "properties": { "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment.\n" }, "loadBalancerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool.\n" }, "port": { "type": "integer", "description": "The port value used for the backends.\n" }, "state": { "type": "string", "description": "The current state of the cluster network.\n" }, "vnicSelection": { "type": "string", "description": "Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.\n" } }, "type": "object", "required": [ "backendSetName", "id", "instancePoolId", "loadBalancerId", "port", "state", "vnicSelection" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePoolPlacementConfiguration:getClusterNetworkInstancePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domains to place instances.\n" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet:getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet:getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain", "computeClusterId", "faultDomains", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet:getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet:getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancesFilter:getClusterNetworkInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getClusterNetworkInstancesInstance:getClusterNetworkInstancesInstance": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain the instance is running in.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "faultDomain": { "type": "string", "description": "The fault domain the instance is running in.\n" }, "id": { "type": "string", "description": "The OCID of the instance.\n" }, "instanceConfigurationId": { "type": "string", "description": "The OCID of the instance confgiuration used to create the instance.\n" }, "loadBalancerBackends": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkInstancesInstanceLoadBalancerBackend:getClusterNetworkInstancesInstanceLoadBalancerBackend" }, "description": "The load balancer backends that are configured for the instance pool instance.\n" }, "region": { "type": "string", "description": "The region that contains the availability domain the instance is running in.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "state": { "type": "string", "description": "The current state of the instance pool instance.\n" }, "timeCreated": { "type": "string", "description": "The date and time the instance pool instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "displayName", "faultDomain", "id", "instanceConfigurationId", "loadBalancerBackends", "region", "shape", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkInstancesInstanceLoadBalancerBackend:getClusterNetworkInstancesInstanceLoadBalancerBackend": { "properties": { "backendHealthStatus": { "type": "string", "description": "The health of the backend as observed by the load balancer.\n" }, "backendName": { "type": "string", "description": "The name of the backend in the backend set.\n" }, "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "loadBalancerId": { "type": "string", "description": "The OCID of the load balancer attached to the instance pool.\n" }, "state": { "type": "string", "description": "The current state of the instance pool instance.\n" } }, "type": "object", "required": [ "backendHealthStatus", "backendName", "backendSetName", "loadBalancerId", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkPlacementConfiguration:getClusterNetworkPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "placementConstraint": { "type": "string" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkPlacementConfigurationPrimaryVnicSubnet:getClusterNetworkPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkPlacementConfigurationSecondaryVnicSubnet:getClusterNetworkPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain", "placementConstraint", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkPlacementConfigurationPrimaryVnicSubnet:getClusterNetworkPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkPlacementConfigurationSecondaryVnicSubnet:getClusterNetworkPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetwork:getClusterNetworksClusterNetwork": { "properties": { "clusterConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkClusterConfiguration:getClusterNetworksClusterNetworkClusterConfiguration" } }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePools": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePool:getClusterNetworksClusterNetworkInstancePool" }, "description": "The instance pools in the cluster network.\n" }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of network block OCIDs of the HPC island.\n" }, "placementConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkPlacementConfiguration:getClusterNetworksClusterNetworkPlacementConfiguration" }, "description": "The location for where the instance pools in a cluster network will place instances.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the resource was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "clusterConfigurations", "compartmentId", "definedTags", "displayName", "freeformTags", "hpcIslandId", "id", "instancePools", "networkBlockIds", "placementConfigurations", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkClusterConfiguration:getClusterNetworksClusterNetworkClusterConfiguration": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island used by the cluster network.\n" }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of network block OCIDs of the HPC island.\n" } }, "type": "object", "required": [ "hpcIslandId", "networkBlockIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePool:getClusterNetworksClusterNetworkInstancePool": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "currentSize": { "type": "integer", "description": "Count of instance in running state associated to the Instance Pool.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instanceConfigurationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool.\n" }, "instanceDisplayNameFormatter": { "type": "string" }, "instanceHostnameFormatter": { "type": "string" }, "loadBalancers": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePoolLoadBalancer:getClusterNetworksClusterNetworkInstancePoolLoadBalancer" }, "description": "The load balancers attached to the instance pool.\n" }, "placementConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfiguration:getClusterNetworksClusterNetworkInstancePoolPlacementConfiguration" }, "description": "The placement configurations for the instance pool.\n" }, "poolType": { "type": "string", "description": "The type of resources managed by the pool.\n" }, "size": { "type": "integer", "description": "The number of instances that should be in the instance pool.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "currentSize", "definedTags", "displayName", "freeformTags", "id", "instanceConfigurationId", "instanceDisplayNameFormatter", "instanceHostnameFormatter", "loadBalancers", "placementConfigurations", "poolType", "size", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePoolLoadBalancer:getClusterNetworksClusterNetworkInstancePoolLoadBalancer": { "properties": { "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment.\n" }, "loadBalancerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool.\n" }, "port": { "type": "integer", "description": "The port value used for the backends.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "vnicSelection": { "type": "string", "description": "Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.\n" } }, "type": "object", "required": [ "backendSetName", "id", "instancePoolId", "loadBalancerId", "port", "state", "vnicSelection" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfiguration:getClusterNetworksClusterNetworkInstancePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domains to place instances.\n" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain", "computeClusterId", "faultDomains", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkPlacementConfiguration:getClusterNetworksClusterNetworkPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "placementConstraint": { "type": "string" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnet:getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnet:getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain", "placementConstraint", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnet:getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnet:getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getClusterNetworksClusterNetworkPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getClusterNetworksFilter:getClusterNetworksFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityReservationInstanceReservationConfig:getComputeCapacityReservationInstanceReservationConfig": { "properties": { "clusterConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityReservationInstanceReservationConfigClusterConfig:getComputeCapacityReservationInstanceReservationConfigClusterConfig" }, "description": "The HPC cluster configuration requested when launching instances in a compute capacity reservation.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group for this instance reservation capacity configuration.\n" }, "faultDomain": { "type": "string", "description": "The fault domain of this capacity configuration. If a value is not supplied, this capacity configuration is applicable to all fault domains in the specified availability domain. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm).\n" }, "instanceShape": { "type": "string", "description": "The shape to use when launching instances using compute capacity reservations. The shape determines the number of CPUs, the amount of memory, and other resources allocated to the instance. You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).\n" }, "instanceShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig:getComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig" }, "description": "The shape configuration requested when launching instances in a compute capacity reservation.\n" }, "reservedCount": { "type": "string", "description": "The total number of instances that can be launched from the capacity configuration.\n" }, "usedCount": { "type": "string", "description": "The amount of capacity in use out of the total capacity reserved in this capacity configuration.\n" } }, "type": "object", "required": [ "clusterConfigs", "clusterPlacementGroupId", "faultDomain", "instanceShape", "instanceShapeConfigs", "reservedCount", "usedCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationInstanceReservationConfigClusterConfig:getComputeCapacityReservationInstanceReservationConfigClusterConfig": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island.\n" }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of OCIDs of the network blocks.\n" } }, "type": "object", "required": [ "hpcIslandId", "networkBlockIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig:getComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string" } }, "type": "object", "required": [ "memoryInGbs", "ocpus", "resourceManagement" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationInstanceShapesComputeCapacityReservationInstanceShape:getComputeCapacityReservationInstanceShapesComputeCapacityReservationInstanceShape": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "instanceShape": { "type": "string", "description": "The name of the available shape used to launch instances in a compute capacity reservation.\n" } }, "type": "object", "required": [ "availabilityDomain", "instanceShape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationInstanceShapesFilter:getComputeCapacityReservationInstanceShapesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityReservationInstancesCapacityReservationInstance:getComputeCapacityReservationInstancesCapacityReservationInstance": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "faultDomain": { "type": "string", "description": "The fault domain the instance is running in.\n" }, "id": { "type": "string", "description": "The OCID of the instance.\n" }, "shape": { "type": "string", "description": "The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityReservationInstancesCapacityReservationInstanceShapeConfig:getComputeCapacityReservationInstancesCapacityReservationInstanceShapeConfig" }, "description": "The shape configuration requested when launching instances in a compute capacity reservation.\n" } }, "type": "object", "required": [ "availabilityDomain", "clusterPlacementGroupId", "compartmentId", "faultDomain", "id", "shape", "shapeConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationInstancesCapacityReservationInstanceShapeConfig:getComputeCapacityReservationInstancesCapacityReservationInstanceShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance\n" }, "resourceManagement": { "type": "string" } }, "type": "object", "required": [ "memoryInGbs", "ocpus", "resourceManagement" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationInstancesFilter:getComputeCapacityReservationInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityReservationsComputeCapacityReservation:getComputeCapacityReservationsComputeCapacityReservation": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity reservation.\n" }, "instanceReservationConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfig:getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfig" }, "description": "The capacity configurations for the capacity reservation.\n" }, "isDefaultReservation": { "type": "boolean", "description": "Whether this capacity reservation is the default. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm#default).\n" }, "reservedInstanceCount": { "type": "string", "description": "The number of instances for which capacity will be held with this compute capacity reservation. This number is the sum of the values of the `reservedCount` fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the compute capacity reservation was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the compute capacity reservation was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "usedInstanceCount": { "type": "string", "description": "The total number of instances currently consuming space in this compute capacity reservation. This number is the sum of the values of the `usedCount` fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "instanceReservationConfigs", "isDefaultReservation", "reservedInstanceCount", "state", "timeCreated", "timeUpdated", "usedInstanceCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfig:getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfig": { "properties": { "clusterConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigClusterConfig:getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigClusterConfig" }, "description": "The HPC cluster configuration requested when launching instances in a compute capacity reservation.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group for this instance reservation capacity configuration.\n" }, "faultDomain": { "type": "string", "description": "The fault domain of this capacity configuration. If a value is not supplied, this capacity configuration is applicable to all fault domains in the specified availability domain. For more information, see [Capacity Reservations](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/reserve-capacity.htm).\n" }, "instanceShape": { "type": "string", "description": "The shape to use when launching instances using compute capacity reservations. The shape determines the number of CPUs, the amount of memory, and other resources allocated to the instance. You can list all available shapes by calling [ListComputeCapacityReservationInstanceShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/computeCapacityReservationInstanceShapes/ListComputeCapacityReservationInstanceShapes).\n" }, "instanceShapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig:getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig" }, "description": "The shape configuration requested when launching instances in a compute capacity reservation.\n" }, "reservedCount": { "type": "string", "description": "The total number of instances that can be launched from the capacity configuration.\n" }, "usedCount": { "type": "string", "description": "The amount of capacity in use out of the total capacity reserved in this capacity configuration.\n" } }, "type": "object", "required": [ "clusterConfigs", "clusterPlacementGroupId", "faultDomain", "instanceShape", "instanceShapeConfigs", "reservedCount", "usedCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigClusterConfig:getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigClusterConfig": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island.\n" }, "networkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of OCIDs of the network blocks.\n" } }, "type": "object", "required": [ "hpcIslandId", "networkBlockIds" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig:getComputeCapacityReservationsComputeCapacityReservationInstanceReservationConfigInstanceShapeConfig": { "properties": { "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string" } }, "type": "object", "required": [ "memoryInGbs", "ocpus", "resourceManagement" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityReservationsFilter:getComputeCapacityReservationsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityTopologiesComputeCapacityTopologyCollection:getComputeCapacityTopologiesComputeCapacityTopologyCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityTopologiesComputeCapacityTopologyCollectionItem:getComputeCapacityTopologiesComputeCapacityTopologyCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologiesComputeCapacityTopologyCollectionItem:getComputeCapacityTopologiesComputeCapacityTopologyCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "capacitySources": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityTopologiesComputeCapacityTopologyCollectionItemCapacitySource:getComputeCapacityTopologiesComputeCapacityTopologyCollectionItemCapacitySource" }, "description": "A capacity source of bare metal hosts.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.\n" }, "state": { "type": "string", "description": "The current state of the compute capacity topology.\n" }, "timeCreated": { "type": "string", "description": "The date and time that the compute capacity topology was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time that the compute capacity topology was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "capacitySources", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologiesComputeCapacityTopologyCollectionItemCapacitySource:getComputeCapacityTopologiesComputeCapacityTopologyCollectionItemCapacitySource": { "properties": { "capacityType": { "type": "string", "description": "The capacity type of bare metal hosts.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" } }, "type": "object", "required": [ "capacityType", "compartmentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologiesFilter:getComputeCapacityTopologiesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityTopologyCapacitySource:getComputeCapacityTopologyCapacitySource": { "properties": { "capacityType": { "type": "string", "description": "The capacity type of bare metal hosts.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the compute capacity topology.\n" } }, "type": "object", "required": [ "capacityType", "compartmentId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollection:getComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollectionItem:getComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollectionItem" }, "description": "The list of compute bare metal hosts.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollectionItem:getComputeCapacityTopologyComputeBareMetalHostsComputeBareMetalHostCollectionItem": { "properties": { "computeCapacityTopologyId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.\n" }, "computeHpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.\n" }, "computeLocalBlockId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute local block.\n" }, "computeNetworkBlockId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute bare metal host.\n" }, "instanceId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute instance that runs on the compute bare metal host.\n" }, "instanceShape": { "type": "string", "description": "The shape of the compute instance that runs on the compute bare metal host.\n" }, "lifecycleDetails": { "type": "string", "description": "The lifecycle state details of the compute bare metal host.\n" }, "state": { "type": "string", "description": "The current state of the compute bare metal host.\n" }, "timeCreated": { "type": "string", "description": "The date and time that the compute bare metal host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time that the compute bare metal host was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "computeCapacityTopologyId", "computeHpcIslandId", "computeLocalBlockId", "computeNetworkBlockId", "id", "instanceId", "instanceShape", "lifecycleDetails", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeBareMetalHostsFilter:getComputeCapacityTopologyComputeBareMetalHostsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollection:getComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollectionItem:getComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollectionItem" }, "description": "The list of compute HPC islands.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollectionItem:getComputeCapacityTopologyComputeHpcIslandsComputeHpcIslandCollectionItem": { "properties": { "computeCapacityTopologyId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.\n" }, "state": { "type": "string", "description": "The current state of the compute HPC island.\n" }, "timeCreated": { "type": "string", "description": "The date and time that the compute HPC island was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time that the compute HPC island was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "totalComputeBareMetalHostCount": { "type": "string", "description": "The total number of compute bare metal hosts located in this compute HPC island.\n" } }, "type": "object", "required": [ "computeCapacityTopologyId", "id", "state", "timeCreated", "timeUpdated", "totalComputeBareMetalHostCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeHpcIslandsFilter:getComputeCapacityTopologyComputeHpcIslandsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollection:getComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollectionItem:getComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollectionItem" }, "description": "The list of compute network blocks.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollectionItem:getComputeCapacityTopologyComputeNetworkBlocksComputeNetworkBlockCollectionItem": { "properties": { "computeCapacityTopologyId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute capacity topology.\n" }, "computeHpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.\n" }, "state": { "type": "string", "description": "The current state of the compute network block.\n" }, "timeCreated": { "type": "string", "description": "The date and time that the compute network block was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time that the compute network block was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "totalComputeBareMetalHostCount": { "type": "string", "description": "The total number of compute bare metal hosts located in the compute network block.\n" } }, "type": "object", "required": [ "computeCapacityTopologyId", "computeHpcIslandId", "id", "state", "timeCreated", "timeUpdated", "totalComputeBareMetalHostCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeCapacityTopologyComputeNetworkBlocksFilter:getComputeCapacityTopologyComputeNetworkBlocksFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeClusterPlacementConstraintDetail:getComputeClusterPlacementConstraintDetail": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island for the compute cluster.\n" }, "logicalPlacementConstraint": { "type": "string", "description": "The logical placement strategy to apply. Allowed values are `SINGLE_TIER`, `SINGLE_BLOCK`, and `PACKED_DISTRIBUTION_MULTI_BLOCK`.\n" }, "targetMemoryFabricIds": { "type": "array", "items": { "type": "string" }, "description": "The list of target GPU memory fabric OCIDs to constrain placement. Up to 15 items are allowed.\n" }, "targetNetworkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of target network block OCIDs to constrain placement. Up to 15 items are allowed.\n" }, "type": { "type": "string", "description": "The type for the placement constraints. Supported value: `COMPUTE_CLUSTER`.\n" } }, "type": "object", "required": [ "hpcIslandId", "logicalPlacementConstraint", "targetMemoryFabricIds", "targetNetworkBlockIds", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeClustersComputeClusterCollection:getComputeClustersComputeClusterCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeClustersComputeClusterCollectionItem:getComputeClustersComputeClusterCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeClustersComputeClusterCollectionItem:getComputeClustersComputeClusterCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeClustersComputeClusterCollectionItemPlacementConstraintDetail:getComputeClustersComputeClusterCollectionItemPlacementConstraintDetail" }, "description": "The details for providing placement constraints.\n" }, "state": { "type": "string", "description": "The current state of the compute cluster.\n" }, "timeCreated": { "type": "string", "description": "The date and time the compute cluster was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the compute cluster was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "placementConstraintDetails", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeClustersComputeClusterCollectionItemPlacementConstraintDetail:getComputeClustersComputeClusterCollectionItemPlacementConstraintDetail": { "properties": { "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the HPC island for the compute cluster.\n" }, "logicalPlacementConstraint": { "type": "string", "description": "The logical placement strategy to apply. Allowed values are `SINGLE_TIER`, `SINGLE_BLOCK`, and `PACKED_DISTRIBUTION_MULTI_BLOCK`.\n" }, "targetMemoryFabricIds": { "type": "array", "items": { "type": "string" }, "description": "The list of target GPU memory fabric OCIDs to constrain placement. Up to 15 items are allowed.\n" }, "targetNetworkBlockIds": { "type": "array", "items": { "type": "string" }, "description": "The list of target network block OCIDs to constrain placement. Up to 15 items are allowed.\n" }, "type": { "type": "string", "description": "The type for the placement constraints. Supported value: `COMPUTE_CLUSTER`.\n" } }, "type": "object", "required": [ "hpcIslandId", "logicalPlacementConstraint", "targetMemoryFabricIds", "targetNetworkBlockIds", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeClustersFilter:getComputeClustersFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeGlobalImageCapabilitySchemasComputeGlobalImageCapabilitySchema:getComputeGlobalImageCapabilitySchemasComputeGlobalImageCapabilitySchema": { "properties": { "compartmentId": { "type": "string", "description": "A filter to return only resources that match the given compartment OCID exactly.\n" }, "currentVersionName": { "type": "string", "description": "The name of the global capabilities version resource that is considered the current version.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema\n" }, "timeCreated": { "type": "string", "description": "The date and time the compute global image capability schema was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "currentVersionName", "definedTags", "displayName", "freeformTags", "id", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGlobalImageCapabilitySchemasFilter:getComputeGlobalImageCapabilitySchemasFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeGlobalImageCapabilitySchemasVersionsComputeGlobalImageCapabilitySchemaVersion:getComputeGlobalImageCapabilitySchemasVersionsComputeGlobalImageCapabilitySchemaVersion": { "properties": { "computeGlobalImageCapabilitySchemaId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "name": { "type": "string", "description": "The name of the compute global image capability schema version\n" }, "schemaData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The map of each capability name to its ImageCapabilityDescriptor.\n" }, "timeCreated": { "type": "string", "description": "The date and time the compute global image capability schema version was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "computeGlobalImageCapabilitySchemaId", "displayName", "name", "schemaData", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGlobalImageCapabilitySchemasVersionsFilter:getComputeGlobalImageCapabilitySchemasVersionsFilter": { "properties": { "name": { "type": "string", "description": "The name of the compute global image capability schema version\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" }, "description": "the list of values for the enum\n" } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeGpuMemoryClusterGpuMemoryClusterScaleConfig:getComputeGpuMemoryClusterGpuMemoryClusterScaleConfig": { "properties": { "isDownsizeEnabled": { "type": "boolean", "description": "Whether downsizing is enabled.\n" }, "isUpsizeEnabled": { "type": "boolean", "description": "Whether upsizing is enabled.\n" }, "targetSize": { "type": "string", "description": "The configured target size for the GPU Memory Cluster.\n" } }, "type": "object", "required": [ "isDownsizeEnabled", "isUpsizeEnabled", "targetSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollection:getComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollectionItem:getComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollectionItem" }, "description": "The list of compute GPU Memory Cluster instances.\n" } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollectionItem:getComputeGpuMemoryClusterInstancesComputeGpuMemoryClusterInstanceCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the GPU Memory Cluster instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the compartment compartment.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "faultDomain": { "type": "string", "description": "The fault domain the GPU Memory Cluster instance is running in.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster instance\n" }, "instanceConfigurationId": { "type": "string", "description": "Configuration to be used for this GPU Memory Cluster instance.\n" }, "instanceShape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. The shape determines the number of CPUs, the amount of memory, and other resources allocated to the instance. You can list all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes).\n" }, "region": { "type": "string", "description": "The region that contains the availability domain the instance is running in.\n" }, "state": { "type": "string", "description": "The lifecycle state of the GPU Memory Cluster instance\n" }, "timeCreated": { "type": "string", "description": "The date and time the GPU Memory Cluster instance was created. Example: `2016-09-15T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "displayName", "faultDomain", "id", "instanceConfigurationId", "instanceShape", "region", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryClusterInstancesFilter:getComputeGpuMemoryClusterInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeGpuMemoryClustersComputeGpuMemoryClusterCollection:getComputeGpuMemoryClustersComputeGpuMemoryClusterCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItem:getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItem:getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. A [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "gpuMemoryClusterScaleConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItemGpuMemoryClusterScaleConfig:getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItemGpuMemoryClusterScaleConfig" }, "description": "Configuration settings for GPU Memory Cluster scaling.\n" }, "gpuMemoryFabricId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the GPU memory fabric.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU Memory Cluster\n" }, "instanceConfigurationId": { "type": "string", "description": "The OCID of the Instance Configuration used to source launch details for this instance.\n" }, "privateIpIds": { "type": "array", "items": { "type": "string" }, "description": "Unique list of OCIDs for private IPs (IPv4/IPv6) associated with the GPU Memory Cluster\n" }, "size": { "type": "string", "description": "The size represents the total number of instances in the GPU Memory Cluster, including both running instances and those still in the process of launching.\n" }, "state": { "type": "string", "description": "The lifecycle state of the GPU Memory Cluster\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the GPU Memory Cluster was created. Example: `2016-09-15T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "computeClusterId", "definedTags", "displayName", "freeformTags", "gpuMemoryClusterScaleConfigs", "gpuMemoryFabricId", "id", "instanceConfigurationId", "privateIpIds", "size", "state", "systemTags", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItemGpuMemoryClusterScaleConfig:getComputeGpuMemoryClustersComputeGpuMemoryClusterCollectionItemGpuMemoryClusterScaleConfig": { "properties": { "isDownsizeEnabled": { "type": "boolean", "description": "Whether downsizing is enabled.\n" }, "isUpsizeEnabled": { "type": "boolean", "description": "Whether upsizing is enabled.\n" }, "targetSize": { "type": "string", "description": "The configured target size for the GPU Memory Cluster.\n" } }, "type": "object", "required": [ "isDownsizeEnabled", "isUpsizeEnabled", "targetSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryClustersFilter:getComputeGpuMemoryClustersFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeGpuMemoryFabricMemoryFabricPreference:getComputeGpuMemoryFabricMemoryFabricPreference": { "properties": { "customerDesiredFirmwareBundleId": { "type": "string", "description": "The desired firmware bundle id on the GPU memory fabric.\n" }, "fabricRecycleLevel": { "type": "string", "description": "The recycle level of GPU memory fabric.\n" } }, "type": "object", "required": [ "customerDesiredFirmwareBundleId", "fabricRecycleLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollection:getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItem:getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItem:getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItem": { "properties": { "additionalData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional data that can be exposed to the customer. Right now it will include the switch tray ids.\n" }, "availableHostCount": { "type": "string", "description": "The total number of available bare metal hosts located in this compute GPU memory fabric.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeGpuMemoryClusters": { "type": "array", "items": { "type": "string" }, "description": "List of GPU memory clusters within this GPU memory fabric.\n" }, "computeGpuMemoryFabricId": { "type": "string", "description": "A filter to return only the listings that matches the given GPU memory fabric id.\n" }, "computeHpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute HPC island.\n" }, "computeLocalBlockId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block\n" }, "computeNetworkBlockId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute network block.\n" }, "currentFirmwareBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for current firmware bundle\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "fabricHealth": { "type": "string", "description": "The health state of the GPU memory fabric\n" }, "firmwareUpdateReason": { "type": "string", "description": "The reason for updating firmware bundle version of the GPU memory fabric.\n" }, "firmwareUpdateState": { "type": "string", "description": "The state of Memory Fabric Firmware update\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "healthyHostCount": { "type": "string", "description": "The total number of healthy bare metal hosts located in this compute GPU memory fabric.\n" }, "hostPlatformName": { "type": "string", "description": "The host platform identifier used for bundle queries\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique GPU memory fabric\n" }, "memoryFabricPreferences": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItemMemoryFabricPreference:getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItemMemoryFabricPreference" }, "description": "The preference object specified by customer. Contains customerDesiredFirmwareBundleId, fabricRecycleLevel.\n" }, "state": { "type": "string", "description": "The lifecycle state of the GPU memory fabric\n" }, "switchPlatformName": { "type": "string", "description": "The switch platform identifier used for bundle queries\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud.free-tier-retained\": \"true\"}`\n" }, "targetFirmwareBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for targeted firmware bundle\n" }, "timeCreated": { "type": "string", "description": "The date and time that the compute GPU memory fabric record was created, in the format defined by [RFC3339] (https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "totalHostCount": { "type": "string", "description": "The total number of bare metal hosts located in this compute GPU memory fabric.\n" } }, "type": "object", "required": [ "additionalData", "availableHostCount", "compartmentId", "computeGpuMemoryClusters", "computeGpuMemoryFabricId", "computeHpcIslandId", "computeLocalBlockId", "computeNetworkBlockId", "currentFirmwareBundleId", "definedTags", "displayName", "fabricHealth", "firmwareUpdateReason", "firmwareUpdateState", "freeformTags", "healthyHostCount", "hostPlatformName", "id", "memoryFabricPreferences", "state", "switchPlatformName", "systemTags", "targetFirmwareBundleId", "timeCreated", "totalHostCount" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItemMemoryFabricPreference:getComputeGpuMemoryFabricsComputeGpuMemoryFabricCollectionItemMemoryFabricPreference": { "properties": { "customerDesiredFirmwareBundleId": { "type": "string", "description": "The desired firmware bundle id on the GPU memory fabric.\n" }, "fabricRecycleLevel": { "type": "string", "description": "The recycle level of GPU memory fabric.\n" } }, "type": "object", "required": [ "customerDesiredFirmwareBundleId", "fabricRecycleLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeGpuMemoryFabricsFilter:getComputeGpuMemoryFabricsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeHostConfigurationData:getComputeHostConfigurationData": { "properties": { "checkDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeHostConfigurationDataCheckDetail:getComputeHostConfigurationDataCheckDetail" }, "description": "Compute Host Group Configuration Details Check\n" }, "timeLastApply": { "type": "string", "description": "The time that was last applied.\n" } }, "type": "object", "required": [ "checkDetails", "timeLastApply" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostConfigurationDataCheckDetail:getComputeHostConfigurationDataCheckDetail": { "properties": { "configurationState": { "type": "string", "description": "Configuration state of the Compute Bare Metal Host.\n" }, "firmwareBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host.\n" }, "recycleLevel": { "type": "string", "description": "Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" }, "type": { "type": "string", "description": "The type of configuration\n" } }, "type": "object", "required": [ "configurationState", "firmwareBundleId", "recycleLevel", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostGroupConfiguration:getComputeHostGroupConfiguration": { "properties": { "firmwareBundleId": { "type": "string", "description": "The OCID for firmware bundle\n" }, "recycleLevel": { "type": "string", "description": "Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" }, "state": { "type": "string", "description": "The lifecycle state of the host group\n" }, "target": { "type": "string", "description": "Either the platform name or compute shape that the configuration is targeting\n" } }, "type": "object", "required": [ "firmwareBundleId", "recycleLevel", "state", "target" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostGroupsComputeHostGroupCollection:getComputeHostGroupsComputeHostGroupCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeHostGroupsComputeHostGroupCollectionItem:getComputeHostGroupsComputeHostGroupCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostGroupsComputeHostGroupCollectionItem:getComputeHostGroupsComputeHostGroupCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of a host group. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "configurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeHostGroupsComputeHostGroupCollectionItemConfiguration:getComputeHostGroupsComputeHostGroupCollectionItemConfiguration" }, "description": "A list of HostGroupConfiguration objects\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host group\n" }, "isTargetedPlacementRequired": { "type": "boolean", "description": "A flag that allows customers to restrict placement for hosts attached to the group. If true, the only way to place on hosts is to target the specific host group.\n" }, "state": { "type": "string", "description": "The lifecycle state of the host group\n" }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the host group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the host group was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "configurations", "definedTags", "displayName", "freeformTags", "id", "isTargetedPlacementRequired", "state", "systemTags", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostGroupsComputeHostGroupCollectionItemConfiguration:getComputeHostGroupsComputeHostGroupCollectionItemConfiguration": { "properties": { "firmwareBundleId": { "type": "string", "description": "The OCID for firmware bundle\n" }, "recycleLevel": { "type": "string", "description": "Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" }, "state": { "type": "string", "description": "The lifecycle state of the host group\n" }, "target": { "type": "string", "description": "Either the platform name or compute shape that the configuration is targeting\n" } }, "type": "object", "required": [ "firmwareBundleId", "recycleLevel", "state", "target" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostGroupsFilter:getComputeHostGroupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeHostRecycleDetail:getComputeHostRecycleDetail": { "properties": { "computeHostGroupId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute host group this host was attached to at the time of recycle.\n" }, "recycleLevel": { "type": "string", "description": "Preferred recycle level for hosts associated with the reservation config.\n* `SKIP_RECYCLE` - Skips host wipe.\n* `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior.\n" } }, "type": "object", "required": [ "computeHostGroupId", "recycleLevel" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostsComputeHostCollection:getComputeHostsComputeHostCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getComputeHostsComputeHostCollectionItem:getComputeHostsComputeHostCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostsComputeHostCollectionItem:getComputeHostsComputeHostCollectionItem": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Capacity Reserver that is currently on host\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeHostGroupId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute host group.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "firmwareBundleId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique firmware bundle associated with the Host.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "gpuMemoryFabricId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique GPU Memory Fabric\n" }, "hasImpactedComponents": { "type": "boolean" }, "health": { "type": "string", "description": "The heathy state of the host\n" }, "hostCorrelationId": { "type": "string", "description": "The ID that remains consistent when a host moves between capacity pools within the same tenancy.\n" }, "hpcIslandId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique HPC Island\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Customer-unique host\n" }, "instanceId": { "type": "string", "description": "The public [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the Virtual Machine or Bare Metal instance\n" }, "localBlockId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Local Block\n" }, "networkBlockId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for Customer-unique Network Block\n" }, "platform": { "type": "string", "description": "The platform of the host\n" }, "shape": { "type": "string", "description": "The shape of host\n" }, "state": { "type": "string", "description": "The lifecycle state of the host\n" }, "timeCreated": { "type": "string", "description": "The date and time that the compute host record was created, in the format defined by [RFC3339](https://tools .ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time that the compute host record was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "capacityReservationId", "compartmentId", "computeHostGroupId", "definedTags", "displayName", "faultDomain", "firmwareBundleId", "freeformTags", "gpuMemoryFabricId", "hasImpactedComponents", "health", "hostCorrelationId", "hpcIslandId", "id", "instanceId", "localBlockId", "networkBlockId", "platform", "shape", "state", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeHostsFilter:getComputeHostsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getComputeImageCapabilitySchemasComputeImageCapabilitySchema:getComputeImageCapabilitySchemasComputeImageCapabilitySchema": { "properties": { "compartmentId": { "type": "string", "description": "A filter to return only resources that match the given compartment OCID exactly.\n" }, "computeGlobalImageCapabilitySchemaId": { "type": "string", "description": "The ocid of the compute global image capability schema\n" }, "computeGlobalImageCapabilitySchemaVersionName": { "type": "string", "description": "The name of the compute global image capability schema version\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The compute image capability schema [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n" }, "imageId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an image.\n" }, "schemaData": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A mapping of each capability name to its ImageCapabilityDescriptor.\n" }, "timeCreated": { "type": "string", "description": "The date and time the compute image capability schema was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "computeGlobalImageCapabilitySchemaId", "computeGlobalImageCapabilitySchemaVersionName", "definedTags", "displayName", "freeformTags", "id", "imageId", "schemaData", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getComputeImageCapabilitySchemasFilter:getComputeImageCapabilitySchemasFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" }, "description": "the list of values for the enum\n" } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getConsoleHistoriesConsoleHistory:getConsoleHistoriesConsoleHistory": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the console history metadata object.\n" }, "instanceId": { "type": "string", "description": "The OCID of the instance.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the history was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "instanceId", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getConsoleHistoriesFilter:getConsoleHistoriesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCpeDeviceShapeCpeDeviceInfo:getCpeDeviceShapeCpeDeviceInfo": { "properties": { "platformSoftwareVersion": { "type": "string", "description": "The platform or software version of the CPE device.\n" }, "vendor": { "type": "string", "description": "The vendor that makes the CPE device.\n" } }, "type": "object", "required": [ "platformSoftwareVersion", "vendor" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCpeDeviceShapeParameter:getCpeDeviceShapeParameter": { "properties": { "displayName": { "type": "string", "description": "A descriptive label for the question (for example, to display in a form in a graphical interface). Avoid entering confidential information.\n" }, "explanation": { "type": "string", "description": "A description or explanation of the question, to help the customer answer accurately.\n" }, "key": { "type": "string", "description": "A string that identifies the question.\n" } }, "type": "object", "required": [ "displayName", "explanation", "key" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCpeDeviceShapesCpeDeviceShape:getCpeDeviceShapesCpeDeviceShape": { "properties": { "cpeDeviceInfos": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCpeDeviceShapesCpeDeviceShapeCpeDeviceInfo:getCpeDeviceShapesCpeDeviceShapeCpeDeviceInfo" }, "description": "Basic information about a particular CPE device type.\n" }, "cpeDeviceShapeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device.\n" }, "template": { "type": "string", "description": "A template of CPE device configuration information that will be merged with the customer's answers to the questions to render the final CPE device configuration content. Also see:\n* [GetCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n* [GetIpsecCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n* [GetTunnelCpeDeviceConfigContent](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n" } }, "type": "object", "required": [ "cpeDeviceInfos", "cpeDeviceShapeId", "template" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCpeDeviceShapesCpeDeviceShapeCpeDeviceInfo:getCpeDeviceShapesCpeDeviceShapeCpeDeviceInfo": { "properties": { "platformSoftwareVersion": { "type": "string", "description": "The platform or software version of the CPE device.\n" }, "vendor": { "type": "string", "description": "The vendor that makes the CPE device.\n" } }, "type": "object", "required": [ "platformSoftwareVersion", "vendor" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCpeDeviceShapesFilter:getCpeDeviceShapesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCpesCpe:getCpesCpe": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "cpeDeviceShapeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE's device type. The Networking service maintains a general list of CPE device types (for example, Cisco ASA). For each type, Oracle provides CPE configuration content that can help a network engineer configure the CPE. The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) uniquely identifies the type of device. To get the OCIDs for the device types on the list, see [ListCpeDeviceShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes).\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The CPE's Oracle ID (OCID).\n" }, "ipAddress": { "type": "string", "description": "The public IP address of the on-premises router.\n" }, "isPrivate": { "type": "boolean", "description": "Indicates whether this CPE is of type \u003cspan pulumi-lang-nodejs=\"`private`\" pulumi-lang-dotnet=\"`Private`\" pulumi-lang-go=\"`private`\" pulumi-lang-python=\"`private`\" pulumi-lang-yaml=\"`private`\" pulumi-lang-java=\"`private`\" pulumi-lang-hcl=\"`private`\"\u003e`private`\u003c/span\u003e or not.\n" }, "timeCreated": { "type": "string", "description": "The date and time the CPE was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "cpeDeviceShapeId", "definedTags", "displayName", "freeformTags", "id", "ipAddress", "isPrivate", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCpesFilter:getCpesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCrossConnectGroupMacsecProperty:getCrossConnectGroupMacsecProperty": { "properties": { "encryptionCipher": { "type": "string", "description": "Type of encryption cipher suite to use for the MACsec connection.\n" }, "isUnprotectedTrafficAllowed": { "type": "boolean", "description": "Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.\n" }, "primaryKeys": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCrossConnectGroupMacsecPropertyPrimaryKey:getCrossConnectGroupMacsecPropertyPrimaryKey" }, "description": "An object defining the Secrets-in-Vault OCIDs representing the MACsec key.\n" }, "state": { "type": "string", "description": "The cross-connect group's current state.\n" } }, "type": "object", "required": [ "encryptionCipher", "isUnprotectedTrafficAllowed", "primaryKeys", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectGroupMacsecPropertyPrimaryKey:getCrossConnectGroupMacsecPropertyPrimaryKey": { "properties": { "connectivityAssociationKeySecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.\n" }, "connectivityAssociationKeySecretVersion": { "type": "string", "description": "The secret version of the `connectivityAssociationKey` secret in Vault.\n" }, "connectivityAssociationNameSecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.\n" }, "connectivityAssociationNameSecretVersion": { "type": "string", "description": "The secret version of the connectivity association name secret in Vault.\n" } }, "type": "object", "required": [ "connectivityAssociationKeySecretId", "connectivityAssociationKeySecretVersion", "connectivityAssociationNameSecretId", "connectivityAssociationNameSecretVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectGroupsCrossConnectGroup:getCrossConnectGroupsCrossConnectGroup": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "customerReferenceName": { "type": "string", "description": "A reference name or identifier for the physical fiber connection that this cross-connect group uses.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The cross-connect group's Oracle ID (OCID).\n" }, "macsecProperties": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCrossConnectGroupsCrossConnectGroupMacsecProperty:getCrossConnectGroupsCrossConnectGroupMacsecProperty" }, "description": "Properties used for MACsec (if capable).\n" }, "ociLogicalDeviceName": { "type": "string", "description": "The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.\n" }, "ociPhysicalDeviceName": { "type": "string", "description": "The FastConnect device that terminates the physical connection.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the cross-connect group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "customerReferenceName", "definedTags", "displayName", "freeformTags", "id", "macsecProperties", "ociLogicalDeviceName", "ociPhysicalDeviceName", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectGroupsCrossConnectGroupMacsecProperty:getCrossConnectGroupsCrossConnectGroupMacsecProperty": { "properties": { "encryptionCipher": { "type": "string", "description": "Type of encryption cipher suite to use for the MACsec connection.\n" }, "isUnprotectedTrafficAllowed": { "type": "boolean", "description": "Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.\n" }, "primaryKeys": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey:getCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey" }, "description": "An object defining the Secrets-in-Vault OCIDs representing the MACsec key.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" } }, "type": "object", "required": [ "encryptionCipher", "isUnprotectedTrafficAllowed", "primaryKeys", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey:getCrossConnectGroupsCrossConnectGroupMacsecPropertyPrimaryKey": { "properties": { "connectivityAssociationKeySecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.\n" }, "connectivityAssociationKeySecretVersion": { "type": "string", "description": "The secret version of the `connectivityAssociationKey` secret in Vault.\n" }, "connectivityAssociationNameSecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.\n" }, "connectivityAssociationNameSecretVersion": { "type": "string", "description": "The secret version of the connectivity association name secret in Vault.\n" } }, "type": "object", "required": [ "connectivityAssociationKeySecretId", "connectivityAssociationKeySecretVersion", "connectivityAssociationNameSecretId", "connectivityAssociationNameSecretVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectGroupsFilter:getCrossConnectGroupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCrossConnectLocationsCrossConnectLocation:getCrossConnectLocationsCrossConnectLocation": { "properties": { "description": { "type": "string", "description": "A description of the location.\n" }, "name": { "type": "string", "description": "The name of the location. Example: `CyrusOne, Chandler, AZ`\n" } }, "type": "object", "required": [ "description", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectLocationsFilter:getCrossConnectLocationsFilter": { "properties": { "name": { "type": "string", "description": "The name of the location. Example: `CyrusOne, Chandler, AZ`\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCrossConnectMacsecProperty:getCrossConnectMacsecProperty": { "properties": { "encryptionCipher": { "type": "string", "description": "Type of encryption cipher suite to use for the MACsec connection.\n" }, "isUnprotectedTrafficAllowed": { "type": "boolean", "description": "Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.\n" }, "primaryKeys": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCrossConnectMacsecPropertyPrimaryKey:getCrossConnectMacsecPropertyPrimaryKey" }, "description": "An object defining the Secrets-in-Vault OCIDs representing the MACsec key.\n" }, "state": { "type": "string", "description": "The cross-connect's current state.\n" } }, "type": "object", "required": [ "encryptionCipher", "isUnprotectedTrafficAllowed", "primaryKeys", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectMacsecPropertyPrimaryKey:getCrossConnectMacsecPropertyPrimaryKey": { "properties": { "connectivityAssociationKeySecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.\n" }, "connectivityAssociationKeySecretVersion": { "type": "string", "description": "The secret version of the `connectivityAssociationKey` secret in Vault.\n" }, "connectivityAssociationNameSecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.\n" }, "connectivityAssociationNameSecretVersion": { "type": "string", "description": "The secret version of the connectivity association name secret in Vault.\n" } }, "type": "object", "required": [ "connectivityAssociationKeySecretId", "connectivityAssociationKeySecretVersion", "connectivityAssociationNameSecretId", "connectivityAssociationNameSecretVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectPortSpeedShapeCrossConnectPortSpeedShape:getCrossConnectPortSpeedShapeCrossConnectPortSpeedShape": { "properties": { "name": { "type": "string", "description": "The name of the port speed shape. Example: `10 Gbps`\n" }, "portSpeedInGbps": { "type": "integer", "description": "The port speed in Gbps. Example: \u003cspan pulumi-lang-nodejs=\"`10`\" pulumi-lang-dotnet=\"`10`\" pulumi-lang-go=\"`10`\" pulumi-lang-python=\"`10`\" pulumi-lang-yaml=\"`10`\" pulumi-lang-java=\"`10`\" pulumi-lang-hcl=\"`10`\"\u003e`10`\u003c/span\u003e\n" } }, "type": "object", "required": [ "name", "portSpeedInGbps" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectPortSpeedShapeFilter:getCrossConnectPortSpeedShapeFilter": { "properties": { "name": { "type": "string", "description": "The name of the port speed shape. Example: `10 Gbps`\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getCrossConnectsCrossConnect:getCrossConnectsCrossConnect": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "crossConnectGroupId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group.\n" }, "customerReferenceName": { "type": "string", "description": "A reference name or identifier for the physical fiber connection that this cross-connect uses.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "farCrossConnectOrCrossConnectGroupId": { "type": "string" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The cross-connect's Oracle ID (OCID).\n" }, "interfaceName": { "type": "string" }, "isActive": { "type": "boolean" }, "locationName": { "type": "string", "description": "The name of the FastConnect location where this cross-connect is installed.\n" }, "macsecProperties": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCrossConnectsCrossConnectMacsecProperty:getCrossConnectsCrossConnectMacsecProperty" }, "description": "Properties used for MACsec (if capable).\n" }, "nearCrossConnectOrCrossConnectGroupId": { "type": "string" }, "ociLogicalDeviceName": { "type": "string", "description": "The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection.\n" }, "ociPhysicalDeviceName": { "type": "string", "description": "The FastConnect device that terminates the physical connection.\n" }, "portName": { "type": "string", "description": "A string identifying the meet-me room port for this cross-connect.\n" }, "portSpeedShapeName": { "type": "string", "description": "The port speed for this cross-connect. Example: `10 Gbps`\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the cross-connect was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "crossConnectGroupId", "customerReferenceName", "definedTags", "displayName", "farCrossConnectOrCrossConnectGroupId", "freeformTags", "id", "interfaceName", "isActive", "locationName", "macsecProperties", "nearCrossConnectOrCrossConnectGroupId", "ociLogicalDeviceName", "ociPhysicalDeviceName", "portName", "portSpeedShapeName", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectsCrossConnectMacsecProperty:getCrossConnectsCrossConnectMacsecProperty": { "properties": { "encryptionCipher": { "type": "string", "description": "Type of encryption cipher suite to use for the MACsec connection.\n" }, "isUnprotectedTrafficAllowed": { "type": "boolean", "description": "Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails.\n" }, "primaryKeys": { "type": "array", "items": { "$ref": "#/types/oci:Core/getCrossConnectsCrossConnectMacsecPropertyPrimaryKey:getCrossConnectsCrossConnectMacsecPropertyPrimaryKey" }, "description": "An object defining the Secrets-in-Vault OCIDs representing the MACsec key.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" } }, "type": "object", "required": [ "encryptionCipher", "isUnprotectedTrafficAllowed", "primaryKeys", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectsCrossConnectMacsecPropertyPrimaryKey:getCrossConnectsCrossConnectMacsecPropertyPrimaryKey": { "properties": { "connectivityAssociationKeySecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key.\n" }, "connectivityAssociationKeySecretVersion": { "type": "string", "description": "The secret version of the `connectivityAssociationKey` secret in Vault.\n" }, "connectivityAssociationNameSecretId": { "type": "string", "description": "Secret [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key.\n" }, "connectivityAssociationNameSecretVersion": { "type": "string", "description": "The secret version of the connectivity association name secret in Vault.\n" } }, "type": "object", "required": [ "connectivityAssociationKeySecretId", "connectivityAssociationKeySecretVersion", "connectivityAssociationNameSecretId", "connectivityAssociationNameSecretVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getCrossConnectsFilter:getCrossConnectsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDedicatedVmHostCapacityBin:getDedicatedVmHostCapacityBin": { "properties": { "capacityIndex": { "type": "integer", "description": "Zero-based index for the corresponding capacity bucket.\n" }, "remainingLocalVolumeInGbs": { "type": "number", "description": "The current available local volume of the dedicated VM host, in GBs.\n" }, "remainingMemoryInGbs": { "type": "number", "description": "The current available memory of the dedicated VM host, in GBs.\n" }, "remainingOcpus": { "type": "number", "description": "The current available OCPUs of the dedicated VM host.\n" }, "supportedShapes": { "type": "array", "items": { "type": "string" }, "description": "List of VMI shapes supported on each capacity bucket.\n" }, "totalLocalVolumeInGbs": { "type": "number", "description": "The current total local volume of the dedicated VM host, in GBs.\n" }, "totalMemoryInGbs": { "type": "number", "description": "The current total memory of the dedicated VM host, in GBs.\n" }, "totalOcpus": { "type": "number", "description": "The current total OCPUs of the dedicated VM host.\n" } }, "type": "object", "required": [ "capacityIndex", "remainingLocalVolumeInGbs", "remainingMemoryInGbs", "remainingOcpus", "supportedShapes", "totalLocalVolumeInGbs", "totalMemoryInGbs", "totalOcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShape:getDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShape": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "instanceShapeName": { "type": "string", "description": "The name of the virtual machine instance shapes that can be launched on a dedicated VM host.\n" }, "supportedCapabilities": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShapeSupportedCapability:getDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShapeSupportedCapability" }, "description": "Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support.\n" } }, "type": "object", "required": [ "availabilityDomain", "instanceShapeName", "supportedCapabilities" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShapeSupportedCapability:getDedicatedVmHostInstanceShapesDedicatedVmHostInstanceShapeSupportedCapability": { "properties": { "isMemoryEncryptionSupported": { "type": "boolean", "description": "Whether the DVMH shape could support confidential VMs or the VM instance shape could be confidential.\n" } }, "type": "object", "required": [ "isMemoryEncryptionSupported" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostInstanceShapesFilter:getDedicatedVmHostInstanceShapesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDedicatedVmHostInstancesDedicatedVmHostInstance:getDedicatedVmHostInstancesDedicatedVmHostInstance": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "instanceId": { "type": "string", "description": "The OCID of the virtual machine instance.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.\n" }, "shape": { "type": "string", "description": "The shape of the VM instance.\n" }, "timeCreated": { "type": "string", "description": "The date and time the virtual machine instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "instanceId", "isMemoryEncryptionEnabled", "shape", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostInstancesFilter:getDedicatedVmHostInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDedicatedVmHostPlacementConstraintDetail:getDedicatedVmHostPlacementConstraintDetail": { "properties": { "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host. This is only available for dedicated capacity customers.\n" }, "type": { "type": "string", "description": "The type for the placement constraints. Use `COMPUTE_BARE_METAL_HOST` when specifying the compute bare metal host OCID. Use `HOST_GROUP` when specifying the compute host group OCID.\n" } }, "type": "object", "required": [ "computeBareMetalHostId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostShapesDedicatedVmHostShape:getDedicatedVmHostShapesDedicatedVmHostShape": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "capacityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfig:getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfig" }, "description": "A list of capacity configs that are supported by this dedicated VM host shape.\n" }, "dedicatedVmHostShape": { "type": "string", "description": "The name of the dedicated VM host shape. You can enumerate all available shapes by calling [ListDedicatedVmHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes).\n" } }, "type": "object", "required": [ "availabilityDomain", "capacityConfigs", "dedicatedVmHostShape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfig:getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfig": { "properties": { "capacityBins": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigCapacityBin:getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigCapacityBin" }, "description": "A list of total CPU and memory per capacity bucket.\n" }, "capacityConfigName": { "type": "string", "description": "The name of each capacity config.\n" }, "isDefault": { "type": "boolean", "description": "Whether this capacity config is the default config.\n" }, "supportedCapabilities": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigSupportedCapability:getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigSupportedCapability" }, "description": "Specifies the capabilities that the Dedicated Virtual Machine Host (DVMH) Shape or Virtual Machine Instance Shape could support.\n" } }, "type": "object", "required": [ "capacityBins", "capacityConfigName", "isDefault", "supportedCapabilities" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigCapacityBin:getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigCapacityBin": { "properties": { "capacityIndex": { "type": "integer", "description": "Zero-based index for the corresponding capacity bucket.\n" }, "supportedShapes": { "type": "array", "items": { "type": "string" }, "description": "List of VMI shapes supported on each capacity bucket.\n" }, "totalLocalVolumeInGbs": { "type": "number", "description": "The total local volume of the capacity bucket, in GBs.\n" }, "totalMemoryInGbs": { "type": "number", "description": "The total memory of the capacity bucket, in GBs.\n" }, "totalOcpus": { "type": "number", "description": "The total OCPUs of the capacity bucket.\n" } }, "type": "object", "required": [ "capacityIndex", "supportedShapes", "totalLocalVolumeInGbs", "totalMemoryInGbs", "totalOcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigSupportedCapability:getDedicatedVmHostShapesDedicatedVmHostShapeCapacityConfigSupportedCapability": { "properties": { "isMemoryEncryptionSupported": { "type": "boolean", "description": "Whether the DVMH shape could support confidential VMs or the VM instance shape could be confidential.\n" } }, "type": "object", "required": [ "isMemoryEncryptionSupported" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostShapesFilter:getDedicatedVmHostShapesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDedicatedVmHostsDedicatedVmHost:getDedicatedVmHostsDedicatedVmHost": { "properties": { "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "capacityBins": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDedicatedVmHostsDedicatedVmHostCapacityBin:getDedicatedVmHostsDedicatedVmHostCapacityBin" }, "description": "A list of total and remaining CPU, memory, and local volume per capacity bucket.\n" }, "capacityConfig": { "type": "string", "description": "The capacity configuration selected to be configured for the Dedicated Virtual Machine host. Run [ListDedicatedVmHostShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DedicatedVmHostShapeSummary/ListDedicatedVmHostShapes) API to see details of this capacity configuration.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host. This is only available for dedicated capacity customers.\n" }, "dedicatedVmHostShape": { "type": "string", "description": "The dedicated virtual machine host shape. The shape determines the number of CPUs and other resources available for VMs.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "faultDomain": { "type": "string", "description": "The fault domain for the dedicated virtual machine host's assigned instances. For more information, see [Fault Domains](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/regions.htm#fault).\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated VM host.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "A filter to return only confidential Dedicated VM hosts (DVMH) or confidential VM instances on DVMH.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDedicatedVmHostsDedicatedVmHostPlacementConstraintDetail:getDedicatedVmHostsDedicatedVmHostPlacementConstraintDetail" }, "description": "The details for providing placement constraints.\n" }, "remainingLocalVolumeInGbs": { "type": "number", "description": "The current available local volume of the dedicated VM host, in GBs.\n" }, "remainingMemoryInGbs": { "type": "number", "description": "The current available memory of the dedicated VM host, in GBs.\n" }, "remainingOcpus": { "type": "number", "description": "The current available OCPUs of the dedicated VM host.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the dedicated VM host was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "totalLocalVolumeInGbs": { "type": "number", "description": "The current total local volume of the dedicated VM host, in GBs.\n" }, "totalMemoryInGbs": { "type": "number", "description": "The current total memory of the dedicated VM host, in GBs.\n" }, "totalOcpus": { "type": "number", "description": "The current total OCPUs of the dedicated VM host.\n" } }, "type": "object", "required": [ "availabilityDomain", "capacityBins", "capacityConfig", "compartmentId", "computeBareMetalHostId", "dedicatedVmHostShape", "definedTags", "displayName", "faultDomain", "freeformTags", "id", "isMemoryEncryptionEnabled", "placementConstraintDetails", "remainingLocalVolumeInGbs", "remainingMemoryInGbs", "remainingOcpus", "state", "timeCreated", "totalLocalVolumeInGbs", "totalMemoryInGbs", "totalOcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostsDedicatedVmHostCapacityBin:getDedicatedVmHostsDedicatedVmHostCapacityBin": { "properties": { "capacityIndex": { "type": "integer", "description": "Zero-based index for the corresponding capacity bucket.\n" }, "remainingLocalVolumeInGbs": { "type": "number", "description": "The current available local volume of the dedicated VM host, in GBs.\n" }, "remainingMemoryInGbs": { "type": "number", "description": "The current available memory of the dedicated VM host, in GBs.\n" }, "remainingOcpus": { "type": "number", "description": "The current available OCPUs of the dedicated VM host.\n" }, "supportedShapes": { "type": "array", "items": { "type": "string" }, "description": "List of VMI shapes supported on each capacity bucket.\n" }, "totalLocalVolumeInGbs": { "type": "number", "description": "The current total local volume of the dedicated VM host, in GBs.\n" }, "totalMemoryInGbs": { "type": "number", "description": "The current total memory of the dedicated VM host, in GBs.\n" }, "totalOcpus": { "type": "number", "description": "The current total OCPUs of the dedicated VM host.\n" } }, "type": "object", "required": [ "capacityIndex", "remainingLocalVolumeInGbs", "remainingMemoryInGbs", "remainingOcpus", "supportedShapes", "totalLocalVolumeInGbs", "totalMemoryInGbs", "totalOcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostsDedicatedVmHostPlacementConstraintDetail:getDedicatedVmHostsDedicatedVmHostPlacementConstraintDetail": { "properties": { "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host. This is only available for dedicated capacity customers.\n" }, "type": { "type": "string", "description": "The type for the placement constraints. Use `COMPUTE_BARE_METAL_HOST` when specifying the compute bare metal host OCID. Use `HOST_GROUP` when specifying the compute host group OCID.\n" } }, "type": "object", "required": [ "computeBareMetalHostId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDedicatedVmHostsFilter:getDedicatedVmHostsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDhcpOptionsFilter:getDhcpOptionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDhcpOptionsOption:getDhcpOptionsOption": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "domainNameType": { "type": "string", "description": "The search domain name type of DHCP options\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)) for the set of DHCP options.\n" }, "options": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDhcpOptionsOptionOption:getDhcpOptionsOptionOption" }, "description": "The collection of individual DHCP options.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "Date and time the set of DHCP options was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "domainNameType", "freeformTags", "id", "options", "state", "timeCreated", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDhcpOptionsOptionOption:getDhcpOptionsOptionOption": { "properties": { "customDnsServers": { "type": "array", "items": { "type": "string" }, "description": "If you set `serverType` to `CustomDnsServer`, specify the IP address of at least one DNS server of your choice (three maximum).\n" }, "searchDomainNames": { "type": "array", "items": { "type": "string" }, "description": "A single search domain name according to [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). During a DNS query, the OS will append this search domain name to the value being queried.\n" }, "serverType": { "type": "string", "description": "* **VcnLocal:** Reserved for future use.\n* **VcnLocalPlusInternet:** Also referred to as \"Internet and VCN Resolver\". Instances can resolve internet hostnames (no internet gateway is required), and can resolve hostnames of instances in the VCN. This is the default value in the default set of DHCP options in the VCN. For the Internet and VCN Resolver to work across the VCN, there must also be a DNS label set for the VCN, a DNS label set for each subnet, and a hostname for each instance. The Internet and VCN Resolver also enables reverse DNS lookup, which lets you determine the hostname corresponding to the private IP address. For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).\n* **CustomDnsServer:** Instances use a DNS server of your choice (three maximum).\n" }, "type": { "type": "string", "description": "The specific DHCP option. Either `DomainNameServer` (for [DhcpDnsOption](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DhcpDnsOption/)) or `SearchDomain` (for [DhcpSearchDomainOption](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/DhcpSearchDomainOption/)).\n" } }, "type": "object", "required": [ "customDnsServers", "searchDomainNames", "serverType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgAttachmentsDrgAttachment:getDrgAttachmentsDrgAttachment": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "drgId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.\n" }, "drgRouteTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment.\n" }, "exportDrgRouteDistributionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.\n" }, "isCrossTenancy": { "type": "boolean", "description": "Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n" }, "networkDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDrgAttachmentsDrgAttachmentNetworkDetail:getDrgAttachmentsDrgAttachmentNetworkDetail" } }, "removeExportDrgRouteDistributionTrigger": { "type": "boolean" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the DRG attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "drgId", "drgRouteTableId", "exportDrgRouteDistributionId", "freeformTags", "id", "isCrossTenancy", "networkDetails", "removeExportDrgRouteDistributionTrigger", "routeTableId", "state", "timeCreated", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgAttachmentsDrgAttachmentNetworkDetail:getDrgAttachmentsDrgAttachmentNetworkDetail": { "properties": { "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG.\n" }, "ids": { "type": "array", "items": { "type": "string" }, "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target IPSec tunnel attachment.\n" }, "ipsecConnectionId": { "type": "string", "description": "The IPSec connection that contains the attached IPSec tunnel.\n" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using.\n" }, "transportAttachmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit's DRG attachment.\n" }, "transportOnlyMode": { "type": "boolean", "description": "Boolean flag that determines wether all traffic over the virtual circuits is encrypted. Example: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "type": { "type": "string", "description": "The type can be one of these values: `IPSEC_TUNNEL`, `LOOPBACK`, `REMOTE_PEERING_CONNECTION`, `VCN`, `VIRTUAL_CIRCUIT`\n" }, "vcnRouteType": { "type": "string", "description": "Indicates whether the VCN CIDRs or the individual subnet CIDRs are imported from the attachment. Routes from the VCN ingress route table are always imported.\n" } }, "type": "object", "required": [ "id", "ids", "ipsecConnectionId", "routeTableId", "transportAttachmentId", "transportOnlyMode", "type", "vcnRouteType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgAttachmentsFilter:getDrgAttachmentsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDrgRouteDistributionStatementsDrgRouteDistributionStatement:getDrgRouteDistributionStatementsDrgRouteDistributionStatement": { "properties": { "action": { "type": "string", "description": "`ACCEPT` indicates the route should be imported or exported as-is.\n" }, "id": { "type": "string", "description": "The Oracle-assigned ID of the route distribution statement.\n" }, "matchCriterias": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDrgRouteDistributionStatementsDrgRouteDistributionStatementMatchCriteria:getDrgRouteDistributionStatementsDrgRouteDistributionStatementMatchCriteria" }, "description": "The action is applied only if all of the match criteria is met. If match type is MATCH_ALL, any input is considered a match.\n" }, "priority": { "type": "integer", "description": "This field specifies the priority of each statement in a route distribution. Priorities must be unique within a particular route distribution. The priority will be represented as a number between 0 and 65535 where a lower number indicates a higher priority. When a route is processed, statements are applied in the order defined by their priority. The first matching rule dictates the action that will be taken on the route.\n" } }, "type": "object", "required": [ "action", "id", "matchCriterias", "priority" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgRouteDistributionStatementsDrgRouteDistributionStatementMatchCriteria:getDrgRouteDistributionStatementsDrgRouteDistributionStatementMatchCriteria": { "properties": { "attachmentType": { "type": "string", "description": "The type of the network resource to be included in this match. A match for a network type implies that all DRG attachments of that type insert routes into the table.\n" }, "drgAttachmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment.\n" }, "matchType": { "type": "string", "description": "The type of the match criteria for a route distribution statement.\n" } }, "type": "object", "required": [ "attachmentType", "drgAttachmentId", "matchType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgRouteDistributionStatementsFilter:getDrgRouteDistributionStatementsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDrgRouteDistributionsDrgRouteDistribution:getDrgRouteDistributionsDrgRouteDistribution": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route distribution.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "distributionType": { "type": "string", "description": "Whether this distribution defines how routes get imported into route tables or exported through DRG attachments.\n" }, "drgId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The route distribution's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "state": { "type": "string", "description": "A filter that only returns resources that match the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the route distribution was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "distributionType", "drgId", "freeformTags", "id", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgRouteDistributionsFilter:getDrgRouteDistributionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDrgRouteTableRouteRulesDrgRouteRule:getDrgRouteTableRouteRulesDrgRouteRule": { "properties": { "attributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional properties for the route, computed by the service.\n" }, "destination": { "type": "string", "description": "Represents the range of IP addresses to match against when routing traffic.\n" }, "destinationType": { "type": "string", "description": "The type of destination for the rule.\n" }, "id": { "type": "string", "description": "The Oracle-assigned ID of the DRG route rule.\n" }, "isBlackhole": { "type": "boolean", "description": "Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification.\n" }, "isConflict": { "type": "boolean", "description": "Indicates that the route was not imported due to a conflict between route rules.\n" }, "nextHopDrgAttachmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment responsible for reaching the network destination.\n" }, "routeProvenance": { "type": "string", "description": "The earliest origin of a route. If a route is advertised to a DRG through an IPsec tunnel attachment, and is propagated to peered DRGs via RPC attachments, the route's provenance in the peered DRGs remains `IPSEC_TUNNEL`, because that is the earliest origin.\n" }, "routeType": { "type": "string", "description": "Static routes are specified through the DRG route table API. Dynamic routes are learned by the DRG from the DRG attachments through various routing protocols.\n" } }, "type": "object", "required": [ "attributes", "destination", "destinationType", "id", "isBlackhole", "isConflict", "nextHopDrgAttachmentId", "routeProvenance", "routeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgRouteTableRouteRulesFilter:getDrgRouteTableRouteRulesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDrgRouteTablesDrgRouteTable:getDrgRouteTablesDrgRouteTable": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment the DRG is in. The DRG route table is always in the same compartment as the DRG.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "drgId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table.\n" }, "importDrgRouteDistributionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution.\n" }, "isEcmpEnabled": { "type": "boolean", "description": "If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to your on-premises network, enable ECMP on the DRG route table to which these attachments import routes.\n" }, "removeImportTrigger": { "type": "boolean" }, "state": { "type": "string", "description": "A filter that only returns matches for the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the DRG route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "drgId", "freeformTags", "id", "importDrgRouteDistributionId", "isEcmpEnabled", "removeImportTrigger", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgRouteTablesFilter:getDrgRouteTablesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getDrgsDrg:getDrgsDrg": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "defaultDrgRouteTables": { "type": "array", "items": { "$ref": "#/types/oci:Core/getDrgsDrgDefaultDrgRouteTable:getDrgsDrgDefaultDrgRouteTable" }, "description": "The default DRG route table for this DRG. Each network type has a default DRG route table.\n" }, "defaultExportDrgRouteDistributionId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this DRG's default export route distribution for the DRG attachments.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The DRG's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "redundancyStatus": { "type": "string" }, "state": { "type": "string", "description": "The DRG's current state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the DRG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "defaultDrgRouteTables", "defaultExportDrgRouteDistributionId", "definedTags", "displayName", "freeformTags", "id", "redundancyStatus", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgsDrgDefaultDrgRouteTable:getDrgsDrgDefaultDrgRouteTable": { "properties": { "ipsecTunnel": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table assigned to DRG attachments of type IPSEC_TUNNEL on creation.\n" }, "remotePeeringConnection": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type REMOTE_PEERING_CONNECTION on creation.\n" }, "vcn": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type VCN on creation.\n" }, "virtualCircuit": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type VIRTUAL_CIRCUIT on creation.\n" } }, "type": "object", "required": [ "ipsecTunnel", "remotePeeringConnection", "vcn", "virtualCircuit" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getDrgsFilter:getDrgsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getFastConnectProviderServicesFastConnectProviderService:getFastConnectProviderServicesFastConnectProviderService": { "properties": { "bandwithShapeManagement": { "type": "string", "description": "Who is responsible for managing the virtual circuit bandwidth.\n" }, "customerAsnManagement": { "type": "string", "description": "Who is responsible for managing the ASN information for the network at the other end of the connection from Oracle.\n" }, "description": { "type": "string", "description": "The location of the provider's website or portal. This portal is where you can get information about the provider service, create a virtual circuit connection from the provider to Oracle Cloud Infrastructure, and retrieve your provider service key for that virtual circuit connection. Example: `https://example.com`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider.\n" }, "privatePeeringBgpManagement": { "type": "string", "description": "Who is responsible for managing the private peering BGP information.\n" }, "providerName": { "type": "string", "description": "The name of the provider.\n" }, "providerServiceKeyManagement": { "type": "string", "description": "Who is responsible for managing the provider service key.\n" }, "providerServiceName": { "type": "string", "description": "The name of the service offered by the provider.\n" }, "publicPeeringBgpManagement": { "type": "string", "description": "Who is responsible for managing the public peering BGP information.\n" }, "requiredTotalCrossConnects": { "type": "integer", "description": "Total number of cross-connect or cross-connect groups required for the virtual circuit.\n" }, "supportedVirtualCircuitTypes": { "type": "array", "items": { "type": "string" }, "description": "An array of virtual circuit types supported by this service.\n" }, "type": { "type": "string", "description": "Provider service type.\n" } }, "type": "object", "required": [ "bandwithShapeManagement", "customerAsnManagement", "description", "id", "privatePeeringBgpManagement", "providerName", "providerServiceKeyManagement", "providerServiceName", "publicPeeringBgpManagement", "requiredTotalCrossConnects", "supportedVirtualCircuitTypes", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFastConnectProviderServicesFilter:getFastConnectProviderServicesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getFirmwareBundleAllowableTransition:getFirmwareBundleAllowableTransition": { "properties": { "downgrades": { "type": "array", "items": { "type": "string" }, "description": "An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle downgrades.\n" }, "upgrades": { "type": "array", "items": { "type": "string" }, "description": "An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle upgrades.\n" } }, "type": "object", "required": [ "downgrades", "upgrades" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlePlatform:getFirmwareBundlePlatform": { "properties": { "platform": { "type": "string", "description": "The name of the platform supported by this bundle.\n" }, "versions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getFirmwareBundlePlatformVersion:getFirmwareBundlePlatformVersion" }, "description": "An array of pinned components and their respective firmware versions.\n" } }, "type": "object", "required": [ "platform", "versions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlePlatformVersion:getFirmwareBundlePlatformVersion": { "properties": { "componentType": { "type": "string", "description": "The type of component.\n" }, "versions": { "type": "array", "items": { "type": "string" }, "description": "A list of firmware versions associated with this component type.\n" } }, "type": "object", "required": [ "componentType", "versions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlesFilter:getFirmwareBundlesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getFirmwareBundlesFirmwareBundlesCollection:getFirmwareBundlesFirmwareBundlesCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItem:getFirmwareBundlesFirmwareBundlesCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItem:getFirmwareBundlesFirmwareBundlesCollectionItem": { "properties": { "allowableTransitions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItemAllowableTransition:getFirmwareBundlesFirmwareBundlesCollectionItemAllowableTransition" }, "description": "A map of firmware bundle upgrades/downgrades validated by OCI.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "description": { "type": "string", "description": "A brief description or metadata about this firmware bundle.\n" }, "displayName": { "type": "string", "description": "The user-friendly name of this firmware bundle.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this firmware bundle.\n" }, "lifecycleState": { "type": "string" }, "platforms": { "type": "array", "items": { "$ref": "#/types/oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItemPlatform:getFirmwareBundlesFirmwareBundlesCollectionItemPlatform" }, "description": "A map of platforms to pinned firmware versions.\n" }, "timeCreated": { "type": "string", "description": "The date and time the firmware bundle was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeUpdated": { "type": "string", "description": "The date and time the firmware bundle was updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "allowableTransitions", "compartmentId", "description", "displayName", "id", "lifecycleState", "platforms", "timeCreated", "timeUpdated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItemAllowableTransition:getFirmwareBundlesFirmwareBundlesCollectionItemAllowableTransition": { "properties": { "downgrades": { "type": "array", "items": { "type": "string" }, "description": "An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle downgrades.\n" }, "upgrades": { "type": "array", "items": { "type": "string" }, "description": "An array of [OCIDs](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of validated firmware bundle upgrades.\n" } }, "type": "object", "required": [ "downgrades", "upgrades" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItemPlatform:getFirmwareBundlesFirmwareBundlesCollectionItemPlatform": { "properties": { "platform": { "type": "string", "description": "platform name\n" }, "versions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItemPlatformVersion:getFirmwareBundlesFirmwareBundlesCollectionItemPlatformVersion" }, "description": "An array of pinned components and their respective firmware versions.\n" } }, "type": "object", "required": [ "platform", "versions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getFirmwareBundlesFirmwareBundlesCollectionItemPlatformVersion:getFirmwareBundlesFirmwareBundlesCollectionItemPlatformVersion": { "properties": { "componentType": { "type": "string", "description": "The type of component.\n" }, "versions": { "type": "array", "items": { "type": "string" }, "description": "A list of firmware versions associated with this component type.\n" } }, "type": "object", "required": [ "componentType", "versions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageAgentFeature:getImageAgentFeature": { "properties": { "isManagementSupported": { "type": "boolean", "description": "This attribute is not used.\n" }, "isMonitoringSupported": { "type": "boolean", "description": "This attribute is not used.\n" } }, "type": "object", "required": [ "isManagementSupported", "isMonitoringSupported" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageImageSourceDetail:getImageImageSourceDetail": { "properties": { "bucketName": { "type": "string" }, "namespaceName": { "type": "string" }, "objectName": { "type": "string" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" }, "sourceImageType": { "type": "string" }, "sourceType": { "type": "string" }, "sourceUri": { "type": "string" } }, "type": "object", "required": [ "bucketName", "namespaceName", "objectName", "operatingSystem", "operatingSystemVersion", "sourceImageType", "sourceType", "sourceUri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageLaunchOption:getImageLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageShapeMemoryConstraint:getImageShapeMemoryConstraint": { "properties": { "maxInGbs": { "type": "integer", "description": "The maximum amount of memory, in gigabytes.\n" }, "minInGbs": { "type": "integer", "description": "The minimum amount of memory, in gigabytes.\n" } }, "type": "object", "required": [ "maxInGbs", "minInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageShapeOcpuConstraint:getImageShapeOcpuConstraint": { "properties": { "max": { "type": "integer", "description": "The maximum number of OCPUs supported for this image and shape.\n" }, "min": { "type": "integer", "description": "The minimum number of OCPUs supported for this image and shape.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageShapesFilter:getImageShapesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getImageShapesImageShapeCompatibility:getImageShapesImageShapeCompatibility": { "properties": { "imageId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the image.\n" }, "memoryConstraints": { "type": "array", "items": { "$ref": "#/types/oci:Core/getImageShapesImageShapeCompatibilityMemoryConstraint:getImageShapesImageShapeCompatibilityMemoryConstraint" }, "description": "For a flexible image and shape, the amount of memory supported for instances that use this image.\n" }, "ocpuConstraints": { "type": "array", "items": { "$ref": "#/types/oci:Core/getImageShapesImageShapeCompatibilityOcpuConstraint:getImageShapesImageShapeCompatibilityOcpuConstraint" }, "description": "OCPU options for an image and shape.\n" }, "shape": { "type": "string", "description": "The shape name.\n" } }, "type": "object", "required": [ "imageId", "memoryConstraints", "ocpuConstraints", "shape" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageShapesImageShapeCompatibilityMemoryConstraint:getImageShapesImageShapeCompatibilityMemoryConstraint": { "properties": { "maxInGbs": { "type": "integer", "description": "The maximum amount of memory, in gigabytes.\n" }, "minInGbs": { "type": "integer", "description": "The minimum amount of memory, in gigabytes.\n" } }, "type": "object", "required": [ "maxInGbs", "minInGbs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImageShapesImageShapeCompatibilityOcpuConstraint:getImageShapesImageShapeCompatibilityOcpuConstraint": { "properties": { "max": { "type": "integer", "description": "The maximum number of OCPUs supported for this image and shape.\n" }, "min": { "type": "integer", "description": "The minimum number of OCPUs supported for this image and shape.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImagesFilter:getImagesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getImagesImage:getImagesImage": { "properties": { "agentFeatures": { "type": "array", "items": { "$ref": "#/types/oci:Core/getImagesImageAgentFeature:getImagesImageAgentFeature" }, "description": "Oracle Cloud Agent features supported on the image.\n" }, "baseImageId": { "type": "string", "description": "The OCID of the image originally used to launch the instance.\n" }, "billableSizeInGbs": { "type": "string", "description": "The size of the internal storage for this image that is subject to billing (1 GB = 1,073,741,824 bytes). Example: \u003cspan pulumi-lang-nodejs=\"`100`\" pulumi-lang-dotnet=\"`100`\" pulumi-lang-go=\"`100`\" pulumi-lang-python=\"`100`\" pulumi-lang-yaml=\"`100`\" pulumi-lang-java=\"`100`\" pulumi-lang-hcl=\"`100`\"\u003e`100`\u003c/span\u003e\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "createImageAllowed": { "type": "boolean", "description": "Whether instances launched with this image can be used to create new images. For example, you cannot create an image of an Oracle Database instance. Example: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the image.\n" }, "imageSourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getImagesImageImageSourceDetail:getImagesImageImageSourceDetail" } }, "instanceId": { "type": "string" }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n" }, "launchOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getImagesImageLaunchOption:getImagesImageLaunchOption" }, "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n" }, "listingType": { "type": "string", "description": "The listing type of the image. The default value is \"NONE\".\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" }, "sizeInMbs": { "type": "string", "description": "The boot volume size for an instance launched from this image (1 MB = 1,048,576 bytes). Note this is not the same as the size of the image when it was exported or the actual size of the image. Example: \u003cspan pulumi-lang-nodejs=\"`47694`\" pulumi-lang-dotnet=\"`47694`\" pulumi-lang-go=\"`47694`\" pulumi-lang-python=\"`47694`\" pulumi-lang-yaml=\"`47694`\" pulumi-lang-java=\"`47694`\" pulumi-lang-hcl=\"`47694`\"\u003e`47694`\u003c/span\u003e\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the image was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "agentFeatures", "baseImageId", "billableSizeInGbs", "compartmentId", "createImageAllowed", "definedTags", "displayName", "freeformTags", "id", "imageSourceDetails", "instanceId", "launchMode", "launchOptions", "listingType", "operatingSystem", "operatingSystemVersion", "sizeInMbs", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImagesImageAgentFeature:getImagesImageAgentFeature": { "properties": { "isManagementSupported": { "type": "boolean", "description": "This attribute is not used.\n" }, "isMonitoringSupported": { "type": "boolean", "description": "This attribute is not used.\n" } }, "type": "object", "required": [ "isManagementSupported", "isMonitoringSupported" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImagesImageImageSourceDetail:getImagesImageImageSourceDetail": { "properties": { "bucketName": { "type": "string" }, "namespaceName": { "type": "string" }, "objectName": { "type": "string" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" }, "sourceImageType": { "type": "string" }, "sourceType": { "type": "string" }, "sourceUri": { "type": "string" } }, "type": "object", "required": [ "bucketName", "namespaceName", "objectName", "operatingSystem", "operatingSystemVersion", "sourceImageType", "sourceType", "sourceUri" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getImagesImageLaunchOption:getImagesImageLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceAgentConfig:getInstanceAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins.\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceAgentConfigPluginsConfig:getInstanceAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceAgentConfigPluginsConfig:getInstanceAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceAvailabilityConfig:getInstanceAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "required": [ "isLiveMigrationPreferred", "recoveryAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationGmcConfig:getInstanceConfigurationGmcConfig": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "gpuMemoryClusterScaleConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig:getInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig" }, "description": "Configuration settings for GPU Memory Cluster scaling.\n" }, "instanceConfigurationId": { "type": "string", "description": "The OCID of the instance configuration.\n" }, "size": { "type": "string", "description": "The desired number of instances for this GMC configuration entry.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "gpuMemoryClusterScaleConfigs", "instanceConfigurationId", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig:getInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig": { "properties": { "isDownsizeEnabled": { "type": "boolean", "description": "Enables downsizing towards the target size.\n" }, "isUpsizeEnabled": { "type": "boolean", "description": "Enables upsizing towards the target size.\n" }, "targetSize": { "type": "string", "description": "The configured target size for the GPU Memory Cluster.\n" } }, "type": "object", "required": [ "isDownsizeEnabled", "isUpsizeEnabled", "targetSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetail:getInstanceConfigurationInstanceDetail": { "properties": { "blockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailBlockVolume:getInstanceConfigurationInstanceDetailBlockVolume" }, "description": "Block volume parameters.\n" }, "instanceType": { "type": "string", "description": "The type of instance details. Supported instanceType is compute\n" }, "launchDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetail:getInstanceConfigurationInstanceDetailLaunchDetail" }, "description": "Instance launch details for creating an instance from an instance configuration. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" }, "options": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOption:getInstanceConfigurationInstanceDetailOption" }, "description": "Multiple Compute Instance Configuration instance details.\n" }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailSecondaryVnic:getInstanceConfigurationInstanceDetailSecondaryVnic" }, "description": "Secondary VNIC parameters.\n" } }, "type": "object", "required": [ "blockVolumes", "instanceType", "launchDetails", "options", "secondaryVnics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailBlockVolume:getInstanceConfigurationInstanceDetailBlockVolume": { "properties": { "attachDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeAttachDetail:getInstanceConfigurationInstanceDetailBlockVolumeAttachDetail" }, "description": "Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/)\n" }, "createDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetail:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetail" }, "description": "Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/)\n" }, "volumeId": { "type": "string", "description": "The OCID of the volume.\n" } }, "type": "object", "required": [ "attachDetails", "createDetails", "volumeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeAttachDetail:getInstanceConfigurationInstanceDetailBlockVolumeAttachDetail": { "properties": { "device": { "type": "string", "description": "The device name.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment should be created in read-only mode.\n" }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n" } }, "type": "object", "required": [ "device", "displayName", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "type", "useChap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetail:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetail": { "properties": { "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "backupPolicyId": { "type": "string", "description": "If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.\n" }, "blockVolumeReplicas": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica" }, "description": "The list of block volume replicas to be enabled for this volume in the specified destination availability domains.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail" } }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "xrcKmsKeyId": { "type": "string", "description": "The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "autotunePolicies", "availabilityDomain", "backupPolicyId", "blockVolumeReplicas", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "isAutoTuneEnabled", "kmsKeyId", "sizeInGbs", "sourceDetails", "vpusPerGb", "xrcKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType", "maxVpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "availabilityDomain", "displayName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail": { "properties": { "id": { "type": "string", "description": "The OCID of the volume backup.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetail:getInstanceConfigurationInstanceDetailLaunchDetail": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailAgentConfig:getInstanceConfigurationInstanceDetailLaunchDetailAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig:getInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig" }, "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation this instance is launched under.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail:getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host to place the instance on.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailInstanceOption:getInstanceConfigurationInstanceDetailLaunchDetailInstanceOption" }, "description": "Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints.\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether to enable AI enterprise on the instance.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n" }, "launchOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailLaunchOption:getInstanceConfigurationInstanceDetailLaunchDetailLaunchOption" }, "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n" }, "licensingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig:getInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig" }, "description": "List of licensing configurations associated with target launch values.\n" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail:getInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail" }, "description": "The details for providing placement constraints.\n" }, "platformConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig:getInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig" }, "description": "The platform configuration requested for the instance.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "preferredMaintenanceAction": { "type": "string", "description": "The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.\n* `LIVE_MIGRATE` - Run maintenance using a live migration.\n* `REBOOT` - Run maintenance using a reboot.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailShapeConfig:getInstanceConfigurationInstanceDetailLaunchDetailShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailSourceDetail:getInstanceConfigurationInstanceDetailLaunchDetailSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityConfigs", "availabilityDomain", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfigs", "preemptibleInstanceConfigs", "preferredMaintenanceAction", "securityAttributes", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailAgentConfig:getInstanceConfigurationInstanceDetailLaunchDetailAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig:getInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "required": [ "isLiveMigrationPreferred", "recoveryAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail:getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailInstanceOption:getInstanceConfigurationInstanceDetailLaunchDetailInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailLaunchOption:getInstanceConfigurationInstanceDetailLaunchDetailLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig:getInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "licenseType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail:getInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail": { "properties": { "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group. This is only available for dedicated capacity customers.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "computeHostGroupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig:getInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n" }, "configMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Instance Platform Configuration Configuration Map for flexible setting input.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n" }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n" }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n" }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n" }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n" }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n" }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "areVirtualInstructionsEnabled", "configMap", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailShapeConfig:getInstanceConfigurationInstanceDetailLaunchDetailShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "localVolumeSizeInGbs", "memoryInGbs", "nvmes", "ocpus", "resourceManagement", "vcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailSourceDetail:getInstanceConfigurationInstanceDetailLaunchDetailSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "instanceSourceImageFilterDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail" }, "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "instanceSourceImageFilterDetails", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" } }, "type": "object", "required": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOption:getInstanceConfigurationInstanceDetailOption": { "properties": { "blockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolume:getInstanceConfigurationInstanceDetailOptionBlockVolume" }, "description": "Block volume parameters.\n" }, "launchDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetail" }, "description": "Instance launch details for creating an instance from an instance configuration. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionSecondaryVnic:getInstanceConfigurationInstanceDetailOptionSecondaryVnic" }, "description": "Secondary VNIC parameters.\n" } }, "type": "object", "required": [ "blockVolumes", "launchDetails", "secondaryVnics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolume:getInstanceConfigurationInstanceDetailOptionBlockVolume": { "properties": { "attachDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail:getInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail" }, "description": "Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/)\n" }, "createDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail" }, "description": "Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/)\n" }, "volumeId": { "type": "string", "description": "The OCID of the volume.\n" } }, "type": "object", "required": [ "attachDetails", "createDetails", "volumeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail:getInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail": { "properties": { "device": { "type": "string", "description": "The device name.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment should be created in read-only mode.\n" }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n" } }, "type": "object", "required": [ "device", "displayName", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "type", "useChap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail": { "properties": { "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "backupPolicyId": { "type": "string", "description": "If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.\n" }, "blockVolumeReplicas": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica" }, "description": "The list of block volume replicas to be enabled for this volume in the specified destination availability domains.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail" } }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "xrcKmsKeyId": { "type": "string", "description": "The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "autotunePolicies", "availabilityDomain", "backupPolicyId", "blockVolumeReplicas", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "isAutoTuneEnabled", "kmsKeyId", "sizeInGbs", "sourceDetails", "vpusPerGb", "xrcKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType", "maxVpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "availabilityDomain", "displayName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail": { "properties": { "id": { "type": "string", "description": "The OCID of the volume backup.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetail": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig" }, "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation this instance is launched under.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host to place the instance on.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption:getInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption" }, "description": "Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints.\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether to enable AI enterprise on the instance.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n" }, "launchOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption:getInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption" }, "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n" }, "licensingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig" }, "description": "List of licensing configurations associated with target launch values.\n" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail" }, "description": "The details for providing placement constraints.\n" }, "platformConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig" }, "description": "The platform configuration requested for the instance.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "preferredMaintenanceAction": { "type": "string", "description": "The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.\n* `LIVE_MIGRATE` - Run maintenance using a live migration.\n* `REBOOT` - Run maintenance using a reboot.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityConfigs", "availabilityDomain", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfigs", "preemptibleInstanceConfigs", "preferredMaintenanceAction", "securityAttributes", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "required": [ "isLiveMigrationPreferred", "recoveryAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption:getInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption:getInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "licenseType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail": { "properties": { "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group. This is only available for dedicated capacity customers.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "computeHostGroupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n" }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n" }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n" }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n" }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n" }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n" }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "areVirtualInstructionsEnabled", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig:getInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "localVolumeSizeInGbs", "memoryInGbs", "nvmes", "ocpus", "resourceManagement", "vcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "instanceSourceImageFilterDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail" }, "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "instanceSourceImageFilterDetails", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" } }, "type": "object", "required": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionSecondaryVnic:getInstanceConfigurationInstanceDetailOptionSecondaryVnic": { "properties": { "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail:getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" } }, "type": "object", "required": [ "createVnicDetails", "displayName", "nicIndex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail:getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailSecondaryVnic:getInstanceConfigurationInstanceDetailSecondaryVnic": { "properties": { "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail:getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" } }, "type": "object", "required": [ "createVnicDetails", "displayName", "nicIndex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail:getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsFilter:getInstanceConfigurationsFilter": { "properties": { "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstanceConfigurationsInstanceConfiguration:getInstanceConfigurationsInstanceConfiguration": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "deferredFields": { "type": "array", "items": { "type": "string" }, "description": "Parameters that were not specified when the instance configuration was created, but that are required to launch an instance from the instance configuration. See the [LaunchInstanceConfiguration](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance/LaunchInstanceConfiguration) operation.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "gmcConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationGmcConfig:getInstanceConfigurationsInstanceConfigurationGmcConfig" }, "description": "The GPU Memory Cluster configuration entries for.\n" }, "id": { "type": "string", "description": "The OCID of the volume backup.\n" }, "instanceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetail" } }, "instanceId": { "type": "string" }, "source": { "type": "string", "description": "Differentiator for instance configuration. Following values are supported:\n* INSTANCE : All details related to instance will be passed within instanceDetails.\n* GMC : All details related to gpu memory cluster will be passed within gmcConfigs.\n" }, "timeCreated": { "type": "string", "description": "The date and time the instance configuration was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "compartmentId", "deferredFields", "definedTags", "displayName", "freeformTags", "gmcConfigs", "id", "instanceDetails", "instanceId", "source", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationGmcConfig:getInstanceConfigurationsInstanceConfigurationGmcConfig": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "gpuMemoryClusterScaleConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig:getInstanceConfigurationsInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig" }, "description": "Configuration settings for GPU Memory Cluster scaling.\n" }, "instanceConfigurationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the base compute instance configuration associated with this GMC configuration entry.\n" }, "size": { "type": "string", "description": "The desired number of instances for this GMC configuration entry.\n" } }, "type": "object", "required": [ "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "gpuMemoryClusterScaleConfigs", "instanceConfigurationId", "size" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig:getInstanceConfigurationsInstanceConfigurationGmcConfigGpuMemoryClusterScaleConfig": { "properties": { "isDownsizeEnabled": { "type": "boolean", "description": "Enables downsizing towards the target size.\n" }, "isUpsizeEnabled": { "type": "boolean", "description": "Enables upsizing towards the target size.\n" }, "targetSize": { "type": "string", "description": "The configured target size for the GPU Memory Cluster.\n" } }, "type": "object", "required": [ "isDownsizeEnabled", "isUpsizeEnabled", "targetSize" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetail": { "properties": { "blockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolume:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolume" }, "description": "Block volume parameters.\n" }, "instanceType": { "type": "string", "description": "The type of instance details. Supported instanceType is compute\n" }, "launchDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetail" }, "description": "Instance launch details for creating an instance from an instance configuration. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" }, "options": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailOption" }, "description": "Multiple Compute Instance Configuration instance details.\n" }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnic:getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnic" }, "description": "Secondary VNIC parameters.\n" } }, "type": "object", "required": [ "blockVolumes", "instanceType", "launchDetails", "options", "secondaryVnics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolume:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolume": { "properties": { "attachDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeAttachDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeAttachDetail" }, "description": "Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/)\n" }, "createDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetail" }, "description": "Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/)\n" }, "volumeId": { "type": "string", "description": "The OCID of the volume.\n" } }, "type": "object", "required": [ "attachDetails", "createDetails", "volumeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeAttachDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeAttachDetail": { "properties": { "device": { "type": "string", "description": "The device name.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment should be created in read-only mode.\n" }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n" } }, "type": "object", "required": [ "device", "displayName", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "type", "useChap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetail": { "properties": { "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "backupPolicyId": { "type": "string", "description": "If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.\n" }, "blockVolumeReplicas": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica" }, "description": "The list of block volume replicas to be enabled for this volume in the specified destination availability domains.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail" } }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "xrcKmsKeyId": { "type": "string", "description": "The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "autotunePolicies", "availabilityDomain", "backupPolicyId", "blockVolumeReplicas", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "isAutoTuneEnabled", "kmsKeyId", "sizeInGbs", "sourceDetails", "vpusPerGb", "xrcKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType", "maxVpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailBlockVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "availabilityDomain", "displayName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailBlockVolumeCreateDetailSourceDetail": { "properties": { "id": { "type": "string", "description": "The OCID of the volume backup.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetail": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig" }, "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation this instance is launched under.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host to place the instance on.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailInstanceOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailInstanceOption" }, "description": "Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints.\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether to enable AI enterprise on the instance.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n" }, "launchOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLaunchOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLaunchOption" }, "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n" }, "licensingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig" }, "description": "List of licensing configurations associated with target launch values.\n" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail" }, "description": "The details for providing placement constraints.\n" }, "platformConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig" }, "description": "The platform configuration requested for the instance.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "preferredMaintenanceAction": { "type": "string", "description": "The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.\n* `LIVE_MIGRATE` - Run maintenance using a live migration.\n* `REBOOT` - Run maintenance using a reboot.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailShapeConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityConfigs", "availabilityDomain", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfigs", "preemptibleInstanceConfigs", "preferredMaintenanceAction", "securityAttributes", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "required": [ "isLiveMigrationPreferred", "recoveryAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailInstanceOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLaunchOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailLicensingConfig": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "licenseType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlacementConstraintDetail": { "properties": { "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group. This is only available for dedicated capacity customers.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "computeHostGroupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n" }, "configMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Instance Platform Configuration Configuration Map for flexible setting input.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n" }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n" }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n" }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n" }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n" }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n" }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "areVirtualInstructionsEnabled", "configMap", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailShapeConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "localVolumeSizeInGbs", "memoryInGbs", "nvmes", "ocpus", "resourceManagement", "vcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "instanceSourceImageFilterDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail" }, "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "instanceSourceImageFilterDetails", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailLaunchDetailSourceDetailInstanceSourceImageFilterDetail": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" } }, "type": "object", "required": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailOption": { "properties": { "blockVolumes": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolume:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolume" }, "description": "Block volume parameters.\n" }, "launchDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetail" }, "description": "Instance launch details for creating an instance from an instance configuration. Use the `sourceDetails` parameter to specify whether a boot volume or an image should be used to launch a new instance.\n" }, "secondaryVnics": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnic:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnic" }, "description": "Secondary VNIC parameters.\n" } }, "type": "object", "required": [ "blockVolumes", "launchDetails", "secondaryVnics" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolume:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolume": { "properties": { "attachDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail" }, "description": "Volume attachmentDetails. Please see [AttachVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/AttachVolumeDetails/)\n" }, "createDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail" }, "description": "Creates a new block volume. Please see [CreateVolumeDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVolumeDetails/)\n" }, "volumeId": { "type": "string", "description": "The OCID of the volume.\n" } }, "type": "object", "required": [ "attachDetails", "createDetails", "volumeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeAttachDetail": { "properties": { "device": { "type": "string", "description": "The device name.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "isReadOnly": { "type": "boolean", "description": "Whether the attachment should be created in read-only mode.\n" }, "isShareable": { "type": "boolean", "description": "Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" }, "useChap": { "type": "boolean", "description": "Whether to use CHAP authentication for the volume attachment. Defaults to false.\n" } }, "type": "object", "required": [ "device", "displayName", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "type", "useChap" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetail": { "properties": { "autotunePolicies": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy" }, "description": "The list of autotune policies enabled for this volume.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "backupPolicyId": { "type": "string", "description": "If provided, specifies the ID of the volume backup policy to assign to the newly created volume. If omitted, no policy will be assigned.\n" }, "blockVolumeReplicas": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica" }, "description": "The list of block volume replicas to be enabled for this volume in the specified destination availability domains.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "isAutoTuneEnabled": { "type": "boolean", "description": "Specifies whether the auto-tune performance is enabled for this boot volume. This field is deprecated. Use the `InstanceConfigurationDetachedVolumeAutotunePolicy` instead to enable the volume for detached autotune.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sizeInGbs": { "type": "string", "description": "The size of the volume in GBs.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail" } }, "vpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "xrcKmsKeyId": { "type": "string", "description": "The OCID of the Vault service key which is the master encryption key for the block volume cross region backups, which will be used in the destination region to encrypt the backup's encryption keys. For more information about the Vault service and encryption keys, see [Overview of Vault service](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Concepts/keyoverview.htm) and [Using Keys](https://docs.cloud.oracle.com/iaas/Content/KeyManagement/Tasks/usingkeys.htm).\n" } }, "type": "object", "required": [ "autotunePolicies", "availabilityDomain", "backupPolicyId", "blockVolumeReplicas", "clusterPlacementGroupId", "compartmentId", "definedTags", "displayName", "freeformTags", "isAutoTuneEnabled", "kmsKeyId", "sizeInGbs", "sourceDetails", "vpusPerGb", "xrcKmsKeyId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailAutotunePolicy": { "properties": { "autotuneType": { "type": "string", "description": "This specifies the type of autotunes supported by OCI.\n" }, "maxVpusPerGb": { "type": "string", "description": "This will be the maximum VPUs/GB performance level that the volume will be auto-tuned temporarily based on performance monitoring.\n" } }, "type": "object", "required": [ "autotuneType", "maxVpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailBlockVolumeReplica": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" } }, "type": "object", "required": [ "availabilityDomain", "displayName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionBlockVolumeCreateDetailSourceDetail": { "properties": { "id": { "type": "string", "description": "The OCID of the volume backup.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "id", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetail": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "availabilityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig" }, "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n" }, "availabilityDomain": { "type": "string", "description": "The availability domain of the instance. Example: `Uocm:PHX-AD-1`\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation this instance is launched under.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host to place the instance on.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n" }, "faultDomain": { "type": "string", "description": "A fault domain is a grouping of hardware and infrastructure within an availability domain. Each availability domain contains three fault domains. Fault domains let you distribute your instances so that they are not on the same physical hardware within a single availability domain. A hardware failure or Compute hardware maintenance that affects one fault domain does not affect instances in other fault domains.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption" }, "description": "Optional mutable instance options. As a part of Instance Metadata Service Security Header, This allows user to disable the legacy imds endpoints.\n" }, "ipxeScript": { "type": "string", "description": "This is an advanced option.\n" }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether to enable AI enterprise on the instance.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n" }, "launchOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption" }, "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n" }, "licensingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig" }, "description": "List of licensing configurations associated with target launch values.\n" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata key/value pairs that you provide, such as the SSH public key required to connect to the instance.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail" }, "description": "The details for providing placement constraints.\n" }, "platformConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig" }, "description": "The platform configuration requested for the instance.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig" }, "description": "Configuration options for preemptible instances.\n" }, "preferredMaintenanceAction": { "type": "string", "description": "The preferred maintenance action for an instance. The default is LIVE_MIGRATE, if live migration is supported.\n* `LIVE_MIGRATE` - Run maintenance using a live migration.\n* `REBOOT` - Run maintenance using a reboot.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig" }, "description": "The shape configuration requested for the instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail" } } }, "type": "object", "required": [ "agentConfigs", "availabilityConfigs", "availabilityDomain", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfigs", "preemptibleInstanceConfigs", "preferredMaintenanceAction", "securityAttributes", "shape", "shapeConfigs", "sourceDetails" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "required": [ "isLiveMigrationPreferred", "recoveryAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [InstanceConfigurationLaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/InstanceConfigurationLaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailLicensingConfig": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "licenseType", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlacementConstraintDetail": { "properties": { "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group. This is only available for dedicated capacity customers.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "computeHostGroupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through.\n" }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n" }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot feature is enabled on the instance.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n" }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether Secure Boot is enabled on the instance.\n" }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is enabled on the instance.\n" }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n" }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "areVirtualInstructionsEnabled", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction" }, "description": "The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailPreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the selected shape is DenseLV, the value must be greater than 0. For all other shapes, the value must be null (if specified); any non-null value for a non-DenseLV shape results in an error.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "nvmes": { "type": "integer", "description": "The number of NVMe drives to be used for storage. A single drive has 6.8 TB available.\n" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "localVolumeSizeInGbs", "memoryInGbs", "nvmes", "ocpus", "resourceManagement", "vcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetail": { "properties": { "bootVolumeId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. The minimum value is 50 GB and the maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "imageId": { "type": "string", "description": "The OCID of the image used to boot the instance.\n" }, "instanceSourceImageFilterDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail" }, "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the volume.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeId", "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "imageId", "instanceSourceImageFilterDetails", "kmsKeyId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionLaunchDetailSourceDetailInstanceSourceImageFilterDetail": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" } }, "type": "object", "required": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnic:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnic": { "properties": { "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" } }, "type": "object", "required": [ "createVnicDetails", "displayName", "nicIndex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailOptionSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnic:getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnic": { "properties": { "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail" }, "description": "Contains the properties of the VNIC for an instance configuration. See [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) and [Instance Configurations](https://docs.cloud.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm#config) for more information.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "nicIndex": { "type": "integer", "description": "Which physical network interface card (NIC) the VNIC will use. Defaults to 0. Certain bare metal instance shapes have two active physical NICs (0 and 1). If you add a secondary VNIC to one of these instances, you can specify which NIC the VNIC will use. For more information, see [Virtual Network Interface Cards (VNICs)](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingVNICs.htm).\n" } }, "type": "object", "required": [ "createVnicDetails", "displayName", "nicIndex" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "assignPrivateDnsRecord": { "type": "boolean", "description": "Whether the VNIC should be assigned a private DNS record. See the `assignPrivateDnsRecord` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "assignPublicIp": { "type": "boolean", "description": "Whether the VNIC should be assigned a public IP address. See the `assignPublicIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the VNIC's primary private IP. See the `hostnameLabel` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure selects an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "nsgIds": { "type": "array", "items": { "type": "string" }, "description": "A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. For more information about NSGs, see [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "privateIp": { "type": "string", "description": "A private IP address of your choice to assign to the VNIC. See the `privateIp` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "privateIpId": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved IP address to use for this VNIC. See the `privateIpId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "[Security attributes](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](https://docs.cloud.oracle.com/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{\"Oracle-DataSecurity-ZPR\": {\"MaxEgressCount\": {\"value\":\"42\",\"mode\":\"audit\"}}}`\n" }, "skipSourceDestCheck": { "type": "boolean", "description": "Whether the source/destination check is disabled on the VNIC. See the `skipSourceDestCheck` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetCidr": { "type": "string", "description": "One of the IPv4 CIDR blocks allocated to the subnet. Represents the IP range from which the VNIC's private IP address will be assigned if `privateIp` or `privateIpId` is not specified. Either this field or the `privateIp` (or `privateIpId`, if applicable) field must be provided, but not both simultaneously. Example: `192.168.1.0/28` See the `subnetCidr` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet to create the VNIC in. See the `subnetId` attribute of [CreateVnicDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/CreateVnicDetails/) for more information.\n" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceConfigurationsInstanceConfigurationInstanceDetailSecondaryVnicCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string", "description": "Optional. An available IPv6 address of your subnet from a valid IPv6 prefix on the subnet (otherwise the IP address is automatically assigned).\n" }, "ipv6id": { "type": "string", "description": "An [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) that specifies a previously-reserved ipv6 to use.\n" }, "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceConsoleConnectionsFilter:getInstanceConsoleConnectionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstanceConsoleConnectionsInstanceConsoleConnection:getInstanceConsoleConnectionsInstanceConsoleConnection": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "connectionString": { "type": "string", "description": "The SSH connection string for the console connection.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "fingerprint": { "type": "string", "description": "The SSH public key's fingerprint for client authentication to the console connection.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The OCID of the console connection.\n" }, "instanceId": { "type": "string", "description": "The OCID of the instance.\n" }, "publicKey": { "type": "string" }, "serviceHostKeyFingerprint": { "type": "string", "description": "The SSH public key's fingerprint for the console connection service host.\n" }, "state": { "type": "string", "description": "The current state of the console connection.\n" }, "vncConnectionString": { "type": "string", "description": "The SSH connection string for the SSH tunnel used to connect to the console connection over VNC.\n" } }, "type": "object", "required": [ "compartmentId", "connectionString", "definedTags", "fingerprint", "freeformTags", "id", "instanceId", "publicKey", "serviceHostKeyFingerprint", "state", "vncConnectionString" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceCreateVnicDetail:getInstanceCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean" }, "assignPrivateDnsRecord": { "type": "boolean" }, "assignPublicIp": { "type": "string" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the instance VNIC's primary private IP.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" } }, "nsgIds": { "type": "array", "items": { "type": "string" } }, "privateIp": { "type": "string", "description": "The private IP address of instance VNIC. To set the private IP address, use the \u003cspan pulumi-lang-nodejs=\"`privateIp`\" pulumi-lang-dotnet=\"`PrivateIp`\" pulumi-lang-go=\"`privateIp`\" pulumi-lang-python=\"`private_ip`\" pulumi-lang-yaml=\"`privateIp`\" pulumi-lang-java=\"`privateIp`\" pulumi-lang-hcl=\"`private_ip`\"\u003e`privateIp`\u003c/span\u003e argument in create_vnic_details.\n" }, "privateIpId": { "type": "string" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: `{\"Oracle-DataSecurity-ZPR.MaxEgressCount.value\": \"42\", \"Oracle-DataSecurity-ZPR.MaxEgressCount.mode\": \"audit\"}`\n" }, "skipSourceDestCheck": { "type": "boolean" }, "subnetCidr": { "type": "string" }, "subnetId": { "type": "string" }, "vlanId": { "type": "string" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string" }, "ipv6id": { "type": "string" }, "ipv6subnetCidr": { "type": "string" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceDevicesDevice:getInstanceDevicesDevice": { "properties": { "isAvailable": { "type": "boolean", "description": "A filter to return only available devices or only used devices.\n" }, "name": { "type": "string", "description": "A filter to return only devices that match the given name exactly.\n" } }, "type": "object", "required": [ "isAvailable", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceDevicesFilter:getInstanceDevicesFilter": { "properties": { "name": { "type": "string", "description": "A filter to return only devices that match the given name exactly.\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstanceInstanceOption:getInstanceInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceLaunchOption:getInstanceLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceLaunchVolumeAttachment:getInstanceLaunchVolumeAttachment": { "properties": { "device": { "type": "string" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "encryptionInTransitType": { "type": "string" }, "isAgentAutoIscsiLoginEnabled": { "type": "boolean" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "isReadOnly": { "type": "boolean" }, "isShareable": { "type": "boolean" }, "launchCreateVolumeDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail:getInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail" } }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" }, "useChap": { "type": "boolean" }, "volumeId": { "type": "string" } }, "type": "object", "required": [ "device", "displayName", "encryptionInTransitType", "isAgentAutoIscsiLoginEnabled", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "launchCreateVolumeDetails", "type", "useChap", "volumeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail:getInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n" }, "sizeInGbs": { "type": "string" }, "volumeCreationType": { "type": "string" }, "vpusPerGb": { "type": "string" } }, "type": "object", "required": [ "compartmentId", "displayName", "kmsKeyId", "sizeInGbs", "volumeCreationType", "vpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceLicensingConfig:getInstanceLicensingConfig": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "osVersion": { "type": "string", "description": "The Operating System version of the license config.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "licenseType", "osVersion", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceMaintenanceEventsFilter:getInstanceMaintenanceEventsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstanceMaintenanceEventsInstanceMaintenanceEvent:getInstanceMaintenanceEventsInstanceMaintenanceEvent": { "properties": { "additionalDetails": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional details of the maintenance in the form of json.\n" }, "alternativeResolutionAction": { "type": "string" }, "alternativeResolutionActions": { "type": "array", "items": { "type": "string" }, "description": "These are alternative actions to the requested instanceAction that can be taken to resolve the Maintenance.\n" }, "canDeleteLocalStorage": { "type": "boolean", "description": "For Instances that have local storage, this field is set to true when local storage will be deleted as a result of the Maintenance.\n" }, "canReschedule": { "type": "boolean", "description": "Indicates if this MaintenanceEvent is capable of being rescheduled up to the timeHardDueDate.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "correlationToken": { "type": "string", "description": "A filter to only return resources that have a matching correlationToken.\n" }, "createdBy": { "type": "string", "description": "The creator of the maintenance event.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "description": { "type": "string", "description": "It is the descriptive information about the maintenance taking place on the customer instance.\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "estimatedDuration": { "type": "string", "description": "This is the estimated duration of the Maintenance, once the Maintenance has entered the STARTED state.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the maintenance event.\n" }, "instanceAction": { "type": "string", "description": "A filter to only return resources that match the given instance action.\n" }, "instanceId": { "type": "string", "description": "The OCID of the instance.\n" }, "instanceMaintenanceEventId": { "type": "string" }, "maintenanceCategory": { "type": "string", "description": "This indicates the priority and allowed actions for this Maintenance. Higher priority forms of Maintenance have tighter restrictions and may not be rescheduled, while lower priority/severity Maintenance can be rescheduled, deferred, or even cancelled. Please see the [Instance Maintenance](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details.\n" }, "maintenanceReason": { "type": "string", "description": "This is the reason that Maintenance is being performed. See [Instance Maintenance](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/placeholder.htm) documentation for details.\n" }, "startWindowDuration": { "type": "string", "description": "The duration of the time window Maintenance is scheduled to begin within.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the maintenance event was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeFinished": { "type": "string", "description": "The time at which the Maintenance actually finished.\n" }, "timeHardDueDate": { "type": "string", "description": "It is the scheduled hard due date and time of the maintenance event. The maintenance event will happen at this time and the due date will not be extended.\n" }, "timeStarted": { "type": "string", "description": "The time at which the Maintenance actually started.\n" }, "timeWindowStart": { "type": "string", "description": "The beginning of the time window when Maintenance is scheduled to begin. The Maintenance will not begin before this time.\n" } }, "type": "object", "required": [ "additionalDetails", "alternativeResolutionAction", "alternativeResolutionActions", "canDeleteLocalStorage", "canReschedule", "compartmentId", "correlationToken", "createdBy", "definedTags", "description", "displayName", "estimatedDuration", "freeformTags", "id", "instanceAction", "instanceId", "instanceMaintenanceEventId", "maintenanceCategory", "maintenanceReason", "startWindowDuration", "state", "timeCreated", "timeFinished", "timeHardDueDate", "timeStarted", "timeWindowStart" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceMeasuredBootReportMeasurement:getInstanceMeasuredBootReportMeasurement": { "properties": { "actuals": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceMeasuredBootReportMeasurementActual:getInstanceMeasuredBootReportMeasurementActual" }, "description": "The list of actual PCR entries measured during boot.\n" }, "policies": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceMeasuredBootReportMeasurementPolicy:getInstanceMeasuredBootReportMeasurementPolicy" }, "description": "The list of expected PCR entries to use during verification.\n" } }, "type": "object", "required": [ "actuals", "policies" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceMeasuredBootReportMeasurementActual:getInstanceMeasuredBootReportMeasurementActual": { "properties": { "hashAlgorithm": { "type": "string", "description": "The type of algorithm used to calculate the hash.\n" }, "pcrIndex": { "type": "string", "description": "The index of the policy.\n" }, "value": { "type": "string", "description": "The hashed PCR value.\n" } }, "type": "object", "required": [ "hashAlgorithm", "pcrIndex", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceMeasuredBootReportMeasurementPolicy:getInstanceMeasuredBootReportMeasurementPolicy": { "properties": { "hashAlgorithm": { "type": "string", "description": "The type of algorithm used to calculate the hash.\n" }, "pcrIndex": { "type": "string", "description": "The index of the policy.\n" }, "value": { "type": "string", "description": "The hashed PCR value.\n" } }, "type": "object", "required": [ "hashAlgorithm", "pcrIndex", "value" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePlacementConstraintDetail:getInstancePlacementConstraintDetail": { "properties": { "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host.\n" }, "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "computeBareMetalHostId", "computeHostGroupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePlatformConfig:getInstancePlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available.\n" }, "configMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Instance Platform Configuration Configuration Map for flexible setting input.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.\n" }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n" }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot is to be enabled on the instance\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n" }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether the Secure Boot is to be enabled on the instance.\n" }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multi-threading is enabled on the instance.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is to be enabled on the instance.\n" }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n" }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "areVirtualInstructionsEnabled", "configMap", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolInstancesFilter:getInstancePoolInstancesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstancePoolInstancesInstance:getInstancePoolInstancesInstance": { "properties": { "autoTerminateInstanceOnDelete": { "type": "boolean" }, "availabilityDomain": { "type": "string", "description": "The availability domain the instance is running in.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "decrementSizeOnDelete": { "type": "boolean" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "faultDomain": { "type": "string", "description": "The fault domain the instance is running in.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance.\n" }, "instanceConfigurationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration used to create the instance.\n" }, "instanceId": { "type": "string" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.\n" }, "loadBalancerBackends": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolInstancesInstanceLoadBalancerBackend:getInstancePoolInstancesInstanceLoadBalancerBackend" }, "description": "The load balancer backends that are configured for the instance pool instance.\n" }, "region": { "type": "string", "description": "The region that contains the availability domain the instance is running in.\n" }, "shape": { "type": "string", "description": "The shape of an instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.\n" }, "state": { "type": "string", "description": "The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance) resource.\n" }, "timeCreated": { "type": "string", "description": "The date and time the instance pool instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "autoTerminateInstanceOnDelete", "availabilityDomain", "compartmentId", "decrementSizeOnDelete", "displayName", "faultDomain", "id", "instanceConfigurationId", "instanceId", "instancePoolId", "loadBalancerBackends", "region", "shape", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolInstancesInstanceLoadBalancerBackend:getInstancePoolInstancesInstanceLoadBalancerBackend": { "properties": { "backendHealthStatus": { "type": "string", "description": "The health of the backend as observed by the load balancer.\n" }, "backendName": { "type": "string", "description": "The name of the backend in the backend set.\n" }, "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "loadBalancerId": { "type": "string", "description": "The OCID of the load balancer attached to the instance pool.\n" }, "state": { "type": "string", "description": "The lifecycle state of the instance. Refer to `lifecycleState` in the [Instance](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Instance) resource.\n" } }, "type": "object", "required": [ "backendHealthStatus", "backendName", "backendSetName", "loadBalancerId", "state" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolLifecycleManagement:getInstancePoolLifecycleManagement": { "properties": { "lifecycleActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolLifecycleManagementLifecycleAction:getInstancePoolLifecycleManagementLifecycleAction" }, "description": "The lifecycle actions for the instance pool.\n" } }, "type": "object", "required": [ "lifecycleActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolLifecycleManagementLifecycleAction:getInstancePoolLifecycleManagementLifecycleAction": { "properties": { "preTerminations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolLifecycleManagementLifecycleActionPreTermination:getInstancePoolLifecycleManagementLifecycleActionPreTermination" }, "description": "The data for pre-termination action for an instance pool\n" } }, "type": "object", "required": [ "preTerminations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolLifecycleManagementLifecycleActionPreTermination:getInstancePoolLifecycleManagementLifecycleActionPreTermination": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether pre-termination action is enabled or not.\n" }, "onTimeouts": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout:getInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout" }, "description": "Options to handle timeout for pre-termination action.\n" }, "timeout": { "type": "integer", "description": "The timeout in seconds for pre-termination action for an instance pool(min = 0 sec, max = 7200 secs).\n" } }, "type": "object", "required": [ "isEnabled", "onTimeouts", "timeout" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout:getInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout": { "properties": { "preserveBlockVolumeMode": { "type": "string", "description": "Whether the block volume should be preserved after termination.\n" }, "preserveBootVolumeMode": { "type": "string", "description": "Whether the boot volume should be preserved after termination.\n" } }, "type": "object", "required": [ "preserveBlockVolumeMode", "preserveBootVolumeMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolLoadBalancer:getInstancePoolLoadBalancer": { "properties": { "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.\n" }, "loadBalancerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool.\n" }, "port": { "type": "integer", "description": "The port value used for the backends.\n" }, "state": { "type": "string", "description": "The current state of the instance pool.\n" }, "vnicSelection": { "type": "string", "description": "Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.\n" } }, "type": "object", "required": [ "backendSetName", "id", "instancePoolId", "loadBalancerId", "port", "state", "vnicSelection" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolPlacementConfiguration:getInstancePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domains to place instances.\n" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolPlacementConfigurationPrimaryVnicSubnet:getInstancePoolPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolPlacementConfigurationSecondaryVnicSubnet:getInstancePoolPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain", "computeClusterId", "faultDomains", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolPlacementConfigurationPrimaryVnicSubnet:getInstancePoolPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolPlacementConfigurationSecondaryVnicSubnet:getInstancePoolPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "The display name of the VNIC. This is also used to match against the instance configuration defined secondary VNIC.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsFilter:getInstancePoolsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstancePoolsInstancePool:getInstancePoolsInstancePool": { "properties": { "actualSize": { "type": "integer" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "currentSize": { "type": "integer", "description": "Count of instance in running state associated to the Instance Pool.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instanceConfigurationId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated with the instance pool.\n" }, "instanceDisplayNameFormatter": { "type": "string", "description": "A user-friendly formatter for the instance pool's instances. Instance displaynames follow the format. The formatter does not retroactively change instance's displaynames, only instance displaynames in the future follow the format\n" }, "instanceHostnameFormatter": { "type": "string", "description": "A user-friendly formatter for the instance pool's instances. Instance hostnames follow the format. The formatter does not retroactively change instance's hostnames, only instance hostnames in the future follow the format\n" }, "lifecycleManagements": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolLifecycleManagement:getInstancePoolsInstancePoolLifecycleManagement" }, "description": "The lifecycle management options for the instance pool.\n" }, "loadBalancers": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolLoadBalancer:getInstancePoolsInstancePoolLoadBalancer" }, "description": "The load balancers attached to the instance pool.\n" }, "placementConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolPlacementConfiguration:getInstancePoolsInstancePoolPlacementConfiguration" }, "description": "The placement configurations for the instance pool.\n" }, "poolType": { "type": "string", "description": "The type of resources managed by the pool.\n" }, "size": { "type": "integer", "description": "The number of actual instances in the instance pool on the cloud. This attribute will be different when instance pool is used along with autoScaling Configuration.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "actualSize", "compartmentId", "currentSize", "definedTags", "displayName", "freeformTags", "id", "instanceConfigurationId", "instanceDisplayNameFormatter", "instanceHostnameFormatter", "lifecycleManagements", "loadBalancers", "placementConfigurations", "poolType", "size", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolLifecycleManagement:getInstancePoolsInstancePoolLifecycleManagement": { "properties": { "lifecycleActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolLifecycleManagementLifecycleAction:getInstancePoolsInstancePoolLifecycleManagementLifecycleAction" }, "description": "The lifecycle actions for the instance pool.\n" } }, "type": "object", "required": [ "lifecycleActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolLifecycleManagementLifecycleAction:getInstancePoolsInstancePoolLifecycleManagementLifecycleAction": { "properties": { "preTerminations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTermination:getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTermination" }, "description": "The data for pre-termination action for an instance pool\n" } }, "type": "object", "required": [ "preTerminations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTermination:getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTermination": { "properties": { "isEnabled": { "type": "boolean", "description": "Whether pre-termination action is enabled or not.\n" }, "onTimeouts": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout:getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout" }, "description": "Options to handle timeout for pre-termination action.\n" }, "timeout": { "type": "integer", "description": "The timeout in seconds for pre-termination action for an instance pool(min = 0 sec, max = 7200 secs).\n" } }, "type": "object", "required": [ "isEnabled", "onTimeouts", "timeout" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout:getInstancePoolsInstancePoolLifecycleManagementLifecycleActionPreTerminationOnTimeout": { "properties": { "preserveBlockVolumeMode": { "type": "string", "description": "Whether the block volume should be preserved after termination.\n" }, "preserveBootVolumeMode": { "type": "string", "description": "Whether the boot volume should be preserved after termination.\n" } }, "type": "object", "required": [ "preserveBlockVolumeMode", "preserveBootVolumeMode" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolLoadBalancer:getInstancePoolsInstancePoolLoadBalancer": { "properties": { "backendSetName": { "type": "string", "description": "The name of the backend set on the load balancer.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attachment.\n" }, "instancePoolId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool of the load balancer attachment.\n" }, "loadBalancerId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the load balancer attached to the instance pool.\n" }, "port": { "type": "integer", "description": "The port value used for the backends.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "vnicSelection": { "type": "string", "description": "Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are \"PrimaryVnic\" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.\n" } }, "type": "object", "required": [ "backendSetName", "id", "instancePoolId", "loadBalancerId", "port", "state", "vnicSelection" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolPlacementConfiguration:getInstancePoolsInstancePoolPlacementConfiguration": { "properties": { "availabilityDomain": { "type": "string", "description": "The availability domain to place instances. Example: `Uocm:PHX-AD-1`\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) that the instance will be created in.\n" }, "faultDomains": { "type": "array", "items": { "type": "string" }, "description": "The fault domains to place instances.\n" }, "primarySubnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary subnet to place instances. This field is deprecated. Use `primaryVnicSubnets` instead to set VNIC data for instances in the pool.\n" }, "primaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnet:getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnet" }, "description": "Details about the IPv6 primary subnet.\n" }, "secondaryVnicSubnets": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnet:getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnet" }, "description": "The set of secondary VNIC data for instances in the pool.\n" } }, "type": "object", "required": [ "availabilityDomain", "computeClusterId", "faultDomains", "primarySubnetId", "primaryVnicSubnets", "secondaryVnicSubnets" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnet:getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnet": { "properties": { "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolsInstancePoolPlacementConfigurationPrimaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnet:getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnet": { "properties": { "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail" }, "description": "A list of IPv6 prefix ranges from which the VNIC should be assigned an IPv6 address. You can provide only the prefix ranges and Oracle Cloud Infrastructure will select an available address from the range. You can optionally choose to leave the prefix range empty and instead provide the specific IPv6 address that should be used from within that range.\n" }, "isAssignIpv6ip": { "type": "boolean", "description": "Whether to allocate an IPv6 address at instance and VNIC creation from an IPv6 enabled subnet. Default: False. When provided you may optionally provide an IPv6 prefix (`ipv6SubnetCidr`) of your choice to assign the IPv6 address from. If `ipv6SubnetCidr` is not provided then an IPv6 prefix is chosen for you.\n" }, "subnetId": { "type": "string", "description": "The subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) for the secondary VNIC.\n" } }, "type": "object", "required": [ "displayName", "ipv6addressIpv6subnetCidrPairDetails", "isAssignIpv6ip", "subnetId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail:getInstancePoolsInstancePoolPlacementConfigurationSecondaryVnicSubnetIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6subnetCidr": { "type": "string", "description": "Optional. Used to disambiguate which subnet prefix should be used to create an IPv6 allocation.\n" } }, "type": "object", "required": [ "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePreemptibleInstanceConfig:getInstancePreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancePreemptibleInstanceConfigPreemptionAction:getInstancePreemptibleInstanceConfigPreemptionAction" }, "description": "(Required) The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancePreemptibleInstanceConfigPreemptionAction:getInstancePreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceShapeConfig:getInstanceShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "gpuDescription": { "type": "string", "description": "A short description of the instance's graphics processing unit (GPU).\n" }, "gpus": { "type": "integer", "description": "The number of GPUs available to the instance.\n" }, "localDiskDescription": { "type": "string", "description": "A short description of the local disks available to this instance.\n" }, "localDisks": { "type": "integer", "description": "The number of local disks available to the instance.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "The aggregate size of all local disks, in gigabytes.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the shape is DenseLV, the value will be greater than 0. For all other shapes, the value will be null.\n" }, "maxVnicAttachments": { "type": "integer", "description": "The maximum number of VNIC attachments for the instance.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "The networking bandwidth available to the instance, in gigabits per second.\n" }, "nvmes": { "type": "integer" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "processorDescription": { "type": "string", "description": "A short description of the instance's processor (CPU).\n" }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "gpuDescription", "gpus", "localDiskDescription", "localDisks", "localDisksTotalSizeInGbs", "localVolumeSizeInGbs", "maxVnicAttachments", "memoryInGbs", "networkingBandwidthInGbps", "nvmes", "ocpus", "processorDescription", "resourceManagement", "vcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceSourceDetail:getInstanceSourceDetail": { "properties": { "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "instanceSourceImageFilterDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstanceSourceDetailInstanceSourceImageFilterDetail:getInstanceSourceDetailInstanceSourceImageFilterDetail" }, "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n" }, "isPreserveBootVolumeEnabled": { "type": "boolean" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n" }, "sourceId": { "type": "string", "description": "The OCID of the boot volume used to boot the instance.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "instanceSourceImageFilterDetails", "isPreserveBootVolumeEnabled", "kmsKeyId", "sourceId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstanceSourceDetailInstanceSourceImageFilterDetail:getInstanceSourceDetailInstanceSourceImageFilterDetail": { "properties": { "compartmentId": { "type": "string", "description": "The OCID of the compartment containing images to search\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" } }, "type": "object", "required": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesFilter:getInstancesFilter": { "properties": { "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInstancesInstance:getInstancesInstance": { "properties": { "agentConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceAgentConfig:getInstancesInstanceAgentConfig" }, "description": "Configuration options for the Oracle Cloud Agent software running on the instance.\n" }, "async": { "type": "boolean" }, "availabilityConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceAvailabilityConfig:getInstancesInstanceAvailabilityConfig" }, "description": "Options for defining the availabiity of a VM instance after a maintenance event that impacts the underlying hardware.\n" }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "bootVolumeId": { "type": "string", "description": "The OCID of the attached boot volume. If the \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e is `bootVolume`, this will be the same OCID as the \u003cspan pulumi-lang-nodejs=\"`sourceId`\" pulumi-lang-dotnet=\"`SourceId`\" pulumi-lang-go=\"`sourceId`\" pulumi-lang-python=\"`source_id`\" pulumi-lang-yaml=\"`sourceId`\" pulumi-lang-java=\"`sourceId`\" pulumi-lang-hcl=\"`source_id`\"\u003e`sourceId`\u003c/span\u003e.\n" }, "capacityReservationId": { "type": "string", "description": "The OCID of the compute capacity reservation.\n" }, "clusterPlacementGroupId": { "type": "string", "description": "The OCID of the cluster placement group of the instance.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "computeClusterId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compute cluster. A [compute cluster](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/compute-clusters.htm) is a remote direct memory access (RDMA) network group.\n" }, "createVnicDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceCreateVnicDetail:getInstancesInstanceCreateVnicDetail" } }, "dedicatedVmHostId": { "type": "string", "description": "The OCID of the dedicated virtual machine host that the instance is placed on.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "extendedMetadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Additional metadata key/value pairs that you provide. They serve the same purpose and functionality as fields in the \u003cspan pulumi-lang-nodejs=\"`metadata`\" pulumi-lang-dotnet=\"`Metadata`\" pulumi-lang-go=\"`metadata`\" pulumi-lang-python=\"`metadata`\" pulumi-lang-yaml=\"`metadata`\" pulumi-lang-java=\"`metadata`\" pulumi-lang-hcl=\"`metadata`\"\u003e`metadata`\u003c/span\u003e object.\n" }, "faultDomain": { "type": "string", "description": "The name of the fault domain the instance is running in.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "deprecationMessage": "The 'hostname_label' field has been deprecated. Please use 'hostname_label under create_vnic_details' instead." }, "id": { "type": "string", "description": "The OCID of the instance.\n" }, "image": { "type": "string", "description": "Deprecated. Use `sourceDetails` instead.\n", "deprecationMessage": "The 'image' field has been deprecated. Please use 'source_details' instead. If both fields are specified, then 'source_details' will be used." }, "instanceConfigurationId": { "type": "string", "description": "The OCID of the Instance Configuration used to source launch details for this instance. Any other fields supplied in the instance launch request override the details stored in the Instance Configuration for this instance launch.\n" }, "instanceOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceInstanceOption:getInstancesInstanceInstanceOption" }, "description": "Optional mutable instance options\n" }, "ipxeScript": { "type": "string", "description": "When a bare metal or virtual machine instance boots, the iPXE firmware that runs on the instance is configured to run an iPXE script to continue the boot process.\n" }, "isAiEnterpriseEnabled": { "type": "boolean", "description": "Whether AI enterprise is enabled on the instance.\n" }, "isCrossNumaNode": { "type": "boolean", "description": "Whether the instance’s OCPUs and memory are distributed across multiple NUMA nodes.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "launchMode": { "type": "string", "description": "Specifies the configuration mode for launching virtual machine (VM) instances. The configuration modes are:\n* `NATIVE` - VM instances launch with iSCSI boot and VFIO devices. The default value for platform images.\n* `EMULATED` - VM instances launch with emulated devices, such as the E1000 network driver and emulated SCSI disk controller.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n* `CUSTOM` - VM instances launch with custom configuration settings specified in the `LaunchOptions` parameter.\n" }, "launchOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceLaunchOption:getInstancesInstanceLaunchOption" }, "description": "Options for tuning the compatibility and performance of VM shapes. The values that you specify override any default values.\n" }, "launchVolumeAttachments": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceLaunchVolumeAttachment:getInstancesInstanceLaunchVolumeAttachment" } }, "licensingConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceLicensingConfig:getInstancesInstanceLicensingConfig" }, "description": "List of licensing configurations associated with the instance.\n" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Custom metadata that you provide.\n" }, "placementConstraintDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstancePlacementConstraintDetail:getInstancesInstancePlacementConstraintDetail" }, "description": "Generic placement details field which is overloaded with bare metal host id or host group id based on the resource we are targeting to launch.\n" }, "platformConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstancePlatformConfig:getInstancesInstancePlatformConfig" }, "description": "The platform configuration for the instance.\n" }, "preemptibleInstanceConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstancePreemptibleInstanceConfig:getInstancesInstancePreemptibleInstanceConfig" }, "description": "(Optional) Configuration options for preemptible instances.\n" }, "preserveBootVolume": { "type": "boolean", "description": "(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "preserveDataVolumesCreatedAtLaunch": { "type": "boolean" }, "privateIp": { "type": "string" }, "publicIp": { "type": "string" }, "region": { "type": "string", "description": "The region that contains the availability domain the instance is running in.\n" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: `{\"Oracle-DataSecurity-ZPR.MaxEgressCount.value\": \"42\", \"Oracle-DataSecurity-ZPR.MaxEgressCount.mode\": \"audit\"}`\n" }, "securityAttributesState": { "type": "string", "description": "The lifecycle state of the `securityAttributes`\n" }, "shape": { "type": "string", "description": "The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance. You can enumerate all available shapes by calling [ListShapes](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Shape/ListShapes).\n" }, "shapeConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceShapeConfig:getInstancesInstanceShapeConfig" }, "description": "The shape configuration for an instance. The shape configuration determines the resources allocated to an instance.\n" }, "sourceDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceSourceDetail:getInstancesInstanceSourceDetail" } }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "subnetId": { "type": "string", "deprecationMessage": "The 'subnet_id' field has been deprecated. Please use 'subnet_id under create_vnic_details' instead." }, "systemTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace.bar-key\": \"value\"}`\n" }, "timeCreated": { "type": "string", "description": "The date and time the instance was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeMaintenanceRebootDue": { "type": "string", "description": "The date and time the instance is expected to be stopped / started, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). After that time if instance hasn't been rebooted, Oracle will reboot the instance within 24 hours of the due time. Regardless of how the instance was stopped, the flag will be reset to empty as soon as instance reaches Stopped state. Example: `2018-05-25T21:10:29.600Z`\n" }, "updateOperationConstraint": { "type": "string" } }, "type": "object", "required": [ "agentConfigs", "async", "availabilityConfigs", "availabilityDomain", "bootVolumeId", "capacityReservationId", "clusterPlacementGroupId", "compartmentId", "computeClusterId", "createVnicDetails", "dedicatedVmHostId", "definedTags", "displayName", "extendedMetadata", "faultDomain", "freeformTags", "hostnameLabel", "id", "image", "instanceConfigurationId", "instanceOptions", "ipxeScript", "isAiEnterpriseEnabled", "isCrossNumaNode", "isPvEncryptionInTransitEnabled", "launchMode", "launchOptions", "launchVolumeAttachments", "licensingConfigs", "metadata", "placementConstraintDetails", "platformConfigs", "preemptibleInstanceConfigs", "preserveBootVolume", "preserveDataVolumesCreatedAtLaunch", "privateIp", "publicIp", "region", "securityAttributes", "securityAttributesState", "shape", "shapeConfigs", "sourceDetails", "state", "subnetId", "systemTags", "timeCreated", "timeMaintenanceRebootDue", "updateOperationConstraint" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceAgentConfig:getInstancesInstanceAgentConfig": { "properties": { "areAllPluginsDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all of the available plugins. This includes the management and monitoring plugins.\n" }, "isManagementDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can run all the available management plugins.\n" }, "isMonitoringDisabled": { "type": "boolean", "description": "Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins.\n" }, "pluginsConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceAgentConfigPluginsConfig:getInstancesInstanceAgentConfigPluginsConfig" }, "description": "The configuration of plugins associated with this instance.\n" } }, "type": "object", "required": [ "areAllPluginsDisabled", "isManagementDisabled", "isMonitoringDisabled", "pluginsConfigs" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceAgentConfigPluginsConfig:getInstancesInstanceAgentConfigPluginsConfig": { "properties": { "desiredState": { "type": "string", "description": "Whether the plugin should be enabled or disabled.\n" }, "name": { "type": "string", "description": "The plugin name. To get a list of available plugins, use the [ListInstanceagentAvailablePlugins](https://docs.cloud.oracle.com/iaas/api/#/en/instanceagent/20180530/Plugin/ListInstanceagentAvailablePlugins) operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).\n" } }, "type": "object", "required": [ "desiredState", "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceAvailabilityConfig:getInstancesInstanceAvailabilityConfig": { "properties": { "isLiveMigrationPreferred": { "type": "boolean", "description": "Whether to live migrate supported VM instances to a healthy physical VM host without disrupting running instances during infrastructure maintenance events. If null, Oracle chooses the best option for migrating the VM during infrastructure maintenance events.\n" }, "recoveryAction": { "type": "string", "description": "The lifecycle state for an instance when it is recovered after infrastructure maintenance.\n* `RESTORE_INSTANCE` - The instance is restored to the lifecycle state it was in before the maintenance event. If the instance was running, it is automatically rebooted. This is the default action when a value is not set.\n* `STOP_INSTANCE` - The instance is recovered in the stopped state.\n" } }, "type": "object", "required": [ "isLiveMigrationPreferred", "recoveryAction" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceCreateVnicDetail:getInstancesInstanceCreateVnicDetail": { "properties": { "assignIpv6ip": { "type": "boolean" }, "assignPrivateDnsRecord": { "type": "boolean" }, "assignPublicIp": { "type": "string" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string" }, "ipv6addressIpv6subnetCidrPairDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstancesInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail" } }, "nsgIds": { "type": "array", "items": { "type": "string" } }, "privateIp": { "type": "string" }, "privateIpId": { "type": "string" }, "securityAttributes": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Security Attributes for this resource. This is unique to ZPR, and helps identify which resources are allowed to be accessed by what permission controls. Example: `{\"Oracle-DataSecurity-ZPR.MaxEgressCount.value\": \"42\", \"Oracle-DataSecurity-ZPR.MaxEgressCount.mode\": \"audit\"}`\n" }, "skipSourceDestCheck": { "type": "boolean" }, "subnetCidr": { "type": "string" }, "subnetId": { "type": "string" }, "vlanId": { "type": "string" } }, "type": "object", "required": [ "assignIpv6ip", "assignPrivateDnsRecord", "assignPublicIp", "definedTags", "displayName", "freeformTags", "hostnameLabel", "ipv6addressIpv6subnetCidrPairDetails", "nsgIds", "privateIp", "privateIpId", "securityAttributes", "skipSourceDestCheck", "subnetCidr", "subnetId", "vlanId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail:getInstancesInstanceCreateVnicDetailIpv6addressIpv6subnetCidrPairDetail": { "properties": { "ipv6address": { "type": "string" }, "ipv6id": { "type": "string" }, "ipv6subnetCidr": { "type": "string" } }, "type": "object", "required": [ "ipv6address", "ipv6id", "ipv6subnetCidr" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceInstanceOption:getInstancesInstanceInstanceOption": { "properties": { "areLegacyImdsEndpointsDisabled": { "type": "boolean", "description": "Whether to disable the legacy (/v1) instance metadata service endpoints. Customers who have migrated to /v2 should set this to true for added security. Default is false.\n" } }, "type": "object", "required": [ "areLegacyImdsEndpointsDisabled" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceLaunchOption:getInstancesInstanceLaunchOption": { "properties": { "bootVolumeType": { "type": "string", "description": "Emulation type for the boot volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" }, "firmware": { "type": "string", "description": "Firmware used to boot VM. Select the option that matches your operating system.\n* `BIOS` - Boot VM using BIOS style firmware. This is compatible with both 32 bit and 64 bit operating systems that boot using MBR style bootloaders.\n* `UEFI_64` - Boot VM using UEFI style firmware compatible with 64 bit operating systems. This is the default for platform images.\n" }, "isConsistentVolumeNamingEnabled": { "type": "boolean", "description": "Whether to enable consistent volume naming feature. Defaults to false.\n" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "networkType": { "type": "string", "description": "Emulation type for the physical network interface card (NIC).\n* `E1000` - Emulated Gigabit ethernet controller. Compatible with Linux e1000 network driver.\n* `VFIO` - Direct attached Virtual Function network controller. This is the networking type when you launch an instance using hardware-assisted (SR-IOV) networking.\n* `PARAVIRTUALIZED` - VM instances launch with paravirtualized devices using VirtIO drivers.\n* `ACCELERATEDPV` - VM instances launch with accelerated paravirtualized networking type.\n" }, "remoteDataVolumeType": { "type": "string", "description": "Emulation type for volume.\n* `ISCSI` - ISCSI attached block storage device.\n* `SCSI` - Emulated SCSI disk.\n* `IDE` - Emulated IDE disk.\n* `VFIO` - Direct attached Virtual Function storage. This is the default option for local data volumes on platform images.\n* `PARAVIRTUALIZED` - Paravirtualized disk. This is the default for boot volumes and remote block storage volumes on platform images.\n" } }, "type": "object", "required": [ "bootVolumeType", "firmware", "isConsistentVolumeNamingEnabled", "isPvEncryptionInTransitEnabled", "networkType", "remoteDataVolumeType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceLaunchVolumeAttachment:getInstancesInstanceLaunchVolumeAttachment": { "properties": { "device": { "type": "string" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "encryptionInTransitType": { "type": "string" }, "isAgentAutoIscsiLoginEnabled": { "type": "boolean" }, "isPvEncryptionInTransitEnabled": { "type": "boolean", "description": "Deprecated. Instead use `isPvEncryptionInTransitEnabled` in [LaunchInstanceDetails](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/datatypes/LaunchInstanceDetails).\n" }, "isReadOnly": { "type": "boolean" }, "isShareable": { "type": "boolean" }, "launchCreateVolumeDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail:getInstancesInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail" } }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" }, "useChap": { "type": "boolean" }, "volumeId": { "type": "string" } }, "type": "object", "required": [ "device", "displayName", "encryptionInTransitType", "isAgentAutoIscsiLoginEnabled", "isPvEncryptionInTransitEnabled", "isReadOnly", "isShareable", "launchCreateVolumeDetails", "type", "useChap", "volumeId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail:getInstancesInstanceLaunchVolumeAttachmentLaunchCreateVolumeDetail": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n" }, "sizeInGbs": { "type": "string" }, "volumeCreationType": { "type": "string" }, "vpusPerGb": { "type": "string" } }, "type": "object", "required": [ "compartmentId", "displayName", "kmsKeyId", "sizeInGbs", "volumeCreationType", "vpusPerGb" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceLicensingConfig:getInstancesInstanceLicensingConfig": { "properties": { "licenseType": { "type": "string", "description": "License Type for the OS license.\n* `OCI_PROVIDED` - Oracle Cloud Infrastructure provided license (e.g. metered $/OCPU-hour).\n* `BRING_YOUR_OWN_LICENSE` - Bring your own license.\n* `PARTNER_PROVIDED` - Partner provided license.\n" }, "osVersion": { "type": "string", "description": "The Operating System version of the license config.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "licenseType", "osVersion", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstancePlacementConstraintDetail:getInstancesInstancePlacementConstraintDetail": { "properties": { "computeBareMetalHostId": { "type": "string", "description": "The OCID of the compute bare metal host.\n" }, "computeHostGroupId": { "type": "string", "description": "The OCID of the compute host group.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "computeBareMetalHostId", "computeHostGroupId", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstancePlatformConfig:getInstancesInstancePlatformConfig": { "properties": { "areVirtualInstructionsEnabled": { "type": "boolean", "description": "Whether virtualization instructions are available.\n" }, "configMap": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Instance Platform Configuration Configuration Map for flexible setting input.\n" }, "isAccessControlServiceEnabled": { "type": "boolean", "description": "Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device passthrough.\n" }, "isInputOutputMemoryManagementUnitEnabled": { "type": "boolean", "description": "Whether the input-output memory management unit is enabled.\n" }, "isMeasuredBootEnabled": { "type": "boolean", "description": "Whether the Measured Boot is to be enabled on the instance.\n" }, "isMemoryEncryptionEnabled": { "type": "boolean", "description": "Whether the instance is a confidential instance. If this value is \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e, the instance is a confidential instance. The default value is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e.\n" }, "isSecureBootEnabled": { "type": "boolean", "description": "Whether the Secure Boot is to be enabled on the instance.\n" }, "isSymmetricMultiThreadingEnabled": { "type": "boolean", "description": "Whether symmetric multi-threading is enabled on the instance.\n" }, "isTrustedPlatformModuleEnabled": { "type": "boolean", "description": "Whether the Trusted Platform Module (TPM) is to be enabled on the instance.\n" }, "numaNodesPerSocket": { "type": "string", "description": "The number of NUMA nodes per socket (NPS).\n" }, "percentageOfCoresEnabled": { "type": "integer", "description": "The percentage of cores enabled.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "areVirtualInstructionsEnabled", "configMap", "isAccessControlServiceEnabled", "isInputOutputMemoryManagementUnitEnabled", "isMeasuredBootEnabled", "isMemoryEncryptionEnabled", "isSecureBootEnabled", "isSymmetricMultiThreadingEnabled", "isTrustedPlatformModuleEnabled", "numaNodesPerSocket", "percentageOfCoresEnabled", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstancePreemptibleInstanceConfig:getInstancesInstancePreemptibleInstanceConfig": { "properties": { "preemptionActions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstancePreemptibleInstanceConfigPreemptionAction:getInstancesInstancePreemptibleInstanceConfigPreemptionAction" }, "description": "(Required) The action to run when the preemptible instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preemptionActions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstancePreemptibleInstanceConfigPreemptionAction:getInstancesInstancePreemptibleInstanceConfigPreemptionAction": { "properties": { "preserveBootVolume": { "type": "boolean", "description": "(Optional) Whether to preserve the boot volume that was used to launch the preemptible instance when the instance is terminated. Defaults to false if not specified.\n" }, "type": { "type": "string", "description": "(Required) The type of action to run when the instance is interrupted for eviction.\n" } }, "type": "object", "required": [ "preserveBootVolume", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceShapeConfig:getInstancesInstanceShapeConfig": { "properties": { "baselineOcpuUtilization": { "type": "string", "description": "The baseline OCPU utilization for a subcore burstable VM instance. Leave this attribute blank for a non-burstable instance, or explicitly specify non-burstable with `BASELINE_1_1`.\n" }, "gpuDescription": { "type": "string", "description": "A short description of the instance's graphics processing unit (GPU).\n" }, "gpus": { "type": "integer", "description": "The number of GPUs available to the instance.\n" }, "localDiskDescription": { "type": "string", "description": "A short description of the local disks available to this instance.\n" }, "localDisks": { "type": "integer", "description": "The number of local disks available to the instance.\n" }, "localDisksTotalSizeInGbs": { "type": "number", "description": "The aggregate size of all local disks, in gigabytes.\n" }, "localVolumeSizeInGbs": { "type": "integer", "description": "The NVMe-backed local storage capacity, in GB, for flexible dense (DenseLV) VM shapes. If the shape is DenseLV, the value will be greater than 0. For all other shapes, the value will be null.\n" }, "maxVnicAttachments": { "type": "integer", "description": "The maximum number of VNIC attachments for the instance.\n" }, "memoryInGbs": { "type": "number", "description": "The total amount of memory available to the instance, in gigabytes.\n" }, "networkingBandwidthInGbps": { "type": "number", "description": "The networking bandwidth available to the instance, in gigabits per second.\n" }, "nvmes": { "type": "integer" }, "ocpus": { "type": "number", "description": "The total number of OCPUs available to the instance.\n" }, "processorDescription": { "type": "string", "description": "A short description of the instance's processor (CPU).\n" }, "resourceManagement": { "type": "string", "description": "This field is reserved for internal use.\n" }, "vcpus": { "type": "integer", "description": "The total number of VCPUs available to the instance. This can be used instead of OCPUs, in which case the actual number of OCPUs will be calculated based on this value and the actual hardware. This must be a multiple of 2.\n" } }, "type": "object", "required": [ "baselineOcpuUtilization", "gpuDescription", "gpus", "localDiskDescription", "localDisks", "localDisksTotalSizeInGbs", "localVolumeSizeInGbs", "maxVnicAttachments", "memoryInGbs", "networkingBandwidthInGbps", "nvmes", "ocpus", "processorDescription", "resourceManagement", "vcpus" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceSourceDetail:getInstancesInstanceSourceDetail": { "properties": { "bootVolumeSizeInGbs": { "type": "string", "description": "The size of the boot volume in GBs. Minimum value is 50 GB and maximum value is 32,768 GB (32 TB).\n" }, "bootVolumeVpusPerGb": { "type": "string", "description": "The number of volume performance units (VPUs) that will be applied to this volume per GB, representing the Block Volume service's elastic performance options. See [Block Volume Performance Levels](https://docs.cloud.oracle.com/iaas/Content/Block/Concepts/blockvolumeperformance.htm#perf_levels) for more information.\n" }, "instanceSourceImageFilterDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getInstancesInstanceSourceDetailInstanceSourceImageFilterDetail:getInstancesInstanceSourceDetailInstanceSourceImageFilterDetail" }, "description": "These are the criteria for selecting an image. This is required if imageId is not specified.\n" }, "isPreserveBootVolumeEnabled": { "type": "boolean" }, "kmsKeyId": { "type": "string", "description": "The OCID of the Vault service key to assign as the master encryption key for the boot volume.\n" }, "sourceId": { "type": "string", "description": "The OCID of an image or a boot volume to use, depending on the value of \u003cspan pulumi-lang-nodejs=\"`sourceType`\" pulumi-lang-dotnet=\"`SourceType`\" pulumi-lang-go=\"`sourceType`\" pulumi-lang-python=\"`source_type`\" pulumi-lang-yaml=\"`sourceType`\" pulumi-lang-java=\"`sourceType`\" pulumi-lang-hcl=\"`source_type`\"\u003e`sourceType`\u003c/span\u003e.\n" }, "sourceType": { "type": "string", "description": "The source type for the instance. Use \u003cspan pulumi-lang-nodejs=\"`image`\" pulumi-lang-dotnet=\"`Image`\" pulumi-lang-go=\"`image`\" pulumi-lang-python=\"`image`\" pulumi-lang-yaml=\"`image`\" pulumi-lang-java=\"`image`\" pulumi-lang-hcl=\"`image`\"\u003e`image`\u003c/span\u003e when specifying the image OCID. Use `bootVolume` when specifying the boot volume OCID.\n" } }, "type": "object", "required": [ "bootVolumeSizeInGbs", "bootVolumeVpusPerGb", "instanceSourceImageFilterDetails", "isPreserveBootVolumeEnabled", "kmsKeyId", "sourceId", "sourceType" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInstancesInstanceSourceDetailInstanceSourceImageFilterDetail:getInstancesInstanceSourceDetailInstanceSourceImageFilterDetail": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTagsFilter": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).\n" }, "operatingSystem": { "type": "string", "description": "The image's operating system. Example: `Oracle Linux`\n" }, "operatingSystemVersion": { "type": "string", "description": "The image's operating system version. Example: `7.2`\n" } }, "type": "object", "required": [ "compartmentId", "definedTagsFilter", "operatingSystem", "operatingSystemVersion" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getInternetGatewaysFilter:getInternetGatewaysFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getInternetGatewaysGateway:getInternetGatewaysGateway": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "enabled": { "type": "boolean", "description": "Whether the gateway is enabled. When the gateway is disabled, traffic is not routed to/from the Internet, regardless of route rules.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The internet gateway's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using.\n" }, "state": { "type": "string", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the internet gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "enabled", "freeformTags", "id", "routeTableId", "state", "timeCreated", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpInventorySubnetCidrIpInventoryCidrUtilizationSummary:getIpInventorySubnetCidrIpInventoryCidrUtilizationSummary": { "properties": { "addressType": { "type": "string", "description": "Address type of the CIDR within a subnet.\n" }, "cidr": { "type": "string", "description": "The CIDR range of a subnet.\n" }, "utilization": { "type": "number", "description": "The CIDR utilisation of a subnet.\n" } }, "type": "object", "required": [ "addressType", "cidr", "utilization" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpInventorySubnetIpInventorySubnetResourceSummary:getIpInventorySubnetIpInventorySubnetResourceSummary": { "properties": { "addressType": { "type": "string", "description": "Address type of the allocated private IP address.\n" }, "assignedResourceName": { "type": "string", "description": "Name of the created resource.\n" }, "assignedResourceType": { "type": "string", "description": "Type of the resource.\n" }, "assignedTime": { "type": "string", "description": "Assigned time of the private IP address.\n" }, "associatedPublicIp": { "type": "string", "description": "Associated public IP address for the private IP address.\n" }, "associatedPublicIpPool": { "type": "string", "description": "Public IP address Pool the IP address is allocated from.\n" }, "dnsHostName": { "type": "string", "description": "DNS hostname of the IP address.\n" }, "ipAddress": { "type": "string", "description": "Lists the allocated private IP address.\n" }, "ipAddressLifetime": { "type": "string", "description": "Lifetime of the allocated private IP address.\n" }, "ipId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IP address.\n" }, "parentCidr": { "type": "string", "description": "The address range the IP address is assigned from.\n" }, "publicIpLifetime": { "type": "string", "description": "Lifetime of the assigned public IP address.\n" } }, "type": "object", "required": [ "addressType", "assignedResourceName", "assignedResourceType", "assignedTime", "associatedPublicIp", "associatedPublicIpPool", "dnsHostName", "ipAddress", "ipAddressLifetime", "ipId", "parentCidr", "publicIpLifetime" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpInventoryVcnOverlapsFilter:getIpInventoryVcnOverlapsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpInventoryVcnOverlapsIpInventoryVcnOverlapSummary:getIpInventoryVcnOverlapsIpInventoryVcnOverlapSummary": { "properties": { "cidr": { "type": "string", "description": "CIDR prefix of the VCN.\n" }, "overlappingCidr": { "type": "string", "description": "The overlapping CIDR prefix.\n" }, "overlappingVcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN .\n" }, "overlappingVcnName": { "type": "string", "description": "Name of the overlapping VCN.\n" } }, "type": "object", "required": [ "cidr", "overlappingCidr", "overlappingVcnId", "overlappingVcnName" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecAlgorithmAllowedPhaseOneParameter:getIpsecAlgorithmAllowedPhaseOneParameter": { "properties": { "authenticationAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Allowed phase two authentication algorithms.\n" }, "dhGroups": { "type": "array", "items": { "type": "string" }, "description": "Allowed phase one Diffie-Hellman groups.\n" }, "encryptionAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Allowed phase two encryption algorithms.\n" } }, "type": "object", "required": [ "authenticationAlgorithms", "dhGroups", "encryptionAlgorithms" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecAlgorithmAllowedPhaseTwoParameter:getIpsecAlgorithmAllowedPhaseTwoParameter": { "properties": { "authenticationAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Allowed phase two authentication algorithms.\n" }, "encryptionAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Allowed phase two encryption algorithms.\n" }, "pfsDhGroups": { "type": "array", "items": { "type": "string" }, "description": "Allowed perfect forward secrecy Diffie-Hellman groups.\n" } }, "type": "object", "required": [ "authenticationAlgorithms", "encryptionAlgorithms", "pfsDhGroups" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecAlgorithmDefaultPhaseOneParameter:getIpsecAlgorithmDefaultPhaseOneParameter": { "properties": { "defaultAuthenticationAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Default phase two authentication algorithms.\n" }, "defaultDhGroups": { "type": "array", "items": { "type": "string" }, "description": "Default phase one Diffie-Hellman groups.\n" }, "defaultEncryptionAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Default phase two encryption algorithms.\n" } }, "type": "object", "required": [ "defaultAuthenticationAlgorithms", "defaultDhGroups", "defaultEncryptionAlgorithms" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecAlgorithmDefaultPhaseTwoParameter:getIpsecAlgorithmDefaultPhaseTwoParameter": { "properties": { "defaultAuthenticationAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Default phase two authentication algorithms.\n" }, "defaultEncryptionAlgorithms": { "type": "array", "items": { "type": "string" }, "description": "Default phase two encryption algorithms.\n" }, "defaultPfsDhGroup": { "type": "string", "description": "Default perfect forward secrecy Diffie-Hellman groups.\n" } }, "type": "object", "required": [ "defaultAuthenticationAlgorithms", "defaultEncryptionAlgorithms", "defaultPfsDhGroup" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConfigFilter:getIpsecConfigFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpsecConfigTunnel:getIpsecConfigTunnel": { "properties": { "ipAddress": { "type": "string", "description": "The IP address of Oracle's VPN headend. Example: `203.0.113.50 `\n" }, "sharedSecret": { "type": "string", "description": "The shared secret of the IPSec tunnel.\n" }, "timeCreated": { "type": "string", "description": "The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "ipAddress", "sharedSecret", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelBgpSessionInfo:getIpsecConnectionTunnelBgpSessionInfo": { "properties": { "bgpIpv6State": { "type": "string", "description": "The state of the BGP IPv6 session.\n" }, "bgpIpv6state": { "type": "string", "deprecationMessage": "The 'bgp_session_info.0.bgp_ipv6state' field has been deprecated. Please use 'bgp_session_info.0.bgp_ipv6_state' instead." }, "bgpState": { "type": "string", "description": "the state of the BGP.\n" }, "customerBgpAsn": { "type": "string", "description": "This is the value of the remote Bgp ASN in asplain format, as a string. Example: 1587232876 (4 byte ASN) or 12345 (2 byte ASN)\n" }, "customerInterfaceIp": { "type": "string", "description": "This is the IPv4 Address used in the BGP peering session for the non-Oracle router. Example: 10.0.0.2/31\n" }, "customerInterfaceIpv6": { "type": "string", "description": "The IPv6 address for the CPE end of the inside tunnel interface.\n" }, "oracleBgpAsn": { "type": "string", "description": "This is the value of the Oracle Bgp ASN in asplain format, as a string. Example: 1587232876 (4 byte ASN) or 12345 (2 byte ASN)\n" }, "oracleInterfaceIp": { "type": "string", "description": "This is the IPv4 Address used in the BGP peering session for the Oracle router. Example: 10.0.0.1/31\n" }, "oracleInterfaceIpv6": { "type": "string", "description": "The IPv6 address for the Oracle end of the inside tunnel interface.\n" } }, "type": "object", "required": [ "bgpIpv6State", "bgpIpv6state", "bgpState", "customerBgpAsn", "customerInterfaceIp", "customerInterfaceIpv6", "oracleBgpAsn", "oracleInterfaceIp", "oracleInterfaceIpv6" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelDpdConfig:getIpsecConnectionTunnelDpdConfig": { "properties": { "dpdMode": { "type": "string", "description": "Dead peer detection (DPD) mode set on the Oracle side of the connection.\n" }, "dpdTimeoutInSec": { "type": "integer", "description": "DPD timeout in seconds.\n" } }, "type": "object", "required": [ "dpdMode", "dpdTimeoutInSec" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelEncryptionDomainConfig:getIpsecConnectionTunnelEncryptionDomainConfig": { "properties": { "cpeTrafficSelectors": { "type": "array", "items": { "type": "string" }, "description": "Lists IPv4 or IPv6-enabled subnets in your on-premises network.\n" }, "oracleTrafficSelectors": { "type": "array", "items": { "type": "string" }, "description": "Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy.\n" } }, "type": "object", "required": [ "cpeTrafficSelectors", "oracleTrafficSelectors" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelPhaseOneDetail:getIpsecConnectionTunnelPhaseOneDetail": { "properties": { "customAuthenticationAlgorithm": { "type": "string", "description": "Phase two authentication algorithm proposed during tunnel negotiation.\n" }, "customDhGroup": { "type": "string", "description": "The proposed custom Diffie-Hellman group.\n" }, "customEncryptionAlgorithm": { "type": "string", "description": "The proposed custom phase two encryption algorithm.\n" }, "isCustomPhaseOneConfig": { "type": "boolean", "description": "Indicates whether custom phase one configuration is enabled. If this option is not enabled, default settings are proposed.\n" }, "isIkeEstablished": { "type": "boolean", "description": "Indicates whether IKE phase one is established.\n" }, "lifetime": { "type": "integer", "description": "The total configured lifetime of the IKE security association.\n" }, "negotiatedAuthenticationAlgorithm": { "type": "string", "description": "The negotiated phase two authentication algorithm.\n" }, "negotiatedDhGroup": { "type": "string", "description": "The negotiated Diffie-Hellman group.\n" }, "negotiatedEncryptionAlgorithm": { "type": "string", "description": "The negotiated encryption algorithm.\n" }, "remainingLifetime": { "type": "string", "deprecationMessage": "The 'phase_one_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_one_details.0.remaining_lifetime_int' instead." }, "remainingLifetimeInt": { "type": "integer", "description": "The remaining lifetime before the key is refreshed.\n" }, "remainingLifetimeLastRetrieved": { "type": "string", "description": "The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "customAuthenticationAlgorithm", "customDhGroup", "customEncryptionAlgorithm", "isCustomPhaseOneConfig", "isIkeEstablished", "lifetime", "negotiatedAuthenticationAlgorithm", "negotiatedDhGroup", "negotiatedEncryptionAlgorithm", "remainingLifetime", "remainingLifetimeInt", "remainingLifetimeLastRetrieved" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelPhaseTwoDetail:getIpsecConnectionTunnelPhaseTwoDetail": { "properties": { "customAuthenticationAlgorithm": { "type": "string", "description": "Phase two authentication algorithm proposed during tunnel negotiation.\n" }, "customEncryptionAlgorithm": { "type": "string", "description": "The proposed custom phase two encryption algorithm.\n" }, "dhGroup": { "type": "string", "description": "The proposed Diffie-Hellman group.\n" }, "isCustomPhaseTwoConfig": { "type": "boolean", "description": "Indicates whether custom phase two configuration is enabled. If this option is not enabled, default settings are proposed.\n" }, "isEspEstablished": { "type": "boolean", "description": "Indicates that ESP phase two is established.\n" }, "isPfsEnabled": { "type": "boolean", "description": "Indicates that PFS (perfect forward secrecy) is enabled.\n" }, "lifetime": { "type": "integer", "description": "The total configured lifetime of the IKE security association.\n" }, "negotiatedAuthenticationAlgorithm": { "type": "string", "description": "The negotiated phase two authentication algorithm.\n" }, "negotiatedDhGroup": { "type": "string", "description": "The negotiated Diffie-Hellman group.\n" }, "negotiatedEncryptionAlgorithm": { "type": "string", "description": "The negotiated encryption algorithm.\n" }, "remainingLifetime": { "type": "string", "deprecationMessage": "The 'phase_two_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_two_details.0.remaining_lifetime_int' instead." }, "remainingLifetimeInt": { "type": "integer", "description": "The remaining lifetime before the key is refreshed.\n" }, "remainingLifetimeLastRetrieved": { "type": "string", "description": "The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "customAuthenticationAlgorithm", "customEncryptionAlgorithm", "dhGroup", "isCustomPhaseTwoConfig", "isEspEstablished", "isPfsEnabled", "lifetime", "negotiatedAuthenticationAlgorithm", "negotiatedDhGroup", "negotiatedEncryptionAlgorithm", "remainingLifetime", "remainingLifetimeInt", "remainingLifetimeLastRetrieved" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelRoutesFilter:getIpsecConnectionTunnelRoutesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpsecConnectionTunnelRoutesTunnelRoute:getIpsecConnectionTunnelRoutesTunnelRoute": { "properties": { "advertiser": { "type": "string", "description": "Specifies the advertiser of the routes. If set to `ORACLE`, this returns only the routes advertised by Oracle. When set to `CUSTOMER`, this returns only the routes advertised by the CPE.\n" }, "age": { "type": "string", "description": "The age of the route.\n" }, "asPaths": { "type": "array", "items": { "type": "integer" }, "description": "A list of ASNs in AS_Path.\n" }, "isBestPath": { "type": "boolean", "description": "Indicates this is the best route.\n" }, "prefix": { "type": "string", "description": "The BGP network layer reachability information.\n" } }, "type": "object", "required": [ "advertiser", "age", "asPaths", "isBestPath", "prefix" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelsFilter:getIpsecConnectionTunnelsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnel:getIpsecConnectionTunnelsIpSecConnectionTunnel": { "properties": { "associatedVirtualCircuits": { "type": "array", "items": { "type": "string" }, "description": "The list of virtual circuit [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel.\n" }, "bgpSessionInfos": { "type": "array", "items": { "$ref": "#/types/oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelBgpSessionInfo:getIpsecConnectionTunnelsIpSecConnectionTunnelBgpSessionInfo" }, "description": "Information for establishing a BGP session for the IPSec tunnel.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the tunnel.\n" }, "cpeIp": { "type": "string", "description": "The IP address of the CPE device's VPN headend. Example: `203.0.113.22`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "dpdConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelDpdConfig:getIpsecConnectionTunnelsIpSecConnectionTunnelDpdConfig" } }, "dpdMode": { "type": "string", "description": "Dead peer detection (DPD) mode set on the Oracle side of the connection. This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, or both respond to and initiate requests.\n" }, "dpdTimeoutInSec": { "type": "integer", "description": "DPD timeout in seconds.\n" }, "encryptionDomainConfigs": { "type": "array", "items": { "$ref": "#/types/oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelEncryptionDomainConfig:getIpsecConnectionTunnelsIpSecConnectionTunnelEncryptionDomainConfig" }, "description": "Configuration information used by the encryption domain policy.\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the tunnel.\n" }, "ikeVersion": { "type": "string", "description": "Internet Key Exchange protocol version.\n" }, "ipsecId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection.\n" }, "natTranslationEnabled": { "type": "string", "description": "By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T.\n" }, "oracleCanInitiate": { "type": "string", "description": "Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests.\n" }, "phaseOneDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseOneDetail:getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseOneDetail" }, "description": "IPSec tunnel details specific to ISAKMP phase one.\n" }, "phaseTwoDetails": { "type": "array", "items": { "$ref": "#/types/oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseTwoDetail:getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseTwoDetail" }, "description": "IPsec tunnel detail information specific to phase two.\n" }, "routing": { "type": "string", "description": "The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing).\n" }, "sharedSecret": { "type": "string", "secret": true }, "state": { "type": "string", "description": "The tunnel's lifecycle state.\n" }, "status": { "type": "string", "description": "The status of the tunnel based on IPSec protocol characteristics.\n" }, "timeCreated": { "type": "string", "description": "The date and time the IPSec tunnel was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeStatusUpdated": { "type": "string", "description": "When the status of the IPSec tunnel last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "tunnelId": { "type": "string" }, "vpnIp": { "type": "string", "description": "The IP address of the Oracle VPN headend for the connection. Example: `203.0.113.21`\n" } }, "type": "object", "required": [ "associatedVirtualCircuits", "bgpSessionInfos", "compartmentId", "cpeIp", "displayName", "dpdConfigs", "dpdMode", "dpdTimeoutInSec", "encryptionDomainConfigs", "id", "ikeVersion", "ipsecId", "natTranslationEnabled", "oracleCanInitiate", "phaseOneDetails", "phaseTwoDetails", "routing", "sharedSecret", "state", "status", "timeCreated", "timeStatusUpdated", "tunnelId", "vpnIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelBgpSessionInfo:getIpsecConnectionTunnelsIpSecConnectionTunnelBgpSessionInfo": { "properties": { "bgpIpv6State": { "type": "string", "description": "The state of the BGP IPv6 session.\n" }, "bgpIpv6state": { "type": "string", "deprecationMessage": "The 'bgp_session_info.0.bgp_ipv6state' field has been deprecated. Please use 'bgp_session_info.0.bgp_ipv6_state' instead." }, "bgpState": { "type": "string", "description": "The state of the BGP session.\n" }, "customerBgpAsn": { "type": "string", "description": "If the tunnel's \u003cspan pulumi-lang-nodejs=\"`routing`\" pulumi-lang-dotnet=\"`Routing`\" pulumi-lang-go=\"`routing`\" pulumi-lang-python=\"`routing`\" pulumi-lang-yaml=\"`routing`\" pulumi-lang-java=\"`routing`\" pulumi-lang-hcl=\"`routing`\"\u003e`routing`\u003c/span\u003e attribute is set to `BGP` (see [IPSecConnectionTunnel](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/IPSecConnectionTunnel/)), this ASN is required and used for the tunnel's BGP session. This is the ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses \"asplain\" format.\n" }, "customerInterfaceIp": { "type": "string", "description": "The IP address for the CPE end of the inside tunnel interface.\n" }, "customerInterfaceIpv6": { "type": "string", "description": "The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional.\n" }, "oracleBgpAsn": { "type": "string", "description": "The Oracle BGP ASN.\n" }, "oracleInterfaceIp": { "type": "string", "description": "The IP address for the Oracle end of the inside tunnel interface.\n" }, "oracleInterfaceIpv6": { "type": "string", "description": "The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional.\n" } }, "type": "object", "required": [ "bgpIpv6State", "bgpIpv6state", "bgpState", "customerBgpAsn", "customerInterfaceIp", "customerInterfaceIpv6", "oracleBgpAsn", "oracleInterfaceIp", "oracleInterfaceIpv6" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelDpdConfig:getIpsecConnectionTunnelsIpSecConnectionTunnelDpdConfig": { "properties": { "dpdMode": { "type": "string", "description": "Dead peer detection (DPD) mode set on the Oracle side of the connection. This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, or both respond to and initiate requests.\n" }, "dpdTimeoutInSec": { "type": "integer", "description": "DPD timeout in seconds.\n" } }, "type": "object", "required": [ "dpdMode", "dpdTimeoutInSec" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelEncryptionDomainConfig:getIpsecConnectionTunnelsIpSecConnectionTunnelEncryptionDomainConfig": { "properties": { "cpeTrafficSelectors": { "type": "array", "items": { "type": "string" }, "description": "Lists IPv4 or IPv6-enabled subnets in your on-premises network.\n" }, "oracleTrafficSelectors": { "type": "array", "items": { "type": "string" }, "description": "Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy.\n" } }, "type": "object", "required": [ "cpeTrafficSelectors", "oracleTrafficSelectors" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseOneDetail:getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseOneDetail": { "properties": { "customAuthenticationAlgorithm": { "type": "string", "description": "Phase two authentication algorithm proposed during tunnel negotiation.\n" }, "customDhGroup": { "type": "string", "description": "The proposed custom Diffie-Hellman group.\n" }, "customEncryptionAlgorithm": { "type": "string", "description": "The proposed custom phase two encryption algorithm.\n" }, "isCustomPhaseOneConfig": { "type": "boolean", "description": "Indicates whether custom phase one configuration is enabled. If this option is not enabled, default settings are proposed.\n" }, "isIkeEstablished": { "type": "boolean", "description": "Indicates whether IKE phase one is established.\n" }, "lifetime": { "type": "integer", "description": "The total configured lifetime of the IKE security association.\n" }, "negotiatedAuthenticationAlgorithm": { "type": "string", "description": "The negotiated phase two authentication algorithm.\n" }, "negotiatedDhGroup": { "type": "string", "description": "The negotiated Diffie-Hellman group.\n" }, "negotiatedEncryptionAlgorithm": { "type": "string", "description": "The negotiated encryption algorithm.\n" }, "remainingLifetime": { "type": "string", "deprecationMessage": "The 'phase_one_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_one_details.0.remaining_lifetime_int' instead." }, "remainingLifetimeInt": { "type": "integer", "description": "The remaining lifetime before the key is refreshed.\n" }, "remainingLifetimeLastRetrieved": { "type": "string", "description": "The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "customAuthenticationAlgorithm", "customDhGroup", "customEncryptionAlgorithm", "isCustomPhaseOneConfig", "isIkeEstablished", "lifetime", "negotiatedAuthenticationAlgorithm", "negotiatedDhGroup", "negotiatedEncryptionAlgorithm", "remainingLifetime", "remainingLifetimeInt", "remainingLifetimeLastRetrieved" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseTwoDetail:getIpsecConnectionTunnelsIpSecConnectionTunnelPhaseTwoDetail": { "properties": { "customAuthenticationAlgorithm": { "type": "string", "description": "Phase two authentication algorithm proposed during tunnel negotiation.\n" }, "customEncryptionAlgorithm": { "type": "string", "description": "The proposed custom phase two encryption algorithm.\n" }, "dhGroup": { "type": "string", "description": "The proposed Diffie-Hellman group.\n" }, "isCustomPhaseTwoConfig": { "type": "boolean", "description": "Indicates whether custom phase two configuration is enabled. If this option is not enabled, default settings are proposed.\n" }, "isEspEstablished": { "type": "boolean", "description": "Indicates that ESP phase two is established.\n" }, "isPfsEnabled": { "type": "boolean", "description": "Indicates that PFS (perfect forward secrecy) is enabled.\n" }, "lifetime": { "type": "integer", "description": "The total configured lifetime of the IKE security association.\n" }, "negotiatedAuthenticationAlgorithm": { "type": "string", "description": "The negotiated phase two authentication algorithm.\n" }, "negotiatedDhGroup": { "type": "string", "description": "The negotiated Diffie-Hellman group.\n" }, "negotiatedEncryptionAlgorithm": { "type": "string", "description": "The negotiated encryption algorithm.\n" }, "remainingLifetime": { "type": "string", "deprecationMessage": "The 'phase_two_details.0.remaining_lifetime' field has been deprecated. Please use 'phase_two_details.0.remaining_lifetime_int' instead." }, "remainingLifetimeInt": { "type": "integer", "description": "The remaining lifetime before the key is refreshed.\n" }, "remainingLifetimeLastRetrieved": { "type": "string", "description": "The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "customAuthenticationAlgorithm", "customEncryptionAlgorithm", "dhGroup", "isCustomPhaseTwoConfig", "isEspEstablished", "isPfsEnabled", "lifetime", "negotiatedAuthenticationAlgorithm", "negotiatedDhGroup", "negotiatedEncryptionAlgorithm", "remainingLifetime", "remainingLifetimeInt", "remainingLifetimeLastRetrieved" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionsConnection:getIpsecConnectionsConnection": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "cpeId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the CPE.\n" }, "cpeLocalIdentifier": { "type": "string", "description": "Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for `cpeLocalIdentifierType`.\n" }, "cpeLocalIdentifierType": { "type": "string", "description": "The type of identifier for your CPE device. The value here must correspond to the value for `cpeLocalIdentifier`.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "drgId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the DRG.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The IPSec connection's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "state": { "type": "string", "description": "The IPSec connection's current state.\n" }, "staticRoutes": { "type": "array", "items": { "type": "string" }, "description": "Static routes to the CPE. The CIDR must not be a multicast address or class E address.\n" }, "timeCreated": { "type": "string", "description": "The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "transportType": { "type": "string", "description": "The transport type used for the IPSec connection.\n" }, "tunnelConfigurations": { "type": "array", "items": { "$ref": "#/types/oci:Core/getIpsecConnectionsConnectionTunnelConfiguration:getIpsecConnectionsConnectionTunnelConfiguration" } } }, "type": "object", "required": [ "compartmentId", "cpeId", "cpeLocalIdentifier", "cpeLocalIdentifierType", "definedTags", "displayName", "drgId", "freeformTags", "id", "state", "staticRoutes", "timeCreated", "transportType", "tunnelConfigurations" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionsConnectionTunnelConfiguration:getIpsecConnectionsConnectionTunnelConfiguration": { "properties": { "associatedVirtualCircuits": { "type": "array", "items": { "type": "string" } }, "drgRouteTableId": { "type": "string" }, "oracleTunnelIp": { "type": "string" } }, "type": "object", "required": [ "associatedVirtualCircuits", "drgRouteTableId", "oracleTunnelIp" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpsecConnectionsFilter:getIpsecConnectionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpsecStatusFilter:getIpsecStatusFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpsecStatusTunnel:getIpsecStatusTunnel": { "properties": { "ipAddress": { "type": "string", "description": "The IP address of Oracle's VPN headend. Example: `203.0.113.50`\n" }, "state": { "type": "string", "description": "The tunnel's current state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "timeStateModified": { "type": "string", "description": "When the state of the tunnel last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "ipAddress", "state", "timeCreated", "timeStateModified" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getIpv6sFilter:getIpv6sFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getIpv6sIpv6:getIpv6sIpv6": { "properties": { "cidrPrefixLength": { "type": "integer" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6. This is the same as the VNIC's compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostname": { "type": "string" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the IPv6.\n" }, "ipAddress": { "type": "string", "description": "An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3`\n" }, "ipState": { "type": "string" }, "ipv6subnetCidr": { "type": "string" }, "lifetime": { "type": "string" }, "routeTableId": { "type": "string" }, "state": { "type": "string", "description": "The IPv6's current state.\n" }, "subnetId": { "type": "string", "description": "The OCID of the subnet.\n" }, "timeCreated": { "type": "string", "description": "The date and time the IPv6 was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vnicId": { "type": "string", "description": "The OCID of the VNIC.\n" } }, "type": "object", "required": [ "cidrPrefixLength", "compartmentId", "definedTags", "displayName", "freeformTags", "hostname", "id", "ipAddress", "ipState", "ipv6subnetCidr", "lifetime", "routeTableId", "state", "subnetId", "timeCreated", "vnicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getListingResourceVersionsAppCatalogListingResourceVersion:getListingResourceVersionsAppCatalogListingResourceVersion": { "properties": { "accessiblePorts": { "type": "array", "items": { "type": "integer" } }, "allowedActions": { "type": "array", "items": { "type": "string" } }, "availableRegions": { "type": "array", "items": { "type": "string" } }, "compatibleShapes": { "type": "array", "items": { "type": "string" } }, "listingId": { "type": "string" }, "listingResourceId": { "type": "string" }, "listingResourceVersion": { "type": "string" }, "timePublished": { "type": "string" } }, "type": "object", "required": [ "accessiblePorts", "allowedActions", "availableRegions", "compatibleShapes", "listingId", "listingResourceId", "listingResourceVersion", "timePublished" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getListingResourceVersionsFilter:getListingResourceVersionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getLocalPeeringGatewaysFilter:getLocalPeeringGatewaysFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getLocalPeeringGatewaysLocalPeeringGateway:getLocalPeeringGatewaysLocalPeeringGateway": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The LPG's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "isCrossTenancyPeering": { "type": "boolean", "description": "Whether the VCN at the other end of the peering is in a different tenancy. Example: \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e\n" }, "peerAdvertisedCidr": { "type": "string", "description": "The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See `peerAdvertisedCidrDetails` for the individual CIDRs. The value is \u003cspan pulumi-lang-nodejs=\"`null`\" pulumi-lang-dotnet=\"`Null`\" pulumi-lang-go=\"`null`\" pulumi-lang-python=\"`null`\" pulumi-lang-yaml=\"`null`\" pulumi-lang-java=\"`null`\" pulumi-lang-hcl=\"`null`\"\u003e`null`\u003c/span\u003e if the LPG is not peered. Example: `192.168.0.0/16`, or if aggregated with `172.16.0.0/24` then `128.0.0.0/1`\n" }, "peerAdvertisedCidrDetails": { "type": "array", "items": { "type": "string" }, "description": "The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is \u003cspan pulumi-lang-nodejs=\"`null`\" pulumi-lang-dotnet=\"`Null`\" pulumi-lang-go=\"`null`\" pulumi-lang-python=\"`null`\" pulumi-lang-yaml=\"`null`\" pulumi-lang-java=\"`null`\" pulumi-lang-hcl=\"`null`\"\u003e`null`\u003c/span\u003e if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet's traffic to this LPG. Example: [`192.168.0.0/16`, `172.16.0.0/24`]\n" }, "peerId": { "type": "string", "description": "The OCID of the peered LPG\n" }, "peeringStatus": { "type": "string", "description": "Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been peered. `PENDING` means the peering is being established. `REVOKED` means the LPG at the other end of the peering has been deleted.\n" }, "peeringStatusDetails": { "type": "string", "description": "Additional information regarding the peering status, if applicable.\n" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG is using.\n" }, "state": { "type": "string", "description": "The LPG's current lifecycle state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the LPG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "isCrossTenancyPeering", "peerAdvertisedCidr", "peerAdvertisedCidrDetails", "peerId", "peeringStatus", "peeringStatusDetails", "routeTableId", "state", "timeCreated", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNatGatewaysFilter:getNatGatewaysFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getNatGatewaysNatGateway:getNatGatewaysNatGateway": { "properties": { "blockTraffic": { "type": "boolean", "description": "Whether the NAT gateway blocks traffic through it. The default is \u003cspan pulumi-lang-nodejs=\"`false`\" pulumi-lang-dotnet=\"`False`\" pulumi-lang-go=\"`false`\" pulumi-lang-python=\"`false`\" pulumi-lang-yaml=\"`false`\" pulumi-lang-java=\"`false`\" pulumi-lang-hcl=\"`false`\"\u003e`false`\u003c/span\u003e. Example: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the NAT gateway.\n" }, "natIp": { "type": "string", "description": "The IP address associated with the NAT gateway.\n" }, "publicIpId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway.\n" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the NAT gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.\n" } }, "type": "object", "required": [ "blockTraffic", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "natIp", "publicIpId", "routeTableId", "state", "timeCreated", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesFilter:getNetworkSecurityGroupSecurityRulesFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRule:getNetworkSecurityGroupSecurityRulesSecurityRule": { "properties": { "description": { "type": "string", "description": "An optional description of your choice for the rule.\n" }, "destination": { "type": "string", "description": "Conceptually, this is the range of IP addresses that a packet originating from the instance can go to.\n" }, "destinationType": { "type": "string", "description": "Type of destination for the rule. Required if \u003cspan pulumi-lang-nodejs=\"`direction`\" pulumi-lang-dotnet=\"`Direction`\" pulumi-lang-go=\"`direction`\" pulumi-lang-python=\"`direction`\" pulumi-lang-yaml=\"`direction`\" pulumi-lang-java=\"`direction`\" pulumi-lang-hcl=\"`direction`\"\u003e`direction`\u003c/span\u003e = `EGRESS`.\n" }, "direction": { "type": "string", "description": "Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets, or `INGRESS` for rules that allow inbound IP packets.\n" }, "icmpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleIcmpOption:getNetworkSecurityGroupSecurityRulesSecurityRuleIcmpOption" }, "description": "Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in:\n* [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml)\n* [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml)\n" }, "id": { "type": "string", "description": "An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule. Example: `04ABEC`\n" }, "isValid": { "type": "boolean", "description": "Whether the rule is valid. The value is `True` when the rule is first created. If the rule's \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e or \u003cspan pulumi-lang-nodejs=\"`destination`\" pulumi-lang-dotnet=\"`Destination`\" pulumi-lang-go=\"`destination`\" pulumi-lang-python=\"`destination`\" pulumi-lang-yaml=\"`destination`\" pulumi-lang-java=\"`destination`\" pulumi-lang-hcl=\"`destination`\"\u003e`destination`\u003c/span\u003e is a network security group, the value changes to `False` if that network security group is deleted.\n" }, "protocol": { "type": "string", "description": "The transport protocol. Specify either \u003cspan pulumi-lang-nodejs=\"`all`\" pulumi-lang-dotnet=\"`All`\" pulumi-lang-go=\"`all`\" pulumi-lang-python=\"`all`\" pulumi-lang-yaml=\"`all`\" pulumi-lang-java=\"`all`\" pulumi-lang-hcl=\"`all`\"\u003e`all`\u003c/span\u003e or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP (\"1\"), TCP (\"6\"), UDP (\"17\"), and ICMPv6 (\"58\").\n" }, "source": { "type": "string", "description": "Conceptually, this is the range of IP addresses that a packet coming into the instance can come from.\n" }, "sourceType": { "type": "string", "description": "Type of source for the rule. Required if \u003cspan pulumi-lang-nodejs=\"`direction`\" pulumi-lang-dotnet=\"`Direction`\" pulumi-lang-go=\"`direction`\" pulumi-lang-python=\"`direction`\" pulumi-lang-yaml=\"`direction`\" pulumi-lang-java=\"`direction`\" pulumi-lang-hcl=\"`direction`\"\u003e`direction`\u003c/span\u003e = `INGRESS`.\n* `CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is an IP address range in CIDR notation.\n* `SERVICE_CIDR_BLOCK`: If the rule's \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is the `cidrBlock` value for a [Service](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/Service/) (the rule is for traffic coming from a particular `Service` through a service gateway).\n* `NETWORK_SECURITY_GROUP`: If the rule's \u003cspan pulumi-lang-nodejs=\"`source`\" pulumi-lang-dotnet=\"`Source`\" pulumi-lang-go=\"`source`\" pulumi-lang-python=\"`source`\" pulumi-lang-yaml=\"`source`\" pulumi-lang-java=\"`source`\" pulumi-lang-hcl=\"`source`\"\u003e`source`\u003c/span\u003e is the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NetworkSecurityGroup/).\n" }, "stateless": { "type": "boolean", "description": "A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic.\n" }, "tcpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOption:getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOption" }, "description": "Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed.\n" }, "timeCreated": { "type": "string", "description": "The date and time the security rule was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339).\n" }, "udpOptions": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOption:getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOption" }, "description": "Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed.\n" } }, "type": "object", "required": [ "description", "destination", "destinationType", "direction", "icmpOptions", "id", "isValid", "protocol", "source", "sourceType", "stateless", "tcpOptions", "timeCreated", "udpOptions" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleIcmpOption:getNetworkSecurityGroupSecurityRulesSecurityRuleIcmpOption": { "properties": { "code": { "type": "integer", "description": "The ICMP code (optional).\n" }, "type": { "type": "integer", "description": "The ICMP type.\n" } }, "type": "object", "required": [ "code", "type" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOption:getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionDestinationPortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionSourcePortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionDestinationPortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionSourcePortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleTcpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOption:getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOption": { "properties": { "destinationPortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionDestinationPortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionDestinationPortRange" } }, "sourcePortRanges": { "type": "array", "items": { "$ref": "#/types/oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionSourcePortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionSourcePortRange" } } }, "type": "object", "required": [ "destinationPortRanges", "sourcePortRanges" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionDestinationPortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionDestinationPortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionSourcePortRange:getNetworkSecurityGroupSecurityRulesSecurityRuleUdpOptionSourcePortRange": { "properties": { "max": { "type": "integer", "description": "The maximum port number. Must not be lower than the minimum port number. To specify a single port number, set both the min and max to the same value.\n" }, "min": { "type": "integer", "description": "The minimum port number. Must not be greater than the maximum port number.\n" } }, "type": "object", "required": [ "max", "min" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupVnicsFilter:getNetworkSecurityGroupVnicsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getNetworkSecurityGroupVnicsNetworkSecurityGroupVnic:getNetworkSecurityGroupVnicsNetworkSecurityGroupVnic": { "properties": { "resourceId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the parent resource that the VNIC is attached to (for example, a Compute instance).\n" }, "timeAssociated": { "type": "string", "description": "The date and time the VNIC was added to the network security group, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vnicId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC.\n" } }, "type": "object", "required": [ "resourceId", "timeAssociated", "vnicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getNetworkSecurityGroupsFilter:getNetworkSecurityGroupsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getNetworkSecurityGroupsNetworkSecurityGroup:getNetworkSecurityGroupsNetworkSecurityGroup": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the network security group.\n" }, "state": { "type": "string", "description": "A filter to return only resources that match the specified lifecycle state. The value is case insensitive.\n" }, "timeCreated": { "type": "string", "description": "The date and time the network security group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vcnId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VCN.\n" } }, "type": "object", "required": [ "compartmentId", "definedTags", "displayName", "freeformTags", "id", "state", "timeCreated", "vcnId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getPeerRegionForRemotePeeringsFilter:getPeerRegionForRemotePeeringsFilter": { "properties": { "name": { "type": "string", "description": "The region's name. Example: `us-phoenix-1`\n" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getPeerRegionForRemotePeeringsPeerRegionForRemotePeering:getPeerRegionForRemotePeeringsPeerRegionForRemotePeering": { "properties": { "name": { "type": "string", "description": "The region's name. Example: `us-phoenix-1`\n" } }, "type": "object", "required": [ "name" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getPrivateIpsFilter:getPrivateIpsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getPrivateIpsPrivateIp:getPrivateIpsPrivateIp": { "properties": { "availabilityDomain": { "type": "string", "description": "The private IP's availability domain. This attribute will be null if this is a *secondary* private IP assigned to a VNIC that is in a *regional* subnet. Example: `Uocm:PHX-AD-1`\n" }, "cidrPrefixLength": { "type": "integer", "description": "The secondary IPv4 CIDR prefix length.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the private IP.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "hostnameLabel": { "type": "string", "description": "The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP's fully qualified domain name (FQDN) (for example, \u003cspan pulumi-lang-nodejs=\"`bminstance1`\" pulumi-lang-dotnet=\"`Bminstance1`\" pulumi-lang-go=\"`bminstance1`\" pulumi-lang-python=\"`bminstance1`\" pulumi-lang-yaml=\"`bminstance1`\" pulumi-lang-java=\"`bminstance1`\" pulumi-lang-hcl=\"`bminstance1`\"\u003e`bminstance1`\u003c/span\u003e in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123).\n" }, "id": { "type": "string", "description": "The private IP's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "ipAddress": { "type": "string", "description": "An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3`\n" }, "ipState": { "type": "string", "description": "State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE\n" }, "ipv4subnetCidrAtCreation": { "type": "string", "description": "Ipv4 Subnet CIDR specified whn creating the PrivateIP.\n" }, "isPrimary": { "type": "boolean", "description": "Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: \u003cspan pulumi-lang-nodejs=\"`true`\" pulumi-lang-dotnet=\"`True`\" pulumi-lang-go=\"`true`\" pulumi-lang-python=\"`true`\" pulumi-lang-yaml=\"`true`\" pulumi-lang-java=\"`true`\" pulumi-lang-hcl=\"`true`\"\u003e`true`\u003c/span\u003e\n" }, "isReserved": { "type": "boolean" }, "lifetime": { "type": "string", "description": "Lifetime of the IP address. There are two types of IPs:\n* Ephemeral\n* Reserved\n" }, "routeTableId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Source Based Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing).\n" }, "subnetId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subnet.\n" }, "timeCreated": { "type": "string", "description": "The date and time the private IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" }, "vlanId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VLAN.\n" }, "vnicId": { "type": "string", "description": "The OCID of the VNIC.\n" } }, "type": "object", "required": [ "availabilityDomain", "cidrPrefixLength", "compartmentId", "definedTags", "displayName", "freeformTags", "hostnameLabel", "id", "ipAddress", "ipState", "ipv4subnetCidrAtCreation", "isPrimary", "isReserved", "lifetime", "routeTableId", "subnetId", "timeCreated", "vlanId", "vnicId" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getPublicIpPoolsFilter:getPublicIpPoolsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getPublicIpPoolsPublicIpPoolCollection:getPublicIpPoolsPublicIpPoolCollection": { "properties": { "items": { "type": "array", "items": { "$ref": "#/types/oci:Core/getPublicIpPoolsPublicIpPoolCollectionItem:getPublicIpPoolsPublicIpPoolCollectionItem" } } }, "type": "object", "required": [ "items" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getPublicIpPoolsPublicIpPoolCollectionItem:getPublicIpPoolsPublicIpPoolCollectionItem": { "properties": { "cidrBlocks": { "type": "array", "items": { "type": "string" }, "description": "The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A filter to return only resources that match the given display name exactly.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool.\n" }, "state": { "type": "string", "description": "The public IP pool's current state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the public IP pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "cidrBlocks", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getPublicIpsFilter:getPublicIpsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getPublicIpsPublicIp:getPublicIpsPublicIp": { "properties": { "assignedEntityId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the entity the public IP is assigned to, or in the process of being assigned to.\n" }, "assignedEntityType": { "type": "string", "description": "The type of entity the public IP is assigned to, or in the process of being assigned to.\n" }, "availabilityDomain": { "type": "string", "description": "The name of the availability domain. Example: `Uocm:PHX-AD-1`\n" }, "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Operations.CostCenter\": \"42\"}`\n" }, "displayName": { "type": "string", "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n" }, "freeformTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{\"Department\": \"Finance\"}`\n" }, "id": { "type": "string", "description": "The public IP's Oracle ID ([OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).\n" }, "ipAddress": { "type": "string", "description": "The public IP address of the `publicIp` object. Example: `203.0.113.2`\n" }, "lifetime": { "type": "string", "description": "A filter to return only public IPs that match given lifetime.\n" }, "privateIpId": { "type": "string", "description": "Deprecated. Use `assignedEntityId` instead.\n" }, "publicIpPoolId": { "type": "string", "description": "A filter to return only resources that belong to the given public IP pool.\n" }, "scope": { "type": "string", "description": "Whether the public IP is regional or specific to a particular availability domain.\n* `REGION`: The public IP exists within a region and is assigned to a regional entity (such as a [NatGateway](https://docs.cloud.oracle.com/iaas/api/#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have \u003cspan pulumi-lang-nodejs=\"`scope`\" pulumi-lang-dotnet=\"`Scope`\" pulumi-lang-go=\"`scope`\" pulumi-lang-python=\"`scope`\" pulumi-lang-yaml=\"`scope`\" pulumi-lang-java=\"`scope`\" pulumi-lang-hcl=\"`scope`\"\u003e`scope`\u003c/span\u003e = `REGION`, as do ephemeral public IPs assigned to a regional entity.\n* `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity it's assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs that are assigned to private IPs have \u003cspan pulumi-lang-nodejs=\"`scope`\" pulumi-lang-dotnet=\"`Scope`\" pulumi-lang-go=\"`scope`\" pulumi-lang-python=\"`scope`\" pulumi-lang-yaml=\"`scope`\" pulumi-lang-java=\"`scope`\" pulumi-lang-hcl=\"`scope`\"\u003e`scope`\u003c/span\u003e = `AVAILABILITY_DOMAIN`.\n" }, "state": { "type": "string", "description": "The public IP's current state.\n" }, "timeCreated": { "type": "string", "description": "The date and time the public IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`\n" } }, "type": "object", "required": [ "assignedEntityId", "assignedEntityType", "availabilityDomain", "compartmentId", "definedTags", "displayName", "freeformTags", "id", "ipAddress", "lifetime", "privateIpId", "publicIpPoolId", "scope", "state", "timeCreated" ], "language": { "nodejs": { "requiredInputs": [] } } }, "oci:Core/getRemotePeeringConnectionsFilter:getRemotePeeringConnectionsFilter": { "properties": { "name": { "type": "string" }, "regex": { "type": "boolean" }, "values": { "type": "array", "items": { "type": "string" } } }, "type": "object", "required": [ "name", "values" ] }, "oci:Core/getRemotePeeringConnectionsRemotePeeringConnection:getRemotePeeringConnectionsRemotePeeringConnection": { "properties": { "compartmentId": { "type": "string", "description": "The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n" }, "definedTags": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Defined tags for this resource. Each